コンテンツにスキップ

削除



POST /api/v1/notes_v2/{note_uuid}/delete

概要

指定した新版ノートを削除します。

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

新版ノート詳細で対象の UUID を確認し、必要に応じて本文のバックアップを先に保存してください。読み取った etag を ifMatch として指定することを推奨します。この呼び出しはノート本文を削除し、レコードを削除済みとしてマークし、お気に入りをクリーンアップします。プライベートノートは作成したアイデンティティによって削除されます。関連付けられたアクティビティステータスページがある場合は、ステータスページの設定権限も必要です。リクエストがタイムアウトした場合は、まず詳細または一覧で確認してください。

ルートパラメーター

パラメーター名 型 必須 説明
note_uuid string Y 新版ノートの UUID。
例: nbnote_example
取得または入力方法: 新版ノート一覧の content.data[].noteUUID、または作成結果の content.noteUUID からコピーします。

リクエストヘッダー

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

Body リクエストパラメーター

パラメーター名 型 必須 説明
ifMatch string オプションのバージョン検証。更新または削除の前にこのバージョンと比較し、省略した場合は条件を付加しません。
null を許可: False
例: etag-example-1
取得または入力方法: 新版ノート詳細の content.etag から取得し、そのまま渡します。

パラメーター補足説明

同じ UUID を重複して削除した場合、削除済みのレコードは存在しないものとして扱われます。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/notes_v2/nbnote_example/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ifMatch":"etag-example-1"}'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示しています。

フィールド 型 説明
content.noteUUID string 削除されたノートの UUID。
content.noteName string このノートの削除前の名前。
content.declaration object または null ワークスペースのパブリック宣言。
{
  "code": 200,
  "content": {
    "noteUUID": "nbnote_example",
    "noteName": "本番環境インスペクション手順",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。

HTTP 424 を読み取った場合、content.upstreamStatus はダウンストリームが返したステータスです。接続異常時は 0 になることがあります。content.upstreamPath はその失敗したリクエストのパス、content.responseBody はダウンストリームのエラー内容です。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している パラメーターの解析に失敗 パラメーターの位置、フィールド名、型、値を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正してください。
400 ft.JsonFormatError JSON 構文は有効だが、リクエストのトップレベルがオブジェクトではない 一部の json ファイルの形式エラー パラメーターを JSON オブジェクト内に配置してください。
404 ft.NotFoundNote アクティビティノートが存在しない、現在のワークスペースに属していない、または削除済みである 指定されたノートが見つからない 現在のワークスペース、対象の noteUUID、および操作が成功したかどうかを確認してください。
403 ft.ForbiddenOperationResource 呼び出し元のアイデンティティが他者のプライベートノートを変更または削除しようとした、または対象がアクティビティステータスページに関連付けられていて statusPage.configManage が欠落している 操作権限がありません 対象の可視範囲とステータスページの関連付けを確認し、必要な権限を持つ呼び出しアイデンティティに切り替えてください。
424 ft.NbookDBApiError ノートサービスが書き込みまたは削除を拒否した、バージョン条件が一致しない、またはリクエストが失敗した ノートサービスの呼び出しに失敗 まず content.upstreamStatus を確認してください。バージョン競合の場合は、新版ノート詳細で本文と ETag を再読み取りし、マージ後に新しい ifMatch で再送信してください。リクエストがタイムアウトした場合は、まず対象の状態を確認してください。

フィードバック

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