라벨을 변경하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “LABEL” 유형 API를 만듭니다.
API 요청
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
action | 문자열 | 작업 유형 | 예 | LABEL_UPDATE |
id | UUID | 라벨 아이디 | 예 | 86ed5e400d38c511 |
name | 문자열 | 이름. 최대 100자입니다. | 예 | NEW |
description | 문자열 | 설명. 최대 2000자입니다. 빼고 보내면 그대로 두고, 빈 값을 보내면 지웁니다. | 아니오 | |
isPublic | boolean | 공개 여부. 빼고 보내면 그대로 둡니다. | 아니오 | true | false |
color | 문자열 | 색상. 라벨 만들기의 허용 색상 가운데 하나입니다. 빼고 보내면 그대로 두고, 빈 값을 보내면 지웁니다. | 아니오 | RED |
directoryId | UUID | 라벨 디렉터리 아이디. 빼고 보내면 그대로 두고, 빈 값을 보내면 디렉터리에서 뺍니다. | 아니오 |
라벨을 변경하는 예제입니다.
{
"action": "LABEL_UPDATE",
"id": "86ed5e400d38c511",
"name": "NEW",
"isPublic": true,
"color": "RED"
}API 응답
LABEL_UPDATE 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 |
예외
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
DIRECTORY_NOT_EXIST | 라벨 디렉터리가 존재하지 않을 때 |
INVALID_PARAMETER | 문자열의 길이 등이 형식에 맞지 않을 때 |
LABEL_NOT_EXIST | 라벨이 존재하지 않을 때 |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목( |
UNSUPPORTED_COLOR_TYPE | 허용하지 않는 색상일 때 |
예제
예제입니다.
{
"status": "success"
}