釈明提出

指定した釈明リクエストに対して役職員の釈明または一次・二次レビュアーのコメントを記録し、処理状態を変更します。type パラメータに応じて作成者情報が決定されます。

必要な権限

MEMBER以上のロールが必要です。メールで送信された有効な釈明トークンを token パラメータに指定すると、未ログイン状態でも呼び出せます。

HTTPリクエスト

POST /api/sonar/explanation-requests/:request_guid
cURL例
curl -H "Authorization: Bearer <API_KEY>" \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{
       "type": "EXPLANATION",
       "status": "SUBMITTED",
       "result": 0,
       "content": "定期メンテナンスのスケジュールに沿って実施した作業です。"
     }' \
     https://HOSTNAME/api/sonar/explanation-requests/a1b2c3d4-e5f6-7890-abcd-ef1234567890
リクエストパラメータ
パスパラメータ
キー型説明備考
request_guid文字列釈明リクエスト識別子36文字のGUID
リクエスト本文パラメータ
キー必須型説明備考
typeO文字列釈明種別。EXPLANATION (釈明)、MANAGER_COMMENT (一次レビュー)、AUDITOR_COMMENT (二次レビュー) のいずれか
statusO文字列変更後の状態。SUBMITTED、MANAGER_REJECTED、MANAGER_CLOSED、AUDITOR_SUBMITTED、AUDITOR_REJECTED、AUDITOR_CLOSED のいずれか
resultO32ビット整数レビュー結果。0 は正常、1 は違反
contentO文字列釈明またはコメント本文
tokenX文字列未ログイン呼び出し時に使用する釈明トークン。役職員または一次レビュアーへメールで発行されたトークン

正常応答

{}

エラー応答

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

HTTPステータスコード 400 応答

{
  "error_code": "null-argument",
  "error_msg": "content should be not null"
}
釈明リクエストが存在しない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-state",
  "error_msg": "no-permission"
}
現状態では提出できない場合

HTTPステータスコード 500 応答。error_msg には釈明提出可否確認 APIの理由コードのいずれかが返されます。

{
  "error_code": "illegal-state",
  "error_msg": "after-expired-at"
}
呼び出し元がレビュアーに指定されていない場合

HTTPステータスコード 500 応答

{
  "error_code": "illegal-state",
  "error_msg": "not-employee"
}
権限がない、またはトークンが無効な場合

HTTPステータスコード 500 応答

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