作成¶
POST /api/v1/dashboard/carousel/add
概要¶
入力順にダッシュボードカルーセル設定を 1 つ作成します。
呼び出し前の確認と使用手順¶
まずダッシュボードリストで必要なダッシュボード UUID を確認します。3 つの Body フィールドはすべて入力必須です。サーバーは 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 例: 本番巡視カルーセル取得方法または入力方法: 現在の呼び出しアイデンティティがこのワークスペースでまだ使用していないカルーセル名を入力します。 |
| intervalTime | string | Y | 再生間隔の文字列。作成時と変更時の両方で指定が必要です。 null 許可: False 例: 30s取得方法または入力方法: 希望する再生間隔を、フロントエンドが認識できる文字列で入力します。例えば 30s です。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/dashboard/carousel/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"dashboardUUIDs":["dsbd_example"],"name":"本番巡視カルーセル","intervalTime":"30s"}'
レスポンス¶
HTTP 200、application/json。以下の例は、そのまま読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | カルーセルレコードの内部番号。 |
| content.uuid | string | カルーセル設定の UUID。詳細表示、変更、削除に使用します。 |
| content.accountUUID | string | カルーセルが属する呼び出しアイデンティティの 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": "30s",
"dashboardUUIDs": [
"dsbd_example"
],
"status": 0,
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"creator": "wsak_example",
"updator": "",
"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 配列、および空白でない間隔文字列を使用してください。 |
| 400 | ft.DashboardCarouselNameRepeat | 現在のアイデンティティに同名のカルーセルが既に存在する、または同名の設定が作成中もしくは変更中である | このカルーセル名は既に存在します | 既存の設定を確認してください。同名の設定が既にある場合は名前を変更するかその設定を直接操作し、同名操作が同時に実行されている場合は前回の完了を待ってから再試行してください。 |