문서 목록을 반환하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.
API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다.
API 요청
GET 형식으로 요청해야 합니다.
요청 URL 형식입니다.
/r/api/${uuid}?action=DOC_LISTURL 파라미터 항목입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
uuid | UUID | API UUID | 예 | 5b969d63e97cfec7 |
action | 문자열 | 작업 유형 | 예 | DOC_LIST |
요청 URL 예제입니다.
/r/api/5b969d63e97cfec7?action=DOC_LIST
API 응답
DOC_LIST 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 | |
documents | Document 객체 배열 | 문서 데이터 목록. 문서 제목으로 정렬합니다. | 예 |
문서가 없을 때는 documents으로 빈 배열을 반환합니다.
Document 객체
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
id | UUID | UUID | 예 | 5b969d63e97cfec7 |
type | 문자열 | 문서 유형 | 예 | BOOK |
title | 문자열 | 문서 제목 | 예 | 매뉴얼웍스 사용자 가이드 |
published | boolean | 공개 여부 | 예 | true |
url | 문자열 | 웹 뷰어 URL | 예 | |
accessControl | 접근 권한 | 예 |
AccessControl 객체
AccessControl 객체는 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
owners | Accessor 객체 배열 | 소유자 목록 | 아니오 | |
collaborators | Accessor 객체 배열 | 협업자 목록 | 아니오 | |
reviewers | Accessor 객체 배열 | 독자 목록 | 아니오 |
Accessor 객체
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
type | 문자열 | 유형 | 예 | user | group | keyword |
id | 문자열 | 사용자 아이디 또는 그룹 아이디 또는 접근 권한 키워드 | 예 |
예제
예제입니다.
{
"status": "success",
"documents": [
{
"id": "b9c0451a065c571a",
"type": "BOOK",
"title": "매뉴얼웍스 사용자 가이드",
"published": true,
"url": "https://www.3rabbitz.com/book_user_guide",
"accessControl" : {
"owners": [
{
"type": "user",
"id": "user01"
}
],
"collaborators": [
{
"type": "keyword",
"id": "PROJECT_MEMBERS"
},
{
"type": "group",
"id": "group01"
}
],
"reviewers": [
{
"type": "keyword",
"id": "ALL_USERS"
}
]
}
},
{
"id": "755a23e015006f95",
"type": "BOOK",
"title": "매뉴얼웍스 설치 가이드",
"published": false,
"url": "https://www.3rabbitz.com/book_installation_guide",
"accessControl" : {
"owners": [
{
"type": "user",
"id": "user01"
},
{
"type": "keyword",
"id": "PROJECT_MEMBERS"
}
],
"collaborators": [
{
"type": "group",
"id": "group01"
},
{
"type": "group",
"id": "group02"
}
]
}
}
]
}