タスク実行結果の照会
この記事の内容
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
事前操作
先にタスクの起動APIを呼び出して、taskUuidを取得する必要があります。
説明:このAPIでは、タスクの実行結果をポーリングでき、タスク内の複数のロボットの実行結果データを取得できます。タスクの実行結果が最終状態になった場合は、ポーリングを停止する必要があります。タスクの実行ステータスについては、タスク実行ステータスの列挙値の説明を参照してください。
テンプレート
postManテンプレート
apiタスク実行結果の照会.json(右クリックして「名前を付けて保存」)
Javaテンプレート
リクエストモデル:TaskQueryReq.java(右クリックして「名前を付けて保存」)
レスポンスモデル:TaskQueryRep.java(右クリックして「名前を付けて保存」)
ロボット実行結果のモデル:JobQueryRep.java(右クリックして「名前を付けて保存」)
リクエスト
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/dispatch/v2/task/query | 専用クラウドをご利用の企業は、専用クラウドのアドレスを使用してください。 |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数は、認証APIから返されたaccessTokenに置き換える必要があります。 |
| Content-Type | application/json |
リクエストボディ
| 名称 | タイプ | 説明 | 必須かどうか | 説明 |
|---|---|---|---|---|
| taskUuid | string | タスク実行のuuid | はい | タスクの起動APIから返されます。 |
リクエスト例
{
"taskUuid":"4d8aae66-cec5-4043-85cc-70f4e0430111"
}
レスポンス
レスポンスボディ
| 名称 | タイプ | 必須かどうか | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、200以外は失敗を示します。ステータスコードの説明を参照してください。 |
| success | boolean | はい | 呼び出しが成功したかどうかを示します。このフィールドに基づいて、APIの呼び出しが成功したかどうかを判断できます。 |
| msg | string | はい | ステータスコードの説明です。 |
| data | object | はい | レスポンスデータです。 |
| ∟ taskUuid | string | はい | タスク実行のuuidです。 |
| ∟ taskName | string | はい | タスク名です。 |
| ∟ status | string | はい | タスクの実行ステータスです。このフィールドでタスクが最終状態かどうかを判断できます。最終状態の場合は、このAPIのポーリングを停止する必要があります。タスク実行ステータスの列挙値の説明を参照してください。 |
| ∟ statusName | string | はい | タスクの実行ステータスの説明です。 |
| ∟ startTime | string | いいえ | タスク実行の開始日時です。タスクがスケジューリングされると、空ではなくなります。 |
| ∟ endTime | string | いいえ | タスク実行の終了日時です。タスクの実行が終了すると、空ではなくなります。 |
| ∟ jobDataList | array | はい | タスクに関連付けられたロボットの実行情報です。ロボットが複数ある場合は、複数のレコードが含まれます。 |
| ∟ jobUuid | string | はい | ロボット実行のuuidです。 |
| ∟ status | string | はい | ロボットの実行ステータスです。 |
| ∟ statusName | string | はい | ロボットの実行ステータスの説明です。 |
| ∟ remark | string | いいえ | 備考情報です。実行時に異常が発生した場合、値は空ではありません。 |
| ∟ robotClientUuid | string | いいえ | 実行ロボットのuuidです。ロボットがスケジューリングされた後は、値は空ではありません。 |
| ∟ robotClientName | string | いいえ | 実行ロボットの名称です。ロボットがスケジューリングされた後は、値は空ではありません。 |
| ∟ startTime | string | いいえ | ロボット実行の開始日時です。ロボットのスケジューリングが開始された後は、値は空ではありません。 |
| ∟ endTime | string | いいえ | ロボット実行の終了日時です。ロボットのスケジューリングが終了した後は、値は空ではありません。 |
| ∟ robotUuid | string | はい | ロボットのuuidです。 |
| ∟ robotName | string | はい | ロボットの名称です。 |
| ∟ screenshotUrl | string | いいえ | jobのスクリーンショットのurlです。 |
| ∟ robotParams | object | いいえ | ロボットの実行パラメータです。 |
| ∟ inputs | array | いいえ | 入力パラメータです。 |
| ∟ name | string | いいえ | パラメータ名です。 |
| ∟ value | string | いいえ | パラメータ値です。 |
| ∟ type | string | いいえ | パラメータタイプです。タスク実行ステータスの列挙値の説明を参照してください。 |
レスポンスボディの例
statusは、ポーリングを停止するための指標として使用できます。ステータスが最終状態になった場合は、ポーリングを停止する必要があります。タスク実行ステータスの列挙値の説明を参照してください。
タスク実行にメインフローの入力パラメータ、出力パラメータがある場合
{
"data": {
"taskUuid": "4d8aae66-cec5-4043-85cc-70f4e0430d4e",
"taskName": "测试-api任务",
"status": "running",
"statusName": "运行中",
"startTime": "2022-01-22 15:10:28",
"endTime": "2022-01-22 15:10:46",
"jobDataList": [
{
"jobUuid": "b934597c-f06d-4c52-9624-e62e7f7b9489",
"status": "finish",
"statusName": "完成",
"remark": "",
"robotParams": {
"name":"获取页数",
"value":"10",
"type":"str"
},
"robotClientUuid": "cfcc5904-2e82-4295-911c-0ce65c9099f2",
"robotClientName": "ceshi1@csqy1",
"robotUuid": "3f3c9861-9300-4400-9c1f-f4e7f8bb4d08",
"robotName": "wait-10",
"startTime": "2022-01-22 15:10:28",
"endTime": "2022-01-22 15:10:46",
"screenshotUrl": "https://files.example.com/image/xxx.jpg"
},
{
"jobUuid": "97421b0b-2f64-4adf-94b9-0bdfc73face6",
"status": "created",
"statusName": "已创建",
"remark": "",
"robotParams": {
"name":"获取页数",
"value":"10",
"type":"str"
},
"robotClientUuid": "cfcc5904-2e82-4295-911c-0ce65c9099f2",
"robotClientName": "ceshi1@csqy1",
"robotUuid": "e8be5a0a-ec3a-4f3a-b4a2-b9319fe6fd0a",
"robotName": "等待-10s",
"startTime": "2022-01-22 15:10:28",
"endTime": "2022-01-22 15:10:46",
"screenshotUrl": "https://files.example.com/image/xxx.jpg"
}
]
},
"code": 200,
"success": true
}
job実行にメインフローの入力パラメータ、出力パラメータがない場合
{
"data": {
"taskUuid": "4d8aae66-cec5-4043-85cc-70f4e0430d4e",
"taskName": "测试-api任务",
"status": "running",
"statusName": "运行中",
"startTime": "2022-01-22 15:10:28",
"endTime": "2022-01-22 15:10:46",
"jobDataList": [
{
"jobUuid": "97421b0b-2f64-4adf-94b9-0bdfc73face6",
"status": "created",
"statusName": "已创建",
"robotParams": {},
"robotClientUuid": "cfcc5904-2e82-4295-911c-0ce65c9099f2",
"robotClientName": "ceshi1@csqy1",
"robotUuid": "e8be5a0a-ec3a-4f3a-b4a2-b9319fe6fd0a",
"robotName": "等待-10s",
"startTime": "2022-01-22 15:10:28",
"endTime": "2022-01-22 15:10:46",
"remark": "任务创建"
}
]
},
"code": 200,
"success": true
}
エラーが発生した場合は、ステータスコードの説明に移動してください。