MENU
      Search for a summary of check results

        Search for a summary of check results


        Article summary

        Overview

        • Search for the summary information about the check results for each item.

        API

        • GET /categories/{categoryCode}/checkitems/result-summary
          • Search for the summary information about all checklists corresponding to {categoryCode}.
        • GET /categories/{categoryCode}/checkitems/{itemCode}/result-summary
          • Search for the summary information about checklists corresponding to {itemCode}.
          • 404 error also occurs when a request is made by entering {itemCode} that is not included in the input {categoryCode}.

        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

        Responses

        Response Body

        {
          "result": "SUCCESS",
          "contents": [
            {
              "itemCode": String,
              "status": String,
              "summary": String,
              "lastCheckTime": Timestamp
            },
            ...
          ]
        }
        JSON
        Response field nameRequirement statusTypeRestrictionsDescription
        itemCodeYStringChecklist code
        statusYStringGREEN / YELLOW / RED / BLUECheck result grade
        GREEN: Safety grade
        YELLOW: Warning grade
        RED: Critical grade
        BLUE: The check failed due to issues with related products
        summaryYStringMultilingual application based on
        x-ncp-lang header summarizing the results of the check
        lastCheckTimeYTimestampLast check time

        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.