ルックアップスキーマ一覧取得

検索条件に一致するルックアップスキーマ一覧を取得します。本操作には管理者権限が必要です。

必要な権限

ADMIN以上のロールが必要です。

HTTPリクエスト

GET /api/sonar/lookups

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     https://HOSTNAME/api/sonar/lookups

リクエストパラメータ

キー	必須	型	説明	備考
offset	X	32ビット整数	スキップする件数	デフォルトは0
limit	X	32ビット整数	最大取得件数	未指定時は全件取得
keywords	X	文字列	検索キーワード	名前、説明、クエリを対象に検索

正常応答

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