문서와 장과 단락의 사용자 정의 아이디 목록을 반환하는 API입니다.

API 만들기

<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.

다양한 쓰리래빗츠 북 API를 만드는 방법을 설명합니다.

API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다.

API 요청

GET 형식으로 요청해야 합니다.

요청 URL 형식입니다.

/r/api/${uuid}?action=DOC_USER_DEFINED_ID_LIST&docId=${docId}

URL 파라미터 항목입니다.

이름	유형	설명	필수 여부	예
uuid	UUID	API UUID	예	5b969d63e97cfec7
action	문자열	작업 유형	예	DOC_USER_DEFINED_ID_LIST
docId	UUID	문서 아이디	예	7282e660d04cd664

요청 URL 예제입니다.

/r/api/5b969d63e97cfec7?action=DOC_USER_DEFINED_ID_LIST&docId=7282e660d04cd664

API 응답

`DOC_USER_DEFINED_ID_LIST` 응답

JSON 형식의 응답은 다음과 같습니다.

`DOC_USER_DEFINED_ID_LIST` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오
userDefinedIds	UserDefinedId 객체 배열	사용자 정의 아이디 목록. `alias`로 정렬합니다.	예

사용자 정의 아이디가 없을 때는 userDefinedIdList로 빈 배열을 반환합니다.

`UserDefinedId` 객체

`TAG_LIST` 응답
이름	유형	설명	필수 여부	예
alias	문자열	상태	예	success \| fail
type	문자열	유형	예	ARTICLE \| BOOK \| CHAPTER \| ELEMENT
targetId	문자열	문서 또는 장 또는 단락 아이디	예	6835a4859bff4c82

예외 항목

예외 항목은 다음과 같습니다.

예외	설명
API_HAS_NOT_DOC	API에 해당 문서를 포함시키지 않았을 때
DOC_NOT_EXIST	문서가 존재하지 않을 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때

예제

응답 예제입니다.

{
    "status": "success",
    "userDefinedIds": [
		{
			"alias": "hardware",
	    	"type": "ELEMENT",
		    "targetId": "6835a4859bff4c82"
    	},
		{
			"alias": "system_requirements",
	    	"type": "CHAPTER",
    		"targetId" : "8d2c91a47bcb1ca1"
    	},
		{
			"alias": "user_guide",
	    	"type": "BOOK",
    		"targetId" : "1344458afe5de5d4"
		}
	]
}