Search for details of check results
- Print
- PDF
Search for details of check results
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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 name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| categoryCode | N | String | Please see the Category offering and checklist. | Category code |
| itemCode | N | String | Please see the Category offering and checklist. | Checklist code |
Query Parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| display | N | String | all, 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 |
| page | Y | Integer | #page >= 1 | Response page settings for processing the page. Starts from 1. |
| size | Y | Integer | #size >= 1 | Page 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>
}
}
| Response field name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| itemCode | Y | String | Category code | |
| meta | Y | Meta | Page metadata for processing the page | |
| Meta.totalPage | Y | Long | Page metadata for processing the page | |
| Meta.currentPage | Y | Long | Page metadata for processing the page | |
| Meta.size | Y | Long | Page metadata for processing the page | |
| data | Y | List<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.instanceKey | Y | String | A unique key that identifies the primary field Unique key that recognizes instance |
Was this article helpful?