釈明履歴一覧照会

指定した釈明リクエストに対して記録された釈明、一次レビュアー意見、二次レビュアー意見などの作成履歴を時系列で取得します。ログインセッションまたはメールで送信された釈明トークンを使用して呼び出せます。

必要な権限

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

HTTPリクエスト

GET /api/sonar/explanations
cURL例
curl -H "Authorization: Bearer <API_KEY>" \
     "https://HOSTNAME/api/sonar/explanations?guid=a1b2c3d4-e5f6-7890-abcd-ef1234567890&type=EXPLANATION"
リクエストパラメータ
キー必須説明備考
guidO文字列釈明リクエスト識別子36文字のGUID
typeO文字列釈明種別。EXPLANATION (釈明)、MANAGER_COMMENT (一次レビュー)、AUDITOR_COMMENT (二次レビュー) のいずれか
tokenX文字列未ログイン呼び出し時に使用する釈明トークン。役職員または一次レビュアーへメールで発行されたトークン

正常応答

{
  "explanations": [
    {
      "type": "EXPLANATION",
      "employee_name": "朴賢宰",
      "employee_guid": "e722b073-892a-4e9e-ba78-d556324a1a82",
      "request_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "content": "定期メンテナンスのスケジュールに沿って実施した作業です。",
      "owner_guid": "ffaf431b-653a-4329-8f83-913cbb00342d",
      "owner_name": "洪吉童",
      "created": "2026-04-15 09:00:00+0900",
      "updated": "2026-04-15 09:00:00+0900"
    }
  ]
}
  • explanations (配列): 釈明履歴一覧。記録がない場合は空配列
    • type (文字列): 釈明種別。EXPLANATIONMANAGER_COMMENTAUDITOR_COMMENT のいずれか
    • employee_name (文字列): 作成者の役職員名
    • employee_guid (文字列): 作成者の役職員識別子。役職員情報がない場合は null
    • request_guid (文字列): 釈明リクエスト識別子
    • content (文字列): 釈明内容
    • owner_guid (文字列): 作成ユーザの識別子。外部トークン経由の作成では null
    • owner_name (文字列): 作成ユーザ名
    • created (文字列): 作成日時。yyyy-MM-dd HH:mm:ssZ 形式
    • updated (文字列): 更新日時。yyyy-MM-dd HH:mm:ssZ 形式

エラー応答

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

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

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

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

{
  "error_code": "invalid-param-type",
  "error_msg": "guid should be guid type."
}
釈明種別が不正な場合

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

{
  "error_code": "illegal-argument",
  "error_msg": "No enum constant com.logpresso.sonar.api.explanation.ExplanationType.INVALID"
}
権限がない、またはトークンが無効な場合

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

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