変更¶
POST /api/v1/dashboard/carousel/{carousel_uuid}/modify
概要¶
既存のカルーセルの名前、ダッシュボードリスト、再生間隔を上書きします。
呼び出し前の準備と使用手順¶
まずカルーセル詳細から元の設定を読み取ります。送信時には 3 つのフィールドをすべて指定し、元の値を維持するフィールドも入力する必要があります。この API は dashboardUUIDs で元のリストを置き換え、再生順序は新しい配列の順序で決まります。更新後は再度読み取ることができます。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| carousel_uuid | string | Y | カルーセル設定の UUID。 例: csel_example取得または入力方法: 同じワークスペースおよび呼び出し ID のもとで、カルーセルリストの content[].uuid からコピーするか、作成レスポンスの content.uuid を使用します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| dashboardUUIDs | array | Y | 空でないダッシュボード UUID の配列。作成および変更時に渡した順序が保存され、読み取り時に削除済みまたは現在のワークスペースに存在しない参照はクリアされます。 null を許可: False 例: ["dsbd_example"]取得または入力方法: ダッシュボードリストのレスポンス content.data[].uuid から値を取得し、希望するカルーセル順序で入力します。 |
| name | string | Y | 新しいカルーセル名。最大 256 文字。 null を許可: False 最大長: 256 例: 生产巡检轮播取得または入力方法: 元の名前を維持できます。名前を変更する場合は、現在の呼び出し ID がこのワークスペースで使用していない名前を選択します。 |
| intervalTime | string | Y | 再生間隔の文字列。作成および変更のいずれでも指定が必要です。 null を許可: False 例: 30s取得または入力方法: 希望する再生間隔に応じて、フロントエンドが認識できる文字列 (例: 30s) を入力します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/dashboard/carousel/csel_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"dashboardUUIDs":["dsbd_example"],"name":"生产巡检轮播","intervalTime":"60s"}'
レスポンス¶
HTTP 200、application/json。以下の例は、そのまま読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | カルーセルレコードの内部番号。 |
| content.uuid | string | カルーセル設定の UUID。詳細、変更、削除に使用します。 |
| content.accountUUID | string | カルーセルが属する呼び出し ID の ID。 |
| content.workspaceUUID | string | カルーセルが属するワークスペースの UUID。 |
| content.name | string | カルーセル名。 |
| content.intervalTime | string | 保存済みのカルーセル間隔の文字列。 |
| content.dashboardUUIDs | array<string> |
保存されたダッシュボード UUID。カルーセルの順序に並んでいます。 |
| content.status | integer | レコードのステータス。 |
| content.createAt | number | 作成日時 (Unix 秒)。 |
| content.updateAt | number | 最終更新日時 (Unix 秒)。更新がない場合は -1。 |
| content.deleteAt | number | 削除日時 (Unix 秒)。未削除の場合は -1。 |
| content.creator | string | 作成者の ID。 |
| content.updator | string | 最終更新者の ID。更新がない場合は空文字列。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": 10,
"uuid": "csel_example",
"accountUUID": "wsak_example",
"workspaceUUID": "wksp_example",
"name": "生产巡检轮播",
"intervalTime": "60s",
"dashboardUUIDs": [
"dsbd_example"
],
"status": 0,
"createAt": 1785427200,
"updateAt": 1785427320,
"deleteAt": -1,
"creator": "wsak_example",
"updator": "wsak_example",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドが欠落しているか、フィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正します。 |
| 406 | ft.MissingParameters | カルーセル名、ダッシュボードリスト、または間隔が空 | パラメータが不足しています | 空でない名前、空でない UUID 配列、空でない間隔文字列を使用します。 |
| 404 | ft.DashboardCarouselObjectNotExist | 設定が削除済み、存在しない、または現在の呼び出し ID とワークスペースに属していない | 該当するカルーセルオブジェクトが存在しません | 同じ Key でカルーセルリストから設定が存在することを確認し、実際の UUID を使用します。 |
| 400 | ft.DashboardCarouselNameRepeat | 現在の呼び出し ID に同じ名前のカルーセルが既に存在するか、同名設定の同時書き込みが発生している | 該当するカルーセル名は既に存在します | 既存の設定を確認します。同名の設定が既にある場合は名前を変更するかその設定を直接操作し、同名操作が同時に発生している場合は前の処理が完了してから再試行します。 |