コンテンツにスキップ

削除



POST /api/v1/dashboards/{dashboard_uuid}/delete

概要

指定したダッシュボードとその関連コンテンツを削除します。

呼び出し前の確認と使用手順

まずダッシュボード一覧またはダッシュボード詳細で UUID を確認してください。コンテンツを保持する必要がある場合は、事前にテンプレートをエクスポートしてください。削除すると、グラフ、変数、メニューなどの関連付けがクリアされ、アーカイブされたレポートにも影響します。タイムアウトした場合は、まずダッシュボードがまだ存在するかを確認してから、次の操作を決定してください。

パスパラメーター

パラメーター名 型 必須 説明
dashboard_uuid string Y 対象ダッシュボードの UUID。
例: dsbd_example
取得または入力方法: ダッシュボード一覧 の content.data[].uuid からコピーするか、作成結果の content.uuid を使用します。

リクエストヘッダー

パラメーター名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

パラメーター補足説明

対象 UUID は現在のワークスペース一覧から取得します。削除する前に、このダッシュボードを参照しているアプリケーションとレポートを確認してください。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/dashboards/dsbd_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.NotFoundView 対象のダッシュボードが存在しない、削除済み、または現在のワークスペースにない 指定されたビューが見つかりません 現在のワークスペースのダッシュボード一覧で返された UUID に切り替えてください。
403 ft.ForbiddenDashboardOperation 呼び出し元の識別情報では対象ダッシュボードを操作できない ダッシュボード【{}】を操作する権限がありません ダッシュボードの可視範囲、操作権限、および使用している API Key を確認してください。

フィードバック

このページは役に立ちましたか?