문서를 복사하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.
API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다.
API 요청
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
action | 문자열 | 작업 유형 | 예 | DOC_COPY |
docId | UUID | 복사할 문서 아이디 | 예 | 686341e93e30d856 |
title | 문자열 | 복사한 문서의 이름. 생략하면 기존 문서 제목에 "Copy of "를 앞에 붙입니다. | 아니오 | 새로운 설치 가이드 |
projectId | UUID | 복사한 문서를 위치시킬 프로젝트 아이디. 없을 때는 원본 문서의 프로젝트에 담깁니다. | 아니오 | 910e2b82118359a3 |
copyAccessControl | boolean | 접근 권한 복사 여부. 기본 값은 | 아니오 | true | false |
문서를 복사하는 예제입니다.
{
"action": "DOC_COPY",
"docId": "686341e93e30d856",
"title": "새로운 설치 가이드",
"projectId": "910e2b82118359a3",
"copyAccessControl": true
}다음을 참고합니다.
공개 정보는 복사하지 않습니다. 따라서 복사한 문서는 비공개 상태입니다.
문서 크기에 따라서 복사하는데 오래 걸릴 수 있습니다. 타임 아웃 제한이 없으며, 오류가 발생하지 않는 한 복사가 끝날 때까지 기다립니다.
복사한 문서를 API에 자동으로 추가합니다.
API 응답
DOC_COPY 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 | |
document | 새로 만들어진 문서 | 예 |
Document 객체
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
id | UUID | 문서 아이디 | 예 | 5b969d63e97cfec7 |
title | 문자열 | 문서 제목 | 예 | 새로운 설치 가이드 |
예외
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
DOC_NOT_EXIST | 문서가 존재하지 않을 때 |
PROJECT_NOT_EXIST | 프로젝트가 존재하지 않을 때 |
INVALID_PARAMETER | 문자열의 길이 등이 형식에 맞지 않을 때 |
BOOK_LICENSE_EXCEEDED | 라이선스로 문서를 더 이상 만들 수 없을 때 |
예제
예제입니다.
{
"status": "success",
"document": {
"id": "5b969d63e97cfec7",
"title": "새로운 설치 가이드"
}
}