削除¶
GET /api/v1/notes/{notes_uuid}/delete
概要¶
既存の GET ルートを使用して、指定したレガシーノートを削除します。
呼び出し前の確認と使用手順¶
まずノート詳細で削除対象のノートを確認し、必要に応じてノートのエクスポートでテンプレートを保存します。削除により、ノートの順序リストが参照するチャートもソフト削除されます。呼び出し元の識別情報にはシーン管理権限が必要です。またはノートの作成者である必要があります。この URL は状態を書き換えるため、削除を確定した後にクライアントから明示的に呼び出してください。プレビューやポーリングには使用しないでください。
ルートパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| notes_uuid | string | Y | 対象となるレガシーノートの UUID。 例: note_example取得または入力方法: ノート一覧の content.data[].uuid から取得します。作成レスポンスの content.uuid を使用することもできます。 |
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメーターの補足説明¶
これは後方互換性のための GET 削除エンドポイントです。タイムアウトした場合は、まずノートが一覧に残っているかを確認してから次の処理に進んでください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/notes/note_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、そのまま読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.noteName | string | 削除されたノートの名前。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"noteName": "生产巡检笔记",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストのエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.NotFoundNote | UUID が削除済み、存在しない、または現在の API Key のワークスペースに属していない | 指定されたノートが見つかりません | 同じワークスペースのノート一覧で UUID を確認してください。 |
| 403 | ft.Forbidden | 呼び出し元の識別情報にシーン管理権限がなく、ノートの作成者でもない | 操作する権限がありません | ノート作成時の Key、またはシーン管理権限を持つ呼び出し元の識別情報に変更してください。 |