Search for checklist
- Print
- PDF
Search for checklist
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
- You can view the information on checklists provided by Cloud Advisor.
API
- GET /categories/{categoryCode}/checkitems
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 | Y | String | Please see the Category offering and checklist. | Category code |
Responses
Response Body
{
"result": "SUCCESS",
"contents": [
{
"categoryCode": String,
"itemCode": String,
"itemName": String,
"itemDescription": String,
"itemDescriptionDetail": String,
"recommendation": String,
"checkLogicDescription": String,
"checkResultType": String,
"tableHeaderInfo": [
{
"key" : String,
"label" : String,
"type": String
},
...
]
},
...
]
}
| Response field name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| categoryCode | Y | String | SECURITY, COST | Category code |
| itemCode | Y | String | Checklist code | |
| itemName | Y | String | Multilingual application based on checklist name x-ncp-lang header | |
| itemDescription | Y | String | Multilingual application based on the description x-ncp-lang header summarizing the checklist | |
| itemDescriptionDetail | Y | String | Multilingual application based on the detailed description x-ncp-lang header for the checklist | |
| recommendation | Y | String | Multilingual application based on the guidance x-ncp-lang header for stable operation of the checklist | |
| checkLogicDescription | Y | String | Description of criteria for indicating checklist check results in RED / YELLOW / GREEN | |
| checkResultType | Y | String | TABLE, SIMPLE | Detailed check result format TABLE: Display the results of each instance of the check resource in a table. SIMPLE: No result per instance of the check resource. |
| tableHeaderInfo | Y | List<TableHeader> | checkResultType: if TABLE. Header information of the check result table by instance | |
| TableHeader.key | N | String | Unique key of the check result table column | |
| TableHeader.label | N | String | Multilingual application based on the x-ncp-lang header for the check result table column name | |
| TableHeader.type | N | String | String, Timestamp, Number, Integer, Long, Float | Result data type of the check result table column |
Was this article helpful?