룩업 스키마 수정
기존 룩업 스키마의 이름과 설명을 수정합니다. 이 작업은 관리자 권한을 요구합니다.
필요 권한
관리자 이상의 계정으로 이용할 수 있습니다.
HTTP 요청
PUT /api/sonar/lookups/:guid
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
-d name=country_code2 \
-d description="국가코드 한글 이름 매핑" \
-X PUT https://HOSTNAME/api/sonar/lookups/76b8699d-91a1-4576-a908-7db753570a0a
요청 매개변수
| 키 | 필수 | 타입 | 설명 | 비고 |
|---|---|---|---|---|
| guid | O | 문자열 | 룩업 GUID | 36자 |
| name | O | 문자열 | 룩업 이름 | 최소 1자, 최대 240자. 영문, 숫자, 밑줄만 사용 |
| description | X | 문자열 | 룩업 설명 | 최대 2000자 |
정상 응답
{}
오류 응답
필수 매개변수가 누락된 경우
HTTP 상태 코드 400 응답
{
"error_code": "null-argument",
"error_msg": "name should be not null"
}
매개변수 값의 길이가 잘못된 경우
HTTP 상태 코드 400 응답
{
"error_code": "invalid-argument",
"error_msg": "'name' must be shorter than or equal to 240 characters."
}
룩업 이름에 허용되지 않는 문자를 포함한 경우
HTTP 상태 코드 400 응답
{
"error_code": "illegal-state",
"error_msg": "lookup name must be alphanumeric and underscore characters only: hello-world"
}
룩업 이름이 중복된 경우
HTTP 상태 코드 500 응답
{
"error_code": "illegal-state",
"error_msg": "duplicated lookup name: country_code2"
}
룩업 수정 권한이 없는 경우
HTTP 상태 코드 500 응답
{
"error_code": "illegal-state",
"error_msg": "no-permission"
}