MENU
      Search for details of check results

        Search for details of check results


        Article summary

        Overview

        • Provides detailed instance information about the results of the check.
        • Provides instance information only when the value of the checkResultType field viewed from the checklist search feature is TABLE.
        • Through the value of the tableHeaderInfo field viewed from the checklist search feature, you can discover the information of fields to be responded to in the detailed instance information.
        • Provides only included/excluded instances based on display option parameters.
          • By default, only the included instances for the display option parameter are provided.
          • You can set the settings to include/exclude each instance through the Check results detailed inclusion settings / Check results detailed exclusion settings.

        API

        • GET /categories/{categoryCode}/checkitems/{itemCode}/result-detail

        Requests

        Headers

        You need a common 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

        Query Parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        displayNStringall, included, excluded (default: included)Show only instances based on the display options (include/exclude).
        all: Respond to all instances
        included: Respond only to the included
        excluded: Respond only to the excluded
        pageYInteger#page >= 1Response page settings for processing the page.
        Starts from 1.
        sizeYInteger#size >= 1Page size settings for processing the page.
        Starts from 1.

        Responses

        Response Body

        {
          "result": "SUCCESS",
          "contents": {
            "itemCode": String,
            "meta": {
              "totalPage": Long,
              "currentPage": Long,
              "size": Long
            },
            "data": List<ResultTableRow>
          }
        }
        JSON
        Response field nameRequirement statusTypeRestrictionsDescription
        itemCodeYStringCategory code
        metaYMetaPage metadata for processing the page
        Meta.totalPageYLongPage metadata for processing the page
        Meta.currentPageYLongPage metadata for processing the page
        Meta.sizeYLongPage metadata for processing the page
        dataYList<ResultTableRow>Instance information of the check result
        The field of ResultTableRow is displayed in the tableHeaderInfo field of the search for details of check results feature
        ResultTableRow.instanceKeyYStringA unique key that identifies the primary field
        Unique key that recognizes instance

        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.