MENU
      Search for checklist

        Search for checklist


        Article summary

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

        Path Variables

        Parameter nameRequirement statusTypeRestrictionsDescription
        categoryCodeYStringPlease 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
                },
                ...
              ]
            },
            ...
          ]
        }
        JSON
        Response field nameRequirement statusTypeRestrictionsDescription
        categoryCodeYStringSECURITY, COSTCategory code
        itemCodeYStringChecklist code
        itemNameYStringMultilingual application based on
        checklist name x-ncp-lang header
        itemDescriptionYStringMultilingual application based on
        the description x-ncp-lang header summarizing the checklist
        itemDescriptionDetailYStringMultilingual application based on
        the detailed description x-ncp-lang header for the checklist
        recommendationYStringMultilingual application based on
        the guidance x-ncp-lang header for stable operation of the checklist
        checkLogicDescriptionYStringDescription of criteria for indicating checklist check results in RED / YELLOW / GREEN
        checkResultTypeYStringTABLE, SIMPLEDetailed 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.
        tableHeaderInfoYList<TableHeader>checkResultType: if TABLE. Header information of the check result table by instance
        TableHeader.keyNStringUnique key of the check result table column
        TableHeader.labelNStringMultilingual application based on
        the x-ncp-lang header for the check result table column name
        TableHeader.typeNStringString, Timestamp, Number, Integer, Long, FloatResult data type of the check result table column

        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.