API 만들기

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

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

API 요청

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

JSON 요청 형식입니다.

ADD_LABEL_TO_ITEM 요청 파라미터
이름	유형	설명	필수 여부	예
action	문자열	작업 유형	예	ADD_LABEL_TO_ITEM
labelId	UUID	라벨 아이디	예	19cfebfa8a906797
itemId	UUID	라벨을 추가할 문서 또는 장 아이디	예	54c0786ac3a51cd9

문서에 라벨을 추가하는 예제입니다.

{
    "action": "ADD_LABEL_TO_ITEM",
    "labelId": "19cfebfa8a906797",
    "itemId": "54c0786ac3a51cd9"
}

하나의 요청으로 하나의 문서 또는 장에만 라벨을 추가할 수 있습니다.

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

`ADD_LABEL_TO_ITEM` 응답
이름	유형	설명	필수 여부	예
status	문자열	상태	예	success \| fail
errors	Error 객체 배열	예외	아니오

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

예제입니다.

{
    "status": "success"
}