コンテンツにスキップ

削除¶

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

概要¶

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

ルートパラメータ¶

パラメータ名	タイプ	必須	説明
note_uuid	string	Y	Studio 新版ノートの UUID

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

パラメータ名	タイプ	必須	説明
ifMatch	string		オプションの ETag。指定時は NbookDB の If-Match に転送されます。空を許可: False

パラメータ補足説明¶

URL の note_uuid を使用してノートを削除します。リクエストボディにはオプションで ifMatch を指定できます。

詳細または前回の保存で返された etag を ifMatch として指定することを推奨します。
削除が成功すると、そのノートはリストに表示されなくなります。
プライベートノートは作成者のみ削除できます。パブリックノートは、現在の API Key に書き込み権限が必要です。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/notes_v2/nbnote_xxx/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"ifMatch":"etag_xxx"}'

レスポンス¶

{
    "code": 200,
    "content": {
        "noteUUID": "nbnote_xxx",
        "noteName": "A"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}