콘텐츠로 이동

조회¶

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