プロシージャ修正

指定したプロシージャを修正します。

必要な権限

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

HTTPリクエスト

PUT /api/sonar/procedures/:guid

cURL例

curl -H "Authorization: Bearer <API_KEY>" \
     -d name="test" \
     -d 'query=system tables | search table == $("table")' \
     -d 'parameters=[{"type": "string", "name": "テーブル", "key": "table"}]' \
     -d granted_user_guids=b5bc3133-b53e-4b61-96b5-8857015ade0d \
     -X PUT https://HOSTNAME/api/sonar/procedures/5ad13151-dbc1-41c0-92a7-dfeb5f534f4c

リクエストパラメーター

キー	必須	タイプ	説明	備考
guid	○	文字列	プロシージャ識別子	36文字
name	○	文字列	プロシージャ名	最小1文字、最大255文字
description	×	文字列	プロシージャ説明	最大2,000文字
query	○	文字列	クエリ文字列
parameters	×	オブジェクト配列	パラメーターリスト	オブジェクト配列に `type`, `key`, `name`, `description` を含む
company_public	×	ブール値	全体共有可否	デフォルト値: `false`
granted_user_guids	×	文字列配列	共有ユーザーリスト	カンマ（`,`）区切りのユーザーGUIDリスト
granted_group_guids	×	文字列配列	共有ユーザーグループリスト	カンマ（`,`）区切りのユーザーグループGUIDリスト

正常応答

{}

エラー応答

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

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

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

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

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

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

ユーザーおよびグループ識別子がGUID形式でない場合

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

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