Check results detailed inclusion settings
- Print
- PDF
Check results detailed inclusion settings
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
- Set the instances to include when providing detailed instance information.
- If the request body contains an instanceKey that does not exist, no error is generated, and among all the instanceKeys included in the request body, it is set only for an instanceKey that exists.
API
- POST /categories/{categoryCode}/checkitems/{itemCode}/result-detail/include
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 |
Request Body
| Field name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| {root} | Y | List<String> | instanceKey of each result instance that can be viewed in the detailed check result search feature | Pass instanceKey as a string list Case sensitive |
Request examples
POST /categories/SECURITY/checkitems/SUB_ACCOUNT_ACCESSKEY/result-detail/include
Content-Type: application/json
x-ncp-apigw-signature-v2: {generated signature}
x-ncp-apigw-timestamp: {current timestamp}
x-ncp-iam-access-key: {your iam access key}
x-ncp-dmn_cd: PUB
x-ncp-region_code: {your region code}
Payload:
["instanceKey-A", "instanceKey-B", "instanceKey-C"]
Responses
Response Body
{
"result": "SUCCESS",
"contents": "done"
}
- After running the API, respond only to strings indicating the completion of the request.
- If the request body contains an instanceKey that does not exist, no error is generated, and among all the instanceKeys included in the request body, it is set only for an instanceKey that exists.
Was this article helpful?