MENU
      Check results detailed inclusion settings

        Check results detailed inclusion settings


        Article summary

        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-20250116/docs/en/management-cloud-advisor-overview#request header) specified in the overview.

        Path Variables

        Parameter nameRequirement statusTypeRestrictionsDescription
        categoryCodeNStringPlease see the Category offering and checklist.Category code
        itemCodeNStringPlease see the Category offering and checklist.Checklist code

        Request Body

        Field nameRequirement statusTypeRestrictionsDescription
        {root}YList<String>instanceKey of each result instance that can be viewed in the detailed check result search featurePass 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"]
        JSON

        Responses

        Response Body

        {
          "result": "SUCCESS",
          "contents": "done"
        }
        JSON
        • 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?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.