チェックリスト状態の照会

概要

• チェックリストの最後のチェック時間およびチェックリクエストの可否を照会します。
• チェックリスト毎に status(チェックリクエスト状態)が異なります。
  • status は、チェックリクエストの処理段階または時間の経過とともに内部で変化し、以下の5つのうち、1つの値を持ちます。
    • NONE: チェックリクエスト可能。
    • ENQUEUED: チェック待機中。
    • PROCESSING: チェック処理中。
    • DONE: チェックリクエスト完了。次のリクエストまで待機必要。
    • FAIL: チェック失敗。

API

• GET /categories/{categoryCode}/checkitems/status
  • {categoryCode} に該当する全てのチェックリストに対するチェックリクエストの可否を照会します。
• GET /categories/{categoryCode}/checkitems/{itemCode}/status
  • {itemCode} に該当する1つのチェックリストに対するチェックリクエストの可否を照会します。
  • 入力した {categoryCode} に含まれていない {itemCode} を入力してリクエストした場合にも、404エラーが発生します。

リクエスト

Headers

概要に明示された共通リクエストヘッダが必要です。

Path Variables

レスポンス

Response Body

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