Search for a summary of the results
- Print
- PDF
Search for a summary of the results
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
- Search for the number of cases with green/yellow/red check results for all checklists by category.
API
- GET /categories/dashboard
- Search for the results of the check for all checklists.
- If requested with the authentication information of the sub account, only the check results of the categories in which the sub account has permission to search are responded to.
- GET /categories/{categoryCode}/dashboard
- Search for the results of the check for all checklists corresponding to {categoryCode}.
Requests
Headers
You need a common request headerspecified 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. | Checklists code |
Responses
Response Body
{
"result": "SUCCESS",
"contents": [
{
"categoryCode": String,
"categoryName": String,
"green": Long,
"yellow": Long,
"red": Long,
"blue": Long
}
]
}
| Response field name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| categoryCode | Y | String | SECURITY, COST | Category code |
| categoryName | Y | String | Category name Multi-language application based on x-ncp-lang header | |
| green | Y | Long | Number of checklists for which the check result is GREEN (safe) | |
| yellow | Y | Long | Number of checklists for which the check result is YELLOW (warning) | |
| red | Y | Long | Number of checklists for which the check result is RED (critical) | |
| blue | Y | Long | Number of checklists that failed to be checked due to product issues related to the checklist |
Was this article helpful?