Search for checklist status
- Print
- PDF
Search for checklist status
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
- Search for the last check time of the checklist and check the availability of check requests.
- Each checklist has its own status (check request status).
- status changes internally over the progress of the check request or over time, and has one of the following five values:
- NONE: A check may be requested.
- ENQUEUED: Waiting for a check.
- PROCESSING: Check in progress.
- DONE: Check request completed. Need to wait until the next request.
- FAIL: Check failed.
- status changes internally over the progress of the check request or over time, and has one of the following five values:
API
- GET /categories/{categoryCode}/checkitems/status
- Check the availability of check requests for all checklists corresponding to {categoryCode}.
- GET /categories/{categoryCode}/checkitems/{itemCode}/status
- Check the availability of check requests for one checklist 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 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 |
Responses
Response Body
{
"result": "SUCCESS",
"contents": [
{
"itemCode": String,
"timeToRefresh": Timestamp,
"lastRequestTime": Timestamp,
"status": String,
"refreshable": Boolean
},
...
]
}
Response field name | Requirement status | Type | Restrictions | Description |
---|---|---|---|---|
itemCode | Y | String | Checklist code | |
timeToRefresh | Y | Timestamp | Next time available for check | |
lastRequestTime | Y | Timestamp | Last check time | |
status | Y | String | NONE, ENQUEUED, PROCESSING, DONE, FAIL | Last check status NONE: A check may be requested. ENQUEUED: Waiting for a check PROCESSING: Check in progress DONE: Check request completed. Need to wait until the next request. FAIL: Request failed. |
refreshable | Y | Boolean | true, false | Check request availability |
Was this article helpful?