コンテンツにスキップ

取得¶

GET /api/v1/notes_v2/{note_uuid}/get

概要¶

新版ノートの詳細を取得します。

ルートパラメータ¶

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

パラメータ補足説明¶

URL 内の note_uuid を使用してノートの詳細を取得します。この API は Markdown 本文 content、NbookDB ノートパス path、タイトル、タグ、公開状態、および現在の etag を返します。

編集ページでは、今回返された etag を保存しておくことを推奨します。
レスポンス内の path は表示や他のシステムとのノート位置特定に利用できます。作成・変更・削除の API では引き続き path を送信する必要はありません。
変更または削除時に、この etag を ifMatch として送信することで、他のユーザーの更新を上書きするのを防げます。
現在の API Key が当該ノートにアクセスする権限を持たない場合、リソースが存在しない、または権限がないとしてエラーが返されます。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/notes_v2/nbnote_xxx/get' \
-H 'DF-API-KEY: <DF-API-KEY>'

レスポンス¶

{
    "code": 200,
    "content": {
        "noteUUID": "nbnote_xxx",
        "title": "A",
        "content": "# A",
        "path": "manual/nbnote_xxx.md",
        "tags": [
            "ops"
        ],
        "tagKV": {
            "host": "127.0.0.1"
        },
        "isPublic": 1,
        "createdSource": "manual",
        "noteType": "normal",
        "etag": "etag_xxx",
        "version": 1
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}