Update Lookup
Updates existing lookup information. This operation requires administrator role.
HTTP Request
PUT /api/sonar/lookups/:guid
cURL Example
curl -H "Authorization: Bearer <API_KEY>" \
-d name=country_code2 \
-d description="Country code to Korean name mapping" \
-X PUT https://HOSTNAME/api/sonar/lookups/76b8699d-91a1-4576-a908-7db753570a0a
Request Parameters
Path Parameters
| Key | Type | Description | Notes |
|---|---|---|---|
| guid | String | Lookup GUID | 36 characters |
Request Body Parameters
| Key | Required | Type | Description | Notes |
|---|---|---|---|---|
| name | Y | String | Lookup name | Min 0, max 240 characters. Alphanumeric and underscore only |
| description | N | String | Lookup description | Max 2000 characters |
Successful Response
HTTP status code 200 response
{}
Error Responses
name: required parameter missing
HTTP status code 400 response
{
"error_code": "null-argument",
"error_msg": "name should be not null"
}
name: invalid length
HTTP status code 400 response
{
"error_code": "invalid-argument",
"error_msg": "'name' must be shorter than or equal to 240 characters."
}
name: invalid characters
HTTP status code 400 response
{
"error_code": "illegal-state",
"error_msg": "lookup name must be alphanumeric and underscore characters only: hello-world"
}
name: duplicate lookup name
HTTP status code 500 response
{
"error_code": "illegal-state",
"error_msg": "duplicated lookup name: country_code2"
}
permission: no lookup modification permission
HTTP status code 500 response
{
"error_code": "illegal-state",
"error_msg": "no-permission"
}