キュー項目の状態の一括変更

この記事の内容
  1. 事前操作
  2. リクエスト
  3. リクエストヘッダー
  4. リクエストパラメータ
  5. レスポンス
  6. レスポンスデータ構造
  7. 遷移可能な状態の組み合わせ(sourceStatus → targetStatus)
  8. レスポンスデータの例
  9. 発生する可能性のあるエラーコード
  10. 使用例
  11. curlの例

api.example.com、console.example.com、files.example.com は説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。

このAPIは、指定したキュー内で状態がsourceStatusであるすべてのキュー項目を、状態がtargetStatusになるように一括変更します。この操作は、単一のキュー項目ではなく、キュー内で変更元の状態に一致するすべてのキュー項目に適用されます。

事前操作

1.     認可APIを使用してaccessTokenを取得します。

リクエスト

基本 パラメータ値 説明
HTTP URL https://api.example.com/oapi/tool/queue/v1/{queueUuid}/batchModifyQueueItemStatus
HTTP Method PATCH

リクエストヘッダー

基本 パラメータ値 説明
Authorization Bearer {accessToken} {accessToken}変数は、認可APIから返されたaccess Tokenに置き換える必要があります
Content-Type application/json

リクエストパラメータ

queueUuidはURLのパスで渡し、sourceStatus/targetStatusはJSON形式でリクエスト本文(Body)として渡します。

名称 位置 タイプ 必須 説明
queueUuid Path String はい キューのUUIDです
sourceStatus Body String はい 変更元の状態です。キュー項目の状態の列挙値:waiting effective(有効化待ち)、queued(キュー待機中)、processing(処理中)、processed(処理済み)、exception(異常)、on hold(保留)、expired(タイムアウトによる期限切れ)。
targetStatus Body String はい 変更先の状態です。キュー項目の状態の列挙値:waiting effective(有効化待ち)、queued(キュー待機中)、processing(処理中)、processed(処理済み)、exception(異常)、on hold(保留)、expired(タイムアウトによる期限切れ)。

説明:sourceStatus/targetStatusには、有効な状態遷移の組み合わせを指定する必要があります。以下の「遷移可能な状態の組み合わせ」を参照してください。有効でない場合は、エラーコード10010107、または状態マシンでサポートされていないことを示す対応するエラーコードが返されます。

レスポンス

レスポンスデータ構造

名称 タイプ 説明
data null 返されるデータはありません
code integer 戻り値の結果コードです。200は成功、その他は失敗を表します
success boolean 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しが成功したかどうかを判断できます
requestId string リクエストIDです。問題の調査に使用できます
serverIp string 処理を行うサービスのIPです
serverInstName string 処理を行うサービスのインスタンス名です
msg string ステータスコードの説明です

遷移可能な状態の組み合わせ(sourceStatus → targetStatus)

変更元の状態(source) 変更可能な状態(target)
waiting effective(有効化待ち) on hold(保留)、exception(異常)
queued(キュー待機中) processing(処理中)、on hold(保留)
processing(処理中) processed(処理済み)、exception(異常)
processed(処理済み) queued(キュー待機中)、on hold(保留)
exception(異常) queued(キュー待機中)、on hold(保留)
on hold(保留) queued(キュー待機中)
expired(タイムアウトによる期限切れ) queued(キュー待機中)、on hold(保留)、exception(異常)

レスポンスデータの例

{
    "data": null,
    "code": 200,
    "success": true,
    "requestId": "2f296259-d953-4939-9701-bc28ac43e002",
    "serverIp": "10.10.1.21",
    "serverInstName": "xybot-tool-service-01",
    "msg": null
}

発生する可能性のあるエラーコード

code 説明
401 認可されていません。accessTokenが無効か、指定されていません。先に認可を完了してaccessTokenを取得する必要があります
10010001 キューが存在しません
10010107 キュー項目の状態がサポートされていません(sourceStatus/targetStatusが有効な列挙値ではありません)
10010116~10010144 状態マシンの遷移がサポートされていません(sourceStatusをtargetStatusに変更できません。例えば、処理が完了したキュー項目を処理完了としてマークすることはできません)

使用例

curlの例

curl --location --request PATCH 'https://api.example.com/oapi/tool/queue/v1/{queueUuid}/batchModifyQueueItemStatus' \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sourceStatus": "queued",
    "targetStatus": "on hold"
}'
OpenAPIの記事一覧ページの先頭へ ↑