문서의 프로젝트를 변경하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “DOC
” 유형 API를 만듭니다.
API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다.
API 요청
POST
형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
---|---|---|---|---|
action | 문자열 | 작업 이름 | 예 | DOC_PROJECT_UPDATE |
id | UUID | 문서 아이디 | 예 | 0168a36b30c18e93 |
projectId | UUID | 프로젝트 아이디. 값이 없으면 어떤 프로젝트에도 속하지 않습니다. | 아니오 | 7518267aca42554f |
문서를 변경하는 예제입니다.
{ "action": "DOC_PROJECT_UPDATE", "id": "0168a36b30c18e93", "projectId": "7518267aca42554f" }
API 응답
DOC_PROJECT_UPDATE
응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
---|---|
API_HAS_NOT_DOC | API에 해당 문서를 포함시키지 않았을 때 |
DOC_NOT_EXIST | 문서가 존재하지 않을 때 |
PROJECT_NOT_EXIST | 프로젝트가 존재하지 않을 때 |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목이 없을 때 |
예제
예제입니다.
{ "status": "success" }