라벨이 달린 아이템을 반환하는 API입니다.

API 만들기

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

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

API 요청

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

요청 URL 형식입니다.

/r/api/${uuid}?action=ITEM_LIST_BY_LABEL&labelId=${labelId}

URL 파라미터 항목입니다.

이름	유형	설명	필수 여부	예
uuid	UUID	API 아이디	예	5b969d63e97cfec7
action	문자열	작업 유형	예	ITEM_LIST_BY_LABEL
labeId	UUID	라벨 아이디	예	19cfebfa8a906797

요청 URL 예제입니다.

/r/api/5b969d63e97cfec7?action=ITEM_LIST_BY_LABEL&labelId=19cfebfa8a906797

API 응답

`ITEM_LIST_BY_LABEL` 응답

JSON 형식의 응답은 다음과 같습니다. 아이템을 반환할 때 문서와 장으로 묶어 반환합니다.

`ITEM_LIST_BY_LABEL` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오
items	Item 객체 배열	라벨이 달리 아이템 목록. 이름으로 정렬합니다.	예

라벨이 달린 아이템이 없을 때는 items으로 빈 배열을 반환합니다.

`Item` 객체

`ITEM` 객체
이름	유형	설명	필수 여부	예
id	UUID	아이템 아이디. 문서 또는 장 또는 단락의 아이디	예	54c0786ac3a51cd9
title	문자열	이름. 문서와 장에 라벨을 달았을 때는 해당 제목입니다. 제목 단락에 라벨을 달았을 때는 제목 단락의 내용입니다.	아니오	사용자 가이드
description	문자열	단락에 단 라벨에 사용자가 입력한 설명	아니오
type	문자열	문서 유형	아니오	BLOG \| BOOK \| VIDEO
labeled	boolean	라벨이 이 항목에 직접 달렸을 때는 true, 그렇지 않을 때는 false입니다.	예	true \| false
children	Item 객체 배열	하위 아이템 목록	아니오

예외 항목

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

예외	설명
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때
LABEL_NOT_EXIST	라벨이 존재하지 않을 때

예제

응답 예제입니다.

{
    "status": "success",
    "items": [
		{
			"id": "54c0786ac3a51cd9",
	    	"title": "사용자 가이드",
	    	"type": "BOOK"
    	},
		{
			"id": "2b560cf2c5262597",
	    	"title": "설치 가이드",
	    	"type": "BOOK",
			"children": [
				{
					"id": "4803d2b9880ed526",
					"title": "시스템 요구 사항",
					"children": [
						{
							"id": "3a2259050aa6ce84",
							"title": "하드웨어 요구 사항"
						}
					]
				}
			]
		}
	]
}