シグネチャの更新

既存のシグネチャを更新します。

必要な権限

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

HTTPリクエスト

PUT /api/sonar/signatures/:guid
cURL例
curl -H "Authorization: Bearer <API_KEY>" \
     -d signature="sig-edit" \
     -d capecs="CAPEC-3" \
     -X PUT \
     https://HOSTNAME/api/sonar/signatures/fbad71f7-230d-443e-b6b2-bd4e968c8f5b
リクエストパラメータ
キー必須型説明備考
guid○文字列シグネチャ識別子36文字GUID
signature○文字列シグネチャコード最小1文字、最大255文字
description×文字列シグネチャ説明最大2000文字
app_code×文字列アプリコード最小1文字、最大50文字
capecs○文字列一覧CAPEC ID一覧カンマ（,）区切りのCAPEC ID一覧

正常応答

{}

エラー応答

シグネチャが存在しない場合

HTTPステータスコード 500

{
  "error_code": "illegal-state",
  "error_msg": "signature not found: fbad71f7-230d-443e-b6b2-bd4e968c8f53"
}
必須パラメータが不足している場合

HTTPステータスコード 400

{
  "error_code": "null-argument",
  "error_msg": "signature should be not null"
}
識別子がGUID形式ではない場合

HTTPステータスコード 400

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}
シグネチャコードの長さが超過した場合

HTTPステータスコード 400

{
  "error_code": "invalid-argument",
  "error_msg": "'signature' must be shorter than or equal to 255 characters."
}
CAPEC IDの形式が無効な場合

HTTPステータスコード 400

{
  "error_code": "invalid-argument",
  "error_msg": "invalid capec format: invalid-capec-id"
}
権限がない場合

HTTPステータスコード 500

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