문서가 속한 프로젝트를 반환하는 API입니다.
매뉴얼웍스 6.0.14 버전의 빌드번호 0658 이상부터 지원합니다.
API 만들기
<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.
API 요청
GET 형식으로 요청해야 합니다.
요청 URL 형식입니다.
/r/api/${uuid}?action=DOC_PROJECT_GET&docId=${docId}URL 파라미터 항목입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
uuid | UUID | API UUID | 예 | 5b969d63e97cfec7 |
action | 문자열 | 작업 유형 | 예 | DOC_PROJECT_GET |
docId | UUID | 문서 아이디 | 예 | aa4efc2946b1c380 |
요청 URL 예제입니다.
/r/api/5b969d63e97cfec7?action=DOC_PROJECT_GET&docId=aa4efc2946b1c380
API 응답
DOC_PROJECT_GET 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 | |
project | Project 객체 객체 배열 | 프로젝트. 문서가 프로젝트에 속해 있지 않을 때는 속성이 존재하지 않습니다. | 아니오 |
Project 객체
Project 객체는 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
id | UUID | 프로젝트 아이디 | 예 | 5b969d63e97cfec7 |
name | 문자열 | 프로젝트 이름 | 예 | 매뉴얼웍스 6.0 |
description | 문자열 | 프로젝트 설명 | 아니오 | |
parent | 프로젝트가 속한 상위 프로젝트. 상위 프로젝트가 없을 때는 속성이 존재하지 않습니다. | 아니오 |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
API_HAS_NOT_DOC | API에 해당 문서를 포함시키지 않았을 때 |
DOC_NOT_EXIST | 문서가 존재하지 않을 때 |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목이 없을 때 |
예제
예제입니다.
{
"status": "success",
"project": {
"id": "b9c0451a065c571a",
"name": "매뉴얼웍스 6.0",
"description": "매뉴얼웍스 6.0 프로젝트",
"parent" : {
"id": "6afc77612d5ad0fb",
"name": "매뉴얼웍스"
}
}
}