ロボット実行一覧の照会

この記事の内容
  1. スケジュール実行履歴一覧
  2. 事前操作
  3. テンプレート
  4. postManテンプレート
  5. javaテンプレート
  6. リクエスト
  7. リクエストヘッダー
  8. リクエストボディ
  9. リクエスト例
  10. レスポンス
  11. レスポンスボディ
  12. レスポンスボディの例

スケジュール実行履歴一覧

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

事前操作

説明: スケジュール実行履歴一覧を照会します。

テンプレート

postManテンプレート

javaテンプレート

​   リクエストモデル:

​   レスポンスモデル:

​   ロボットパラメータモデル:

リクエスト

基本 説明
HTTP URL https://api.example.com/oapi/dispatch/v2/job/list 専有クラウドをご利用の企業は、専有クラウドのアドレスを使用してください。
HTTP Method POST

リクエストヘッダー

基本 説明
Authorization Bearer {accessToken} {accessToken}変数は、認証APIが返すaccess Tokenに置き換える必要があります。
Content-Type application/json

リクエストボディ

名称 タイプ 説明 必須 説明
robotClientUuid string ロボットuuid いいえ ロボットuuidです。ロボット一覧APIから取得します。
scheduleUuid string スケジュールuuid いいえ スケジュールuuidです。タスク一覧APIから取得します。
statusList array ステータス一覧 いいえ ロボット実行ステータスの列挙値の説明を参照してください。
robotUuid string ロボットuuid いいえ ロボットuuidです。ロボット一覧APIから取得します。
triggerTimeBegin string トリガー時刻の開始値 いいえ トリガー時刻の開始値です。文字列で、形式は「yyyy-MM-dd HH:mm:ss」です。例:2025-11-10 10:00:00
triggerTimeEnd string トリガー時刻の終了値 いいえ トリガー時刻の終了値です。文字列で、形式は「yyyy-MM-dd HH:mm:ss」です。例:2025-11-10 10:00:00
cursorId long カーソルid いいえ カーソルidです。最初のページの場合、デフォルトは空です。
cursorDirection string ページ移動方向 はい preは前のページへの移動、nextは次のページへの移動を表します。デフォルトはnextです。
size int 1ページあたりの件数 はい 最小値は1、最大値は100、デフォルト値は20です。
queryApi boolean スケジューリングAPIによってトリガーされた一覧データのみを照会します。 いいえ デフォルトはfalseです。このパラメータにtrueを指定すると、コンソールのAPI実行履歴一覧を取得できます。

リクエスト例

最初のページ

{
  "robotClientUuid": "45c882ed-e44f-4818-afc0-05172e7ffbe0",
  "cursorDirection": "next", // デフォルトでは次のページに移動します。
  "size": 20
}

次のページへの移動

{
  "cursorId": 1234567,  // nextIdの値を使用します。
  "robotClientUuid": "45c882ed-e44f-4818-afc0-05172e7ffbe0",
  "cursorDirection": "next",  // カーソル方向はnextです。
  "size": 20
}

前のページへの移動

{
  "cursorId": 1234567,  // preIdの値を使用します。
  "robotClientUuid": "45c882ed-e44f-4818-afc0-05172e7ffbe0",
  "cursorDirection": "pre",  // カーソル方向はpreです。
  "size": 20
}

レスポンス

レスポンスボディ

