Get Glossary Terms

Retrieves glossary term list.

Required Permissions

Requires the ADMIN role or higher.

HTTP Request

GET /api/sonar/glossary/terms

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/glossary/terms?category=table"

Request Parameters

Key	Required	Type	Description	Notes
offset	N	32-bit integer	Number to skip	Default: `0`
limit	N	32-bit integer	Maximum count	Default: `20`
keywords	N	String	Search keywords	String to search in `term`, `code`, `description`
category	N	String	Category	Term usage target. One of `table`, `field`
locale	N	String	Language	One of `ko`(Korean), `en`(English), `zh`(Chinese)

Success Response

HTTP status code 200 response

{
  "total_count": 1,
  "terms": [
    {
      "guid": "a07e6bd4-5ca2-11f0-ad90-acde48001122",
      "locale": "ko",
      "term": "Timestamp",
      "type": "DATE",
      "code": "_time",
      "category": "field",
      "description": "Log creation timestamp",
      "created": "2025-07-01 00:31:13+0900",
      "updated": "2025-07-01 00:31:13+0900"
    }
  ]
}

Response Fields

Field	Type	Description
total_count	32-bit integer	Total count matching search criteria
terms	Array	Term list
terms[].guid	String	Term GUID (36-character GUID)
terms[].locale	String	Language (One of `ko`(Korean), `en`(English), `zh`(Chinese))
terms[].term	String	Term
terms[].type	String	Data type (One of `DATE`, `STRING`, `IP`, `PORT`, `SHORT`, `INT`, `LONG`, `COUNTRY`, `FLOAT`, `DOUBLE`, `BOOL`, `MD5`, `SHA1`, `URL`, `SHA256`, `DOMAIN`)
terms[].code	String	Term identification code
terms[].category	String	Term usage target category (One of `table`, `field`)
terms[].description	String	Term description
terms[].created	String	Creation date/time (`yyyy-MM-dd HH:mm:ssZ` format)
terms[].updated	String	Modification date/time (`yyyy-MM-dd HH:mm:ssZ` format)

Error Responses

offset, limit: non-integer values

HTTP status code 400 response

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}

offset, limit: negative values

HTTP status code 400 response

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}

offset, limit: exceeds maximum value

HTTP status code 400 response

{
  "error_code": "invalid-argument",
  "error_msg": "'limit' must be less than or equal to 2147483647."
}

category: invalid value

HTTP status code 400 response

{
  "error_code": "invalid-argument",
  "error_msg": "invalid category: ABC"
}

permission: no glossary term viewing permission

HTTP status code 500 response

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