문서를 변경하는 API입니다.

API 만들기

<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.

다양한 쓰리래빗츠 북 API를 만드는 방법을 설명합니다.

API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다. 대상으로 "공개한 문서"를 선택하면 호출 시점에 공개되어 있는 문서만 대상으로 하고, 공개하지 않은 문서에는 API_HAS_NOT_DOC 예외를 반환합니다.

API 요청

POST 형식으로 요청해야 합니다.

JSON 요청 형식입니다.

DOC_UPDATE 요청 파라미터
이름	유형	설명	필수 여부	예
action	문자열	작업 유형	예	DOC_UPDATE
id	UUID	문서 아이디	예	0168a36b30c18e93
title	문자열	제목. 최대 2000자입니다.	예	시스템 설치 가이드
subtitle	문자열	부제목. 최대 2000자입니다. 빼고 보내면 기존 부제목을 그대로 둡니다. 빈 값을 보내면 부제목을 지웁니다.	아니오	설치 방법 제공

문서를 변경하는 예제입니다.

{
    "action": "DOC_UPDATE",
    "id": "0168a36b30c18e93",
    "title": "시스템 설치 가이드",
	"subtitle": "설치 방법 제공"
}

JSON 형식의 응답은 다음과 같습니다.

`DOC_UPDATE` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오

예외 항목은 다음과 같습니다.

예제입니다.

{
	"status": "success"
}