ロボット実行結果の照会
この記事の内容
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
事前操作
先にロボットの起動APIを呼び出して、jobUuidを取得する必要があります。
説明:このAPIでは、ポーリングによってjobの実行ステータスを取得できます。通常はコールバックAPIと併用できます。コールバックAPIがjobに関する情報を受信した場合、またはポーリングでjobのステータスが終端状態になったことを確認した場合は、ポーリングを停止する必要があります。jobの実行ステータスについては、ロボット実行ステータスの列挙値の説明を参照してください。Dr.Roboが推奨するポーリング頻度は30秒に1回です。
テンプレート
postManテンプレート
APIによるロボット実行結果の照会(右クリックして「名前を付けて保存」)
Javaテンプレート
リクエストモデル:JobQueryReq(右クリックして「名前を付けて保存」)
レスポンスモデル:JobQueryRep(右クリックして「名前を付けて保存」)
ロボット実行結果モデル:RobotParam(右クリックして「名前を付けて保存」)
リクエスト
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/dispatch/v2/job/query | 専有クラウドをご利用の企業は、専有クラウドのアドレスを使用してください。 |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | パラメータ値 | 説明 |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数は、認証APIが返すaccess Tokenに置き換える必要があります。 |
| Content-Type | application/json |
リクエストボディ
| 名称 | タイプ | 説明 | 必須 | 説明 |
|---|---|---|---|---|
| jobUuid | string | ロボット実行uuid | はい | jobの起動APIから取得します。 |
リクエスト例
{
"jobUuid": "45c882ed-e44f-4818-afc0-05172e7ffbe0"
}
レスポンス
レスポンスボディ
| 名称 | タイプ | 必須 | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、200以外は失敗を表します。参照:ステータスコードの説明 |
| success | boolean | はい | 呼び出しが成功したかどうかを表します。このフィールドに基づいて、API呼び出しが成功したかどうかを判断できます。 |
| msg | string | はい | ステータスコードの説明です。 |
| data | object | はい | レスポンスデータです。 |
| ∟ 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 | いいえ | 入力パラメータです。 |
| ∟ item | object | いいえ | |
| ∟ name | string | いいえ | パラメータ名です。 |
| ∟ value | string | いいえ | パラメータ値です。 |
| ∟ type | string | いいえ | パラメータタイプです。ロボット実行パラメータの列挙値の説明を参照してください。 |
レスポンスボディの例
statusは、ポーリングを停止するための指標として使用できます。ステータスが終端状態になったら、ポーリングを停止する必要があります。ロボット実行ステータスの列挙値の説明を参照してください。
job実行時にメインフローの入力パラメータと出力パラメータがある場合
{
"data": {
"jobUuid": "42c2e0ce-499b-47aa-8642-3a1125b4759a",
"status": "waiting",
"statusName": "等待调度",
"remark": "应用启动",
"robotClientUuid": "00a7a1de-af0b-47ad-a3a8-a8fc2b009762",
"robotClientName": "ceshi1@csqy1",
"startTime":"2021-02-03 11:11:11",
"endTime": "2021-03-03 12:12:12",
"robotUuid": "00a7a1de-af0b-47ad-a3a8-a8fc2b009761",
"robotName": "打印日志应用",
"screenshotUrl": "https://files.example.com/image/xxx.jpg",
"robotParams": {
"inputs": [
{
"name": "姓",
"value": "王",
"type": "str"
},
{
"name": "名",
"value": "5",
"type": "str"
},
{
"name": "上传文件",
"value": "https://files.example.com/document/temp/request.txt",
"type": "file"
}
],
"outputs":[
{
"name": "姓",
"value": "王",
"type": "str"
}
]
}
},
"code": 200,
"success": true
}
job実行時にメインフローの入力パラメータと出力パラメータがない場合
{
"data": {
"jobUuid": "42c2e0ce-499b-47aa-8642-3a1125b4759a",
"status": "waiting",
"statusName": "等待调度",
"remark": "应用启动",
"robotClientUuid": "00a7a1de-af0b-47ad-a3a8-a8fc2b009762",
"robotClientName": "ceshi1@csqy1",
"startTime":"2021-02-03 11:11:11",
"endTime": "2021-03-03 12:12:12",
"robotUuid": "00a7a1de-af0b-47ad-a3a8-a8fc2b009761",
"robotName": "打印日志应用"
}
"code": 200,
"success": true
}
エラーが発生した場合は、ステータスコードの説明を参照してください。