名称 タイプ 必須 説明
data object はい
∟code int はい ステータスコードです。200は成功、200以外は失敗を表します。参照:ステータスコードの説明
∟success boolean はい 呼び出しが成功したかどうかを表します。このフィールドに基づいて、API呼び出しが成功したかどうかを判断できます。
∟msg string はい ステータスコードの説明です。
∟hasData boolean はい さらにページを移動した際にデータがあるかどうかを判断するために使用します。ページ移動ボタンをグレーアウトする操作に使用できます。例えば、次のページへ移動して20ページ目に到達したとき、21ページ目にデータがなければ、20ページ目のhasDataはfalseになります。これは、それ以上次のページには移動できず、前のページにのみ移動できることを表します。
∟nextId long はい 次のページに移動する際に、cursorIdとして使用できます。このidを起点に次のページへ移動することを表します。
∟preId long はい 前のページに移動する際に、cursorIdとして使用できます。このidを起点に前のページへ移動することを表します。
∟cursorDirection string はい 現在のページ移動方向です。nextは現在、次のページへ移動していることを表し、preは現在、前のページへ移動していることを表します。
∟dataList array はい レスポンスデータです。
∟ id long はい カーソルidです。
∟ jobUuid string はい ロボット実行uuidです。
∟ taskName string はい タスク名です。
∟ status string はい ロボット実行ステータスです。
∟ triggerTime date はい トリガー時刻です。タスクがトリガーされた時刻を表します。
∟ startTime date いいえ ロボットの実行開始時刻です。ロボットのスケジューリングが開始されると、値が設定されます。
∟ endTime date いいえ ロボットの実行終了時刻です。ロボットの実行が終了すると、値が設定されます。
∟ robotUuid string はい ロボットuuidです。
∟ robotName string はい ロボット名です。
∟ remark string いいえ ロボット実行時の異常に関する備考です。
∟ robotClientUuid string いいえ ロボットuuidです。
∟ robotClientName string いいえ ロボット名です。

レスポンスボディの例

statusは、ポーリングを停止するための指標として使用できます。ステータスが終端状態になったら、ポーリングを停止する必要があります。ロボット実行ステータスの列挙値の説明を参照してください。

次のページへの移動

{
    "data": {
        "hasData": true,
        "nextId": 284065875470133276,
        "preId": 284065875470133295,
        "cursorDirection": "next",
        "dataList": [
            {
                "id": 284065875470133295,
                "jobUuid": "a54f25ef-9373-499a-afbb-79699f2c39e5",
                "status": "error",
                "taskName": "测试任务3",
                "robotUuid": "db5c419d-0ae7-4104-a313-45dc27ce3e49",
                "robotName": "应用A",
                "triggerTime": "2023-10-24 09:03:00",
                "robotClientUuid": "b21e8ffc-028c-40ae-a074-45a19f07cbda"
            },
            {
                "id": 284065875470133276,
                "jobUuid": "20db77a9-4126-412a-930c-0cc02c7b2d0c",
                "status": "error",
                "taskName": "测试3",
                "robotUuid": "799a2b1d-30ae-40ac-b011-f8a2beea5373",
                "robotName": "迁移测试",
                "triggerTime": "2023-10-24 09:00:00",
                "robotClientUuid": "b21e8ffc-028c-40ae-a074-45a19f07cbda"
            }
        ]
    },
    "code": 200,
    "success": true
}

前のページへの移動

{
    "data": {
        "hasData": true,
        "nextId": 464532,
        "preId": 474005,
        "cursorDirection": "pre",
        "dataList": [
            {
                "id": 474005,
                "jobUuid": "118c38ac-c18c-479a-9042-156d46c9a988",
                "status": "stopped",
                "taskName": "task/start",
                "robotUuid": "9c9021d3-42df-4901-9901-9c58340a480c",
                "robotName": "等待-5s",
                "triggerTime": "2023-08-24 17:24:31",
                "robotClientUuid": "cfcc5904-2e82-4295-911c-0ce65c9099f2"
            },
            {
                "id": 464532,
                "jobUuid": "e574c1be-f45f-4bbf-b29f-151271ad6924",
                "status": "error",
                "taskName": "异常应用",
                "robotUuid": "b6519b7e-0b67-4d5a-801e-15e19a7fda1d",
                "robotName": "等待五秒应用",
                "triggerTime": "2023-03-08 21:26:12",
                "robotClientUuid": "a1c19a2c-d9f3-4f77-a6f3-000d79d07db2"
            }
        ]
    },
    "code": 200,
    "success": true
}

エラーが発生した場合は、こちらを参照してください:ステータスコードの説明

OpenAPIの記事一覧ページの先頭へ ↑