削除¶
POST /api/v1/dashboard/carousel/{carousel_uuid}/delete
概要¶
現在の呼び出し元識別子が所有するカルーセル設定を 1 件削除します。
呼び出し前の確認と使用手順¶
対象のカルーセルと UUID をカルーセル一覧で確認してから POST を送信します。この操作ではカルーセル設定を削除しますが、設定が参照するダッシュボードは引き続き使用できます。リクエストがタイムアウトした場合は、先に一覧で設定の状態を確認してください。
ルートパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| carousel_uuid | string | Y | カルーセル設定の UUID。 例: csel_example取得または入力方法: 同じワークスペースおよび呼び出し元識別子の下で、カルーセル一覧の content[].uuid からコピーするか、作成レスポンスの content.uuid を使用します。 |
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/dashboard/carousel/csel_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 削除に成功した場合は true。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.DashboardCarouselObjectNotExist | 設定が削除済み、存在しない、または現在の呼び出し元識別子およびワークスペースに属していない | このカルーセルオブジェクトは存在しません | 同じ Key を使用してカルーセル一覧で設定がまだ存在することを確認し、実際の UUID を使用してください。 |