MENU
      Search for a summary of the results

        Search for a summary of the results


        Article summary

        Overview

        • Search for the number of cases with green/yellow/red check results for all checklists by category.

        API

        • GET /categories/dashboard
          • Search for the results of the check for all checklists.
          • If requested with the authentication information of the sub account, only the check results of the categories in which the sub account has permission to search are responded to.
        • GET /categories/{categoryCode}/dashboard
          • Search for the results of the check for all checklists corresponding to {categoryCode}.

        Requests

        Headers

        You need a common request headerspecified in the overview.

        Path Variables

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

        Responses

        Response Body

        {
          "result": "SUCCESS",
          "contents": [
            {
              "categoryCode": String,
              "categoryName": String,
              "green": Long,
              "yellow": Long,
              "red": Long,
              "blue": Long
            }
          ]
        }
        JSON
        Response field nameRequirement statusTypeRestrictionsDescription
        categoryCodeYStringSECURITY, COSTCategory code
        categoryNameYStringCategory name
        Multi-language application based on x-ncp-lang header
        greenYLongNumber of checklists for which the check result is GREEN (safe)
        yellowYLongNumber of checklists for which the check result is YELLOW (warning)
        redYLongNumber of checklists for which the check result is RED (critical)
        blueYLongNumber of checklists that failed to be checked due to product issues related to the checklist

        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.