概要

チェックリストの最後のチェック時間およびチェックリクエストの可否を照会します。
チェックリスト毎に 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

パラメータ名	要否	タイプ	制約事項	説明
categoryCode	N	String	提供カテゴリおよびチェックリストをご参照ください。	カテゴリコード
itemCode	N	String	提供カテゴリおよびチェックリストをご参照ください。	チェックリストコード

レスポンス

Response Body

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

レスポンスフィールド名	要否	タイプ	制約事項	説明
itemCode	Y	String		チェックリストコード
timeToRefresh	Y	Timestamp		次のチェック可能な時間
lastRequestTime	Y	Timestamp		最後のチェック時間
status	Y	String	NONE, ENQUEUED, PROCESSING, DONE, FAIL	最後のチェック状態 NONE: チェックリクエスト可能。 ENQUEUED: チェック待機中 PROCESSING: チェック処理中 DONE: チェックリクエスト完了。次のリクエストまで待機必要。 FAIL: リクエスト失敗。
refreshable	Y	Boolean	true, false	チェックリクエストの可否

この記事は役に立ちましたか?

概要
API
リクエスト
- Headers
- Path Variables
レスポンス
- Response Body

タグ

Cloud Advisor