タスク&ロボットクライアントのロボット実行詳細の照会
api.example.com、console.example.com、files.example.comは説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。
事前操作
1.このインターフェースを呼び出す前に、パラメータとして使用するtaskUuidとrobotClientUuidを取得してください。taskUuidとrobotClientUuidは、単一タスクの詳細照会インターフェースおよび最新の実行記録インターフェースから取得できます。
説明: このインターフェースでは、該当するタスク実行記録における、該当クライアント上のすべてのロボット実行記録を取得できます。中央管理プラットフォームの実行記録で、特定のクライアントをクリックしてロボットの実行詳細を表示する操作に相当します。
テンプレート
postManテンプレート
Javaテンプレート
リクエストモデル:
レスポンスモデル:
ロボット実行結果モデル:
リクエスト
| 基本 | 説明 | |
|---|---|---|
| HTTP URL | https://api.example.com/oapi/dispatch/v2/task/process/detail | 専用クラウドをご利用の企業は、専用クラウドのアドレスを使用してください。 |
| HTTP Method | POST |
リクエストヘッダー
| 基本 | 説明 | |
|---|---|---|
| Authorization | Bearer {accessToken} | {accessToken}変数は、認証インターフェースが返すaccess Tokenに置き換える必要があります。 |
| Content-Type | application/json |
リクエストボディ
| 名称 | タイプ | 説明 | 必須かどうか | 説明 |
|---|---|---|---|---|
| taskUuid | string | タスク実行のuuid | はい | タスクの起動インターフェースから取得します。 |
| robotClientUuid | string | ロボットクライアントのuuid | はい | ロボットクライアントのuuid |
リクエストの例
{
"taskUuid": "45c882ed-e44f-4818-afc0-05172e7ffbe0",
"robotClientUuid": "b2c85558-2ecb-421c-99db-fa2bd56de123"
}
レスポンス
レスポンスボディ
| 名称 | タイプ | 必須かどうか | 説明 |
|---|---|---|---|
| code | int | はい | ステータスコードです。200は成功、200以外は失敗を示します。参照:ステータスコードの説明 |
| success | boolean | はい | 呼び出しが成功したかどうかを示します。このフィールドに基づいて、インターフェースの呼び出しが成功したかどうかを判断できます。 |
| msg | string | はい | ステータスコードの説明 |
| data | object | はい | レスポンスデータ |
| ∟ jobList | array | はい | ロボットの実行記録 |
| ∟ jobUuid | string | はい | ロボット実行記録のuuid |
| ∟ taskUuid | string | はい | タスク実行記録のuuid |
| ∟ status | string | はい | ロボットの実行状態です。ロボット実行状態の列挙値の説明を参照してください。 |
| ∟ createTime | string | はい | 作成日時です。通常はトリガー日時と同じです。 |
| ∟ updateTime | string | はい | 更新日時 |
| ∟ dispatchCount | number | はい | スケジューリング回数 |
| ∟ startTime | string | いいえ | 実行開始日時です。形式はyyyy-mm-dd hh:MM:ddです。 |
| ∟ endTime | string | いいえ | 実行終了日時です。形式はyyyy-mm-dd hh:MM:ddです。 |
| ∟ existsParam | boolean | はい | 入力/出力パラメータが存在するかどうかを示します。 |
| ∟ priority | string | はい | 優先度です。優先度の列挙値の説明を参照してください。 |
| ∟ remark | string | はい | ロボット実行の備考です。ロボットの実行でエラーが報告された場合、このフィールドをエラーの備考として扱えます。 |
| ∟ robotClientUuid | string | はい | ロボットクライアントのuuid |
| ∟ robotName | string | はい | ロボットの名称 |
| ∟ robotUuid | string | はい | ロボットのuuid |
| ∟ screenshotUrl | string | いいえ | エラー時のスクリーンショットのURLです。ロボットのいずれかの実行で異常が発生した場合、値は空になりません。 |
| ∟ sourceType | string | はい | 実行元のタイプです。実行元タイプの列挙値の説明を参照してください。 |
| ∟ sourceUuid | string | はい | 実行元のuuidです。通常はscheduleUuidと同じです。 |
レスポンスボディの例
statusは、ポーリングを停止するための判定に使用できます。状態が最終状態になったら、ポーリングを停止する必要があります。ロボット実行状態の列挙値の説明を参照してください。
エラーが発生した場合は、次を参照してください:ステータスコードの説明