Create Lookup

Creates a new lookup. This operation requires administrator role.

HTTP Request

POST /api/sonar/lookups

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     -d name=country_code \
     -d description="Country code to Korean name mapping" \
     -d fields="[{""field_name"":"country_code",""len"":2,""use_null"":false},{""field_name"":""name"",""len"":255,""use_null"":false}]"
     -X POST https://HOSTNAME/api/sonar/lookups

Request Parameters

Key	Required	Type	Description	Notes
guid	N	String	Lookup GUID	36 characters. Default: randomly generated
name	Y	String	Lookup name	Min 0, max 240 characters. Alphanumeric and underscore only
description	N	String	Lookup description	Max 2000 characters
fields	Y	Object array	Field definition list	See fields object properties below

fields object properties

Key	Required	Type	Description
field_name	Y	String	Field name
len	Y	32-bit integer	Maximum value length
use_null	Y	Boolean	Whether empty values are allowed

Successful Response

HTTP status code 200 response

{
  "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

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_code"
}

permission: no lookup creation permission

HTTP status code 500 response

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}