Get¶

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

Overview¶

Get details of the new notes.

Route Parameters¶

Parameter Notes¶

Use the note_uuid in the URL to get note details. This API returns the Markdown content content, the NbookDB note path path, title, tags, public status, and the current etag.

• The editing page recommends saving the returned etag.
• The path in the response can be used for display or to locate notes with other systems; the create, update, and delete APIs still do not need to pass path.
• When modifying or deleting, you can submit this etag as ifMatch to avoid overwriting others' updates.
• If the current API Key does not have permission to access the note, it will return as resource not found or no permission.

Request Example¶

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

Response¶

{
    "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"
}