ルックアップスキーマ作成

新しいルックアップスキーマを作成します。本操作には管理者権限が必要です。

必要な権限

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

HTTPリクエスト

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     -d name=country_code \
     -d description="国コードの日本語名マッピング" \
     -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

リクエストパラメータ

fields配列要素の構成

• field_name（文字列）：フィールド名
• len（32ビット整数）：値の最大長
• use_null（ブール値）：空値の許容可否

正常応答

{}

エラー応答

必須パラメータが不足している場合

HTTPステータスコード 400 のレスポンス

{
  "error_code": "null-argument",
  "error_msg": "name should be not null"
}

パラメータ値の長さが不正な場合

HTTPステータスコード 400 のレスポンス

{
  "error_code": "invalid-argument",
  "error_msg": "'name' must be shorter than or equal to 240 characters."
}

ルックアップ名に許可されていない文字が含まれている場合

HTTPステータスコード 400 のレスポンス

{
  "error_code": "illegal-state",
  "error_msg": "lookup name must be alphanumeric and underscore characters only: hello-world"
}

ルックアップ名が重複している場合

HTTPステータスコード 500 のレスポンス

{
  "error_code": "illegal-state",
  "error_msg": "duplicated lookup name: country_code"
}

ルックアップ作成権限がない場合

HTTPステータスコード 500 のレスポンス

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