コンテンツにスキップ

変更¶

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

概要¶

新しいバージョンのノートを変更します。

ルートパラメータ¶

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

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

パラメータ名	タイプ	必須	説明
title	string		ノートのタイトル空を許可: False
content	string		Markdown 本文空を許可: False
tags	array		タグのリスト空を許可: False
tagKV	json		キー値タグ空を許可: False
isPublic	int		公開設定（1: 公開、0: プライベート）空を許可: False
ifMatch	string		オプションの ETag。指定時は NbookDB に If-Match として転送空を許可: False
extend	json		Studio 業務拡張フィールド空を許可: False

パラメータ補足説明¶

URL の note_uuid を使用してノートを変更します。リクエストボディには title、content、tags、tagKV、isPublic、extend のうち 1 つ以上のフィールドを指定できます。

詳細情報または前回の保存時に返された etag を ifMatch として指定することを推奨します。
タイトル、タグ、公開設定のみを変更する場合は content を省略できます。
変更が成功したら、レスポンス内の新しい etag を使用してローカルの編集状態を更新してください。
プライベートノートは作成者のみが変更できます。公開ノートの変更には、現在の API Key に書き込み権限が必要です。

リクエスト例¶

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

レスポンス¶

{
    "code": 200,
    "content": {
        "noteUUID": "nbnote_xxx",
        "title": "A v2",
        "tags": [
            "ops"
        ],
        "tagKV": {
            "host": "127.0.0.2"
        },
        "isPublic": 1,
        "createdSource": "manual",
        "noteType": "normal",
        "etag": "etag_new",
        "version": 2
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}