ルックアップスキーマ修正

既存のルックアップスキーマの名称と説明を修正します。この操作には管理者権限が必要です。

必要な権限

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

HTTPリクエスト

PUT /api/sonar/lookups/:guid
cURL例
curl -H "Authorization: Bearer <API_KEY>" \
     -d name=country_code2 \
     -d description="国コードの日本語名称マッピング" \
     -X PUT https://HOSTNAME/api/sonar/lookups/76b8699d-91a1-4576-a908-7db753570a0a
リクエストパラメータ
キー必須説明備考
guid文字列ルックアップGUID36文字
name文字列ルックアップ名最小1文字、最大240文字。英数字およびアンダースコアのみ使用可
description×文字列ルックアップ説明最大2000文字

正常応答

{}

エラー応答

必須パラメータが欠落している場合

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_code2"
}
ルックアップ修正権限がない場合

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

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