概要

チェックリストのチェックをリクエストします。
チェックリスト毎に status (チェックリクエスト状態)が異なり、実際に status が NONE (チェックリクエスト可能状態)のチェックリストに対するチェックリクエストのみ処理されます。
- status は、チェックリクエストの処理段階または時間の経過とともに内部で変化し、以下の5つのうち、1つの値を持ちます。
  - NONE: チェックリクエスト可能。
  - ENQUEUED: チェック待機中。
  - PROCESSING: チェック処理中。
  - DONE: チェックリクエスト完了。次のリクエストまで待機必要。
  - FAIL: チェック失敗。
チェックリクエスト機能は、関連商品毎に再リクエストできる時間が異なります。
- チェックリストの statusが DONE、FAIL また ENQUEUED の状態で再リクエストできる時間が過ぎると、NONE 状態にリセットされます。
チェックリストの status によってチェックリクエストが実際に処理されない場合でも、リクエスト処理成功(200、OK)とレスポンスします。
- チェックリスト別にチェックリクエストが実際に処理されたかについては、 Response Body の requestSuccess フィールドを通じてご確認いただけます。(true: 成功 / false: 失敗)
- requestSucess フィールドが falseとレスポンスしても、 status フィールド値が ENQUEUED、PROCESSING の場合は、チェックリクエストが既に処理されていることを意味します。

API

POST /categories/{categoryCode}/checkitems/refresh
- {categoryCode} に該当する全てのチェックリストに対してチェックします。
POST /categories/{categoryCode}/checkitems/{itemCode}/refresh
- {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,
      "requestSuccess": Boolean
    },
    ...
  ]
}

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

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

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

タグ

Cloud Advisor