용어 조회

지정한 용어를 조회합니다. 전체 용어 목록은 용어 목록 조회 API로 확인할 수 있습니다.

필요 권한

관리자 이상의 계정으로 이용할 수 있습니다.

HTTP 요청

cURL 예시

curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/glossary/terms/a07e6bd4-5ca2-11f0-ad90-acde48001122"

요청 매개변수

경로 매개변수

정상 응답

{
  "term": {
    "guid": "a07e6bd4-5ca2-11f0-ad90-acde48001122",
    "category": "field",
    "locale": "ko",
    "term": "시각",
    "type": "DATE",
    "code": "_time",
    "description": "로그 생성 시각",
    "created": "2025-07-01 00:31:13+0900",
    "updated": "2025-07-01 00:31:13+0900"
  }
}

• term (맵): 용어 정보. 지정한 GUID의 용어가 없으면 null
  • guid (문자열): 용어 GUID
  • category (문자열): 용어 사용 대상 분류. table, field 중 하나
  • locale (문자열): 언어. ko(한국어), en(영어), zh(중국어) 중 하나
  • term (문자열): 용어
  • type (문자열): 데이터 유형. DATE, STRING, IP, PORT, SHORT, INT, LONG, COUNTRY, FLOAT, DOUBLE, BOOL, MD5, SHA1, URL, SHA256, DOMAIN 중 하나. 분류가 field가 아니면 null
  • code (문자열): 용어 식별 코드
  • description (문자열): 용어 설명
  • created (날짜): 생성 일시
  • updated (날짜): 수정 일시

지정한 GUID에 해당하는 용어가 없으면 HTTP 상태 코드 200과 함께 term 값으로 null을 반환합니다.

{
  "term": null
}

오류 응답

guid가 GUID 형식이 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}

권한이 없는 경우

HTTP 상태 코드 500 응답

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