Request for check

Overview

• Request for check of the checklist.
• Each checklist has its own status (check request status), and only the check requests for the checklist whose status is NONE (status in which you can request a check) are performed.
  • 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.
• The check request feature has a different re-request time for each related product.
  • When the checklist status is DONE, FAIL, and ENQUEUED, and the re-request time has elapsed, the status is initialized to NONE status.
• Even if the check request is not performed due to the status of the checklist, it responds with a successful request processing (200, OK).
  • You can find out whether the check request was actually performed for each checklist through the requestSuccess field of the Response Body. (true: success / false: failure)
  • Even if the requestSuccess field responds as false, if the value of the status field is ENQUEUED, PROCESSING, it can be understood that the check request is already in progress.

API

• POST /categories/{categoryCode}/checkitems/refresh
  • Perform a check on all checklists corresponding to {categoryCode}.
• POST /categories/{categoryCode}/checkitems/{itemCode}/refresh
  • Perform a check on all 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-20241017/docs/en/management-cloud-advisor-overview#request header) specified in the overview.

Path Variables

Responses

• After performing the check, it responds with the same result as the search for checklist status feature.

Response Body

{
  "result": "SUCCESS",
  "contents": [
    {
      "itemCode": String,
      "timeToRefresh": Timestamp,
      "lastRequestTime": Timestamp,
      "status": String,
      "requestSuccess": Boolean
    },
    ...
  ]
}