문서와 장에서 라벨을 삭제하는 API입니다.
매뉴얼웍스 6.0.20 버전부터 지원합니다.
API 만들기
<도구 | API> 메뉴에서 “LABEL” 유형 API를 만듭니다.
API 요청
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
action | 문자열 | 작업 유형 | 예 | REMOVE_LABEL_FROM_ITEM |
labelId | UUID | 라벨 아이디 | 예 | 19cfebfa8a906797 |
itemId | UUID | 라벨을 삭제할 문서 또는 장 아이디 | 예 | 54c0786ac3a51cd9 |
문서에서 라벨을 삭제하는 예제입니다.
{
"action": "REMOVE_LABEL_FROM_ITEM",
"labelId": "19cfebfa8a906797",
"itemId": "54c0786ac3a51cd9"
}하나의 요청으로 하나의 문서 또는 장에서만 라벨을 삭제할 수 있습니다.
API 응답
REMOVE_LABEL_FROM_ITEM 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
ITEM_NOT_EXIST | 라벨을 삭제할 문서 또는 장이 존재하지 않을 때 |
LABEL_NOT_EXIST | 라벨이 존재하지 않을 때 |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목이 없을 때 |
예제
예제입니다.
{
"status": "success"
}