라벨을 만드는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “LABEL” 유형 API를 만듭니다.
API 요청 형식
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
action | 문자열 | 작업 유형 | 예 | LABEL_CREATE |
name | 문자열 | 이름 | 예 | Note |
description | 문자열 | 설명 | 아니오 | |
isPublic | boolean | 공개 여부 | 예 | true | false |
color | 문자열 | 색상 | 아니오 | RED |
directoryId | UUID | 디렉터리 아이디 | 아니오 |
라벨을 만드는 예제입니다.
{
"action": "LABEL_CREATE",
"name": "Note",
"isPublic": true,
"color": "RED"
}API 응답
LABEL_CREATE 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 | |
label | 라벨 | 예 |
Label 객체
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
id | UUID | 라벨 아이디 | 예 | 55f6170f76f955d0 |
name | 문자열 | 라벨 이름 | 예 | Note |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
DIRECTORY_NOT_EXIST | 디렉터리가 존재하지 않을 때 |
INVALID_PARAMETER | 문자열의 길이 등이 형식에 맞지 않을 때 |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목이 없을 때 |
예제
예제입니다.
{
"status": "success",
"label": {
"id": "55f6170f76f955d0",
"name": "Note"
}
}