태그의 이름과 설명을 변경하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “DOC” 유형 API를 만듭니다.
API 상세 화면에서 설정한 문서만을 대상으로 합니다. 한 API에 여러 문서를 추가할 수 있습니다.
API 요청
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 길이 제한 | 예 |
|---|---|---|---|---|---|
action | 문자열 | 작업 이름 | 예 | TAG_UPDATE | |
id | UUID | 변경할 태그 아이디 | 예 | 0168a36b30c18e93 | |
name | 문자열 | 이름 | 예 | 100 | 태그 01-1 |
description | 문자열 | 설명 | 아니오 | 2,000 |
태그를 변경하는 예제입니다.
{
"action": "TAG_UPDATE",
"id": "0168a36b30c18e93",
"name": "태그 01-1"
}API 응답
TAG_UPDATE 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
API_HAS_NOT_DOC | API에 해당 문서를 포함시키지 않았을 때 |
INVALID_PARAMETER | 문자열의 길이 등이 형식에 맞지 않을 때 |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목이 없을 때 |
TAG_NOT_EXIST | 태그가 존재하지 않을 때 |
UPDATE_NOT_SUPPORTED | 해당 항목이 태그가 아니어서 변경을 지원하지 않을 때 |
예제
예제입니다.
{
"status": "success"
}