룩업 목록 조회

검색 조건과 일치하는 룩업 목록을 조회합니다. 이 작업은 관리자 권한을 요구합니다.

HTTP 요청

GET /api/sonar/lookups
cURL 예시
curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/lookups
요청 매개변수
필수타입설명비고
offsetX32비트 정수건너 뛸 갯수기본값 0
limitX32비트 정수최대 갯수미지정 시 전체 조회
keywordsX문자열검색 키워드이름, 설명, 쿼리 대상으로 검색

정상 응답

{
  "total_count": 17,
  "lookups": [
    {
      "guid": "76b8699d-91a1-4576-a908-7db753570a0a",
      "name": "country_code",
      "description": "국가코드 한글 이름 매핑",
      "record_count": 236,
      "fields": [
        {
          "field_name": "country",
          "len": 2,
          "use_null": false
        },
        {
          "field_name": "name",
          "len": 255,
          "use_null": false
        }
      ],
      "created": "2023-09-23 17:13:15+0900",
      "updated": "2023-09-23 17:13:15+0900"
    }
  ]
}
  • total_count (32비트 정수): 검색 조건과 일치하는 전체 룩업 갯수
  • lookups (배열): 페이징된 룩업 목록
    • guid (문자열): 룩업 GUID
    • name (문자열): 룩업 이름
    • description (문자열): 룩업 설명
    • record_count (32비트 정수): 룩업에 포함된 레코드 갯수
    • fields (배열): 필드 정의 목록
      • field_name (문자열): 필드 이름
      • len (32비트 정수): 값 최대 길이
      • use_null (불리언): 빈 값 허용 여부
    • created (문자열): 생성일시 (yyyy-MM-dd HH:mm:ssZ 형식)
    • updated (문자열): 수정일시 (yyyy-MM-dd HH:mm:ssZ 형식)

오류 응답

offset, limit 값이 정수가 아닌 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' parameter should be int type"
}
offset, limit 값이 음수인 경우

HTTP 상태 코드 400 응답

{
  "error_code": "invalid-argument",
  "error_msg": "'offset' must be greater than or equal to 0."
}
룩업 조회 권한이 없는 경우

HTTP 상태 코드 500 응답

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