문서의 태그 목록을 반환하는 API입니다.

API 만들기

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

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

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

API 요청

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

요청 URL 형식입니다.

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

URL 파라미터 항목입니다.

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

요청 URL 예제입니다.

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

API 응답

`TAG_LIST` 응답

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

`TAG_LIST` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오
tags	Tag 객체 배열	태그 목록. 만든 날짜의 반대로 정렬합니다.	예

태그가 없을 때는 tags로 빈 배열을 반환합니다.

Tag 객체

`Tag` 객체
이름	유형	설명	필수 여부	예
id	UUID	태그 아이디	예	b7ebeaa3c2cfcddf
name	문자열	태그 이름	예	태그 01
description	문자열	태그 설명	아니오
time	long	태그를 만든 시간	예
pdf	문자열	PDF 내려받기 URL	아니오
epub	문자열	EPUB 내려받기 URL	아니오
html	문자열	HTML 내려받기 URL	아니오
word	문자열	WORD 내려받기 URL	아니오

예외 항목

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

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

예제

응답 예제입니다.

{
    "status": "success",
    "tags": [
		{
			"id": "34541fe321724db3",
	    	"name": "태그 02",
		    "description": "최종 검토를 한 태그입니다.",
    		"pdf" : "http://127.0.0.1:1975/pdf/download/34541fe321724db3",
    		"html" : "http://127.0.0.1:1975/html/download/34541fe321724db3"
    	},
		{
			"id": "b7ebeaa3c2cfcddf",
	    	"name": "태그 01",
    		"pdf" : "http://127.0.0.1:1975/pdf/download/b7ebeaa3c2cfcddf",
    		"html" : "http://127.0.0.1:1975/html/download/b7ebeaa3c2cfcddf"
    	}
	]
}