Get¶

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

Overview¶

Get the details of a new version note.

Route Parameters¶

Parameter Details¶

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

• It is recommended to save the returned etag for the editing page.
• The path in the response can be used for display or for note positioning with other systems; the create, modify, and delete interfaces still do not require passing path.
• When modifying or deleting, this etag can be submitted as ifMatch to avoid overwriting updates made by others.
• If the current API Key does not have permission to access the note, it will return as if the resource does not exist or permission is denied.

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",
        "etag": "etag_xxx",
        "version": 1
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}