プロシージャ作成

新しいプロシージャを追加します。

HTTPリクエスト

POST /api/sonar/procedures

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 POST https://HOSTNAME/api/sonar/procedures

リクエストパラメーター

キー	必須	タイプ	説明	備考
guid	X	文字列	プロシージャ識別子	36文字。未設定時はランダム生成
name	O	文字列	プロシージャ名	最小1文字、最大255文字
description	X	文字列	プロシージャ説明	最大2,000文字
query	O	文字列	クエリ文字列
parameters	X	オブジェクト配列	パラメーターリスト	下記参照
company_public	X	ブール値	全体共有可否
granted_user_guids	X	文字列配列	共有ユーザーリスト	カンマ（`,`）区切りのユーザーGUIDリスト
granted_group_guids	X	文字列配列	共有ユーザーグループリスト	カンマ（`,`）区切りのユーザーグループGUIDリスト

parameters オブジェクト属性

type（文字列）：パラメーターのデータ型（例：string）
key（文字列）：パラメーターの一意な識別キー。クエリ内で $("key") 形式で参照
name（文字列）：パラメーターの表示名
description（文字列）：パラメーターの説明

正常応答

{
  "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

エラー応答

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

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形式でない場合

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