チェック結果要約の照会
- 印刷する
- PDF
チェック結果要約の照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
- リスト別のチェック結果に対する要約情報を照会します。
API
- GET /categories/{categoryCode}/checkitems/result-summary
- {categoryCode} に該当する全てのチェックリストに対する要約情報を照会します。
- GET /categories/{categoryCode}/checkitems/{itemCode}/result-summary
- {itemCode} に該当する1つのチェックリストに対する要約情報を照会します。
- 入力した {categoryCode} に含まれていない {itemCode} を入力してリクエストした場合にも、404エラーが発生します。
リクエスト
Headers
概要に明示された共通リクエストヘッダが必要です。
Path Variables
パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
categoryCode | N | String | 提供カテゴリおよびチェックリストをご参照ください。 | カテゴリコード |
itemCode | N | String | 提供カテゴリおよびチェックリストをご参照ください。 | チェックリストコード |
レスポンス
Response Body
{
"result": "SUCCESS",
"contents": [
{
"itemCode": String,
"status": String,
"summary": String,
"lastCheckTime": Timestamp
},
...
]
}
レスポンスフィールド名 | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
itemCode | Y | String | チェックリストコード | |
status | Y | String | GREEN / YELLOW / RED / BLUE | チェック結果の等級 GREEN: 安全等級 YELLOW: 警告等級 RED: 危険等級 BLUE: 関連商品のイシューによりチェック失敗 |
summary | Y | String | チェック結果を要約した結果メッセージ X-ncp-lang ヘッダによる多国語の適用 | |
lastCheckTime | Y | Timestamp | 最後のチェック時間 |
この記事は役に立ちましたか?