キュー項目を変更
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
このAPIは、指定したキューの指定したキュー項目の状態を処理済み(processed)または異常(exception)に変更し、キュー項目の説明を変更するために使用します。
事前操作
- 認証APIを使用してaccessTokenを取得します。
リクエスト
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/tool/queue/v1/queueitems/{{itemUuid}} | {{itemUuid}} をキュー項目UUIDに置き換えます |
| HTTP Method | PATCH |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数を、認証APIが返すaccess Tokenに置き換える必要があります |
| Accept | / | |
| Content-Type | application/json |
リクエストパラメータ
| 名称 | タイプ | 必須 | 説明 |
|---|---|---|---|
| status | String | はい | 状態です。processed、exceptionを指定します |
| description | String | いいえ | 説明です。長さは0~2000にする必要があります |
レスポンス
レスポンスデータ構造
| 名称 | タイプ | 説明 |
|---|---|---|
| code | integer | 戻り値の結果コードです 200は成功、その他は失敗を示します |
| success | boolean | 呼び出しが成功したかどうかを示します。このフィールドでAPI呼び出しの成否を判断できます |
| requestId | string | リクエストidです。問題の調査に使用します |
| serverIp | string | 処理サービスのIP |
| serverInstName | string | 処理サービスのインスタンス名 |
| msg | string | ステータスコードの説明 |
レスポンスデータの例
{
"code": 0,
"success": false,
"requestId": "",
"serverIp": "",
"serverInstName": "",
"msg": ""
}
使用例
curlの例
curl --location --request PATCH 'https://api.example.com/oapi/tool/queue/v1/queueitems/{{itemUuid}}' \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Host: api.example.com' \
--data-raw '{
"status": "processed",
"description": "string"
}'
その他
キュー項目の状態
| status | 説明 |
|---|---|
| queued | 待機中 |
| processing | 処理中 |
| processed | 処理済み |
| exception | 異常 |
| on hold | 保留中 |
| expired | タイムアウトにより有効期限切れ |