콘텐츠로 이동

수정¶

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 중 하나 이상의 필드를 전달할 수 있습니다.

상세 정보 또는 이전 저장 시 반환된 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"
}