아직 지원하지 않는 API입니다. 앞으로 지원할 예정입니다.
문서의 장을 다른 문서로 이동하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.
API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다.
API 요청
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
action | 문자열 | 작업 유형 | 예 | CHAPTER_MOVE |
chapterId | UUID | 이동할 장 아이디 | 예 | 686341e93e30d856 |
targetDocId | UUID | 장을 이동할 문서 아이디 | 예 | aa4efc2946b1c380 |
before | UUID | 장 아이디. 이 장 다음에 위치합니다. 생략하면 맨 마지막에 위치합니다. | 아니오. | 5b969d63e97cfec7 |
사용자 아이디를 설정하는 예제입니다.
{
"action": "CHAPTER_MOVE",
"chapterId": "686341e93e30d856",
"targetDocId": "aa4efc2946b1c380",
"before": "5b969d63e97cfec7"
}API 응답
CHAPTER_MOVE 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 |
예외
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
CHAPTER_NOT_EXIST | 장이 존재하지 않을 때 |
TARGET_DOC_NOT_EXIST | 이동할 문서가 존재하지 않을 때 |
MOVE_IN_DOC_NOT_ALLOWED | 같은 문서에서 이동할 때 |
BEFORE_CHAPTER_NOT_EXIST | 위치할 장이 존재하지 않을 때 |
예제
예제입니다.
{
"status": "success"
}