사용자가 접근할 수 있는 라벨 목록을 반환하는 API입니다.

API 만들기

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

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

API 요청

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

요청 URL 형식입니다.

/r/api/${uuid}?action=LABEL_LIST_BY_USER&userId=${userId}&directoryId=${directoryId}

URL 파라미터 항목입니다.

URL 파라미터
이름	유형	설명	필수 여부	예
uuid	UUID	API 아이디	예	5b969d63e97cfec7
action	문자열	작업 유형	예	LABEL_LIST_BY_USER
userId	문자열	사용자 아이디	예	user01
directoryId	UUID	라벨 디렉터리 아이디. 값이 있으면 그 디렉터리에 직접 속한 라벨만 반환하고 하위 디렉터리의 라벨은 포함하지 않습니다. 값이 없으면 디렉터리에 속하지 않은 라벨과 사용자가 접근할 수 있는 디렉터리의 라벨을 모두 반환합니다.	아니오	19cfebfa8a906797

요청 URL 예제입니다.

/r/api/5b969d63e97cfec7?action=LABEL_LIST_BY_USER&userId=user01&directoryId=19cfebfa8a906797

API 응답

`LABEL_LIST_BY_USER` 응답

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

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

라벨이 없을 때는 labels로 빈 배열을 반환합니다.

`Label` 객체

`Label` 객체
이름	유형	설명	필수 여부	예
id	UUID	라벨 아이디	예	54c0786ac3a51cd9
name	문자열	라벨 이름	예	doc
description	문자열	라벨 설명	아니오
isPublic	boolean	라벨 공개 여부	예	true \| false
retentionDays	숫자	라벨 보존 기간(일). 설정했을 때만 있습니다.	아니오	30
color	문자열	라벨 색상 키워드	아니오	PINK
colorValue	문자열	라벨 색상 값	아니오	#EC407A
icon	문자열	라벨 아이콘 이름. 설정하지 않았으면 `tag`입니다.	예	tag
count	숫자	라벨이 달린 개수. 2 이상일 때만 있습니다.	아니오	2

예외 항목

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

LABEL_LIST_BY_USER 예외 항목
예외	설명
DIRECTORY_NOT_ACCESSIBLE	디렉터리 접근 권한이 없을 때
DIRECTORY_NOT_EXIST	디렉터리가 존재하지 않을 때
REQUIRED_PARAMETER_MISSING	API 요청에 필수 항목이 없을 때
USER_NOT_EXIST	사용자가 존재하지 않을 때

예제

응답 예제입니다.

{
    "status": "success",
    "labels": [
		{
			"id": "54c0786ac3a51cd9",
	    	"name": "New",
			"isPublic": true,
	    	"color": "PINK",
	    	"colorValue": "#EC407A",
	    	"icon": "tag"
    	},
		{
			"id": "2b560cf2c5262597",
	    	"name": "Note",
			"isPublic": false,
	    	"color": "BLUE",
	    	"colorValue": "#42A5F5",
	    	"icon": "tag"
		}
	]
}