콘텐츠로 이동

생성¶

POST /api/v1/notes_v2/create

개요¶

새로운 메모를 생성합니다.

Body 요청 매개변수¶

매개변수명	유형	필수	설명
title	string	Y	메모 제목 비어 있음 허용: 아니요
content	string	Y	Markdown 본문 비어 있음 허용: 아니요
tags	array		태그 목록 비어 있음 허용: 아니요
tagKV	json		키-값 태그 비어 있음 허용: 아니요
isPublic	int		공개 여부, 1은 공개, 0은 비공개, 기본값 1 비어 있음 허용: 아니요
extend	json		Studio 비즈니스 확장 필드 비어 있음 허용: 아니요
noteType	string		메모 유형, normal은 일반 메모, runbook은 운영 매뉴얼, 기본값 normal 비어 있음 허용: 아니요 선택 가능한 값: ['normal', 'runbook']

매개변수 추가 설명¶

이 인터페이스를 사용하여 새 메모를 생성합니다. 요청 본문에는 최소한 title과 content를 전달해야 하며, 선택적으로 tags, tagKV, isPublic, extend를 전달할 수 있습니다.

메모 저장 경로를 전달할 필요가 없으며, noteUUID도 전달하지 마십시오. 생성 성공 후 응답에서 noteUUID를 읽습니다.
isPublic을 전달하지 않으면 기본값은 공개 메모입니다. 0을 전달하면 비공개 메모를 나타냅니다.
생성 성공 후, 이후 조회, 수정, 삭제는 모두 응답의 noteUUID를 사용합니다.
응답의 etag는 최초 편집 또는 삭제 시 ifMatch로 사용할 수 있습니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/notes_v2/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"title":"A","content":"# A","tags":["ops"],"tagKV":{"host":"127.0.0.1"}}'

응답¶

{
    "code": 200,
    "content": {
        "noteUUID": "nbnote_xxx",
        "title": "A",
        "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"
}