Search for a summary of check results
- Print
- PDF
Search for a summary of check results
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
- Search for the summary information about the check results for each item.
API
- GET /categories/{categoryCode}/checkitems/result-summary
- Search for the summary information about all checklists corresponding to {categoryCode}.
- GET /categories/{categoryCode}/checkitems/{itemCode}/result-summary
- Search for the summary information about checklists corresponding to {itemCode}.
- 404 error also occurs when a request is made by entering {itemCode} that is not included in the input {categoryCode}.
Requests
Headers
You need a [common request header](/release-20241121/docs/en/management-cloud-advisor-overview#request header) specified in the overview.
Path Variables
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| categoryCode | N | String | Please see the Category offering and checklist. | Category code |
| itemCode | N | String | Please see the Category offering and checklist. | Checklist code |
Responses
Response Body
{
"result": "SUCCESS",
"contents": [
{
"itemCode": String,
"status": String,
"summary": String,
"lastCheckTime": Timestamp
},
...
]
}
| Response field name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| itemCode | Y | String | Checklist code | |
| status | Y | String | GREEN / YELLOW / RED / BLUE | Check result grade GREEN: Safety grade YELLOW: Warning grade RED: Critical grade BLUE: The check failed due to issues with related products |
| summary | Y | String | Multilingual application based on x-ncp-lang header summarizing the results of the check | |
| lastCheckTime | Y | Timestamp | Last check time |
Was this article helpful?