ジョブの要求

Requesting Jobs Started By a Specific Robot

According to the Robot Id

As you can see in the example below, we requested the top 3 jobs, but only 1 was returned as only one job was found that was ran on the Robot with the 749 Id.

GET

https://{yourDomain}/odata/Jobs?$top=3&$filter=Robot/Id eq 749

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
    "@odata.count": 13,
    "value": [
        {
            "Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
            "StartTime": "2018-01-15T18:18:02.79Z",
            "EndTime": "2018-01-15T18:18:47.587Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:18:01.623Z",
            "StartingScheduleId": null,
            "Id": 125161
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        },
        {
            "Key": "e29e472d-5d51-4369-9c15-af867e6dd580",
            "StartTime": "2018-03-05T18:27:27.123Z",
            "EndTime": "2018-03-05T18:27:38.593Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "ad498d35-326c-4c6c-89d0-16fb73abd0c8",
            "Info": "Execution error : System.ArgumentException: The sheet does not exist\r\n   at UiPath.Excel.WorkbookApplication.SetSheet(String sheetName, Boolean createNew)\r\n   at UiPath.Excel.Activities.ExcelInteropActivity`1.BeginExecute(AsyncCodeActivityContext context, AsyncCallback callback, Object state)\r\n   at System.Activities.AsyncCodeActivity.InternalExecute(ActivityInstance instance, ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n   at System.Activities.ActivityInstance.Execute(ActivityExecutor executor, BookmarkManager bookmarkManager)\r\n   at System.Activities.Runtime.ActivityExecutor.ExecuteActivityWorkItem.ExecuteBody(ActivityExecutor executor, BookmarkManager bookmarkManager, Location resultLocation)",
            "CreationTime": "2018-03-05T18:27:25.793Z",
            "StartingScheduleId": null,
            "Id": 127416
        }
    ]
}

According to the Robot Name

この呼び出しは、「DocBot」という名前のロボットによって実行された上位 10 個のジョブをすべて要求しますが、見つかったジョブは 1 つだけなので、返されるジョブは 1 つだけです。

GET

https://{yourDomain}/odata/Jobs?$top=10&$filter=Robot/Name eq 'DocBot'

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
    "@odata.count": 1,
    "value": [
        {
            "Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
            "StartTime": "2018-01-15T18:18:02.79Z",
            "EndTime": "2018-01-15T18:18:47.587Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:18:01.623Z",
            "StartingScheduleId": null,
            "Id": 125161
        }
    ]
}

特定のロボット ID に従って特定のステートで要求する

以下の例では、ID が 749 のロボットによって処理され、ステータスが [成功] である最初の 10 個のジョブを検索します。ご覧のように、返された結果は 2 つだけです。

GET

https://{yourDomain}/odata/Jobs?$top=10&$filter=Robot/Id eq 749 and State eq 'Successful'

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "https://{yourDomain}/$metadata#Jobs",
    "@odata.count": 2,
    "value": [
        {
            "Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
            "StartTime": "2018-01-15T18:18:02.79Z",
            "EndTime": "2018-01-15T18:18:47.587Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:18:01.623Z",
            "StartingScheduleId": null,
            "Id": 125161
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        }
    ]
}

ロボット ID と終了日に従って要求する

以下の例では、ID が 759 のロボットによって実行され、2018 年 2 月 22 日 10:00:00.837 より後に実行が完了した最初の 10 個のジョブを検索できます。これらのパラメーターすべてに一致したジョブは 3 つだけであるため、それらのジョブだけが応答セクションで返されます。

GET

https://{yourDomain}/odata/Jobs?$top=10&$filter=Robot/Id eq 759 and EndTime lt 2018-02-22T10:00:00.837Z

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
    "@odata.count": 3,
    "value": [
        {
            "Key": "45383b6c-a547-49e1-be5c-f3bb6d78982c",
            "StartTime": "2018-01-15T18:17:14.693Z",
            "EndTime": "2018-01-15T18:17:14.693Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "9eda64eb-3ab8-46e8-833d-fe944a4eb25e",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:17:13.59Z",
            "StartingScheduleId": null,
            "Id": 125160
        },
        {
            "Key": "4b018719-36cb-43a1-8096-202641ccee62",
            "StartTime": "2018-01-15T18:19:03.177Z",
            "EndTime": "2018-01-15T18:19:03.177Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "7a60ce9d-a5a6-4e9f-b908-ab5819b016c2",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:19:02.37Z",
            "StartingScheduleId": null,
            "Id": 125162
        },
        {
            "Key": "4420820e-7b0a-49a3-a172-ddcc1d88ace9",
            "StartTime": "2018-01-15T18:20:07.93Z",
            "EndTime": "2018-01-15T18:20:22.68Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "843d9f41-ae7b-4a28-bd32-d57006f90a2f",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:20:06.733Z",
            "StartingScheduleId": null,
            "Id": 125163
        }
    ]
}

開始日とロボット ID に従って要求する

以下のクエリは、2017 年 9 月 22 日 09:59:22.837 以降に ID が 749 のロボットによって実行された上位 10 個のジョブを検索します。

GET

https://{yourDomain}/odata/Jobs?$top=10&$filter=Robot/Id eq 749 and State eq 'Successful'

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "https://{yourDomain}/$metadata#Jobs",
    "@odata.count": 2,
    "value": [
        {
            "Key": "1c7222dc-416f-4c60-9b17-88262c91768f",
            "StartTime": "2018-01-15T18:18:02.79Z",
            "EndTime": "2018-01-15T18:18:47.587Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "8c5302a7-8ed3-458a-ab64-34cc72fdd709",
            "Info": "Job completed",
            "CreationTime": "2018-01-15T18:18:01.623Z",
            "StartingScheduleId": null,
            "Id": 125161
        },
        {
            "Key": "9fbdfca0-d1e5-41c2-abe6-86fe626346a3",
            "StartTime": "2018-03-02T17:25:35.17Z",
            "EndTime": "2018-03-02T17:25:46.62Z",
            "State": "Successful",
            "Source": "Manual",
            "BatchExecutionKey": "9b908e73-b564-4022-92cb-9e9f0571c2ec",
            "Info": "Job completed",
            "CreationTime": "2018-03-02T17:25:34.087Z",
            "StartingScheduleId": null,
            "Id": 127283
        }
    ]
}

ジョブを開始する

以下の要求では、指定したプロセス (ReleaseKey パラメーターを使用) の実行を、関連するロボット グループで利用可能なすべてのロボット上で開始できます。

注: All ストラテジはモダン フォルダーには適用できません。

POST

https://{yourDomain}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

{
  "startInfo": {
    "ReleaseKey": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
    "Strategy": "All",
    "RobotIds": [],
    "NoOfRobots": 0
  }
}

応答コード

200 OK

応答本文

{
  "@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
  "value": [
    {
      "Key": "31ade17f-5a35-4250-beea-43922dc2a20d",
      "StartTime": null,
      "EndTime": null,
      "State": "Pending",
      "Source": "Manual",
      "BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
      "Info": null,
      "CreationTime": "2018-03-19T19:01:58.6806126Z",
      "StartingScheduleId": null,
      "Id": 128209
    },
    {
      "Key": "c4caf051-9db6-486d-8078-231f9dec1a4c",
      "StartTime": null,
      "EndTime": null,
      "State": "Pending",
      "Source": "Manual",
      "BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
      "Info": null,
      "CreationTime": "2018-03-19T19:01:58.7610094Z",
      "StartingScheduleId": null,
      "Id": 128210
    },
    {
      "Key": "969552ba-cfe5-4e87-adde-c85a358ae96f",
      "StartTime": null,
      "EndTime": null,
      "State": "Pending",
      "Source": "Manual",
      "BatchExecutionKey": "cbaff1c6-32b0-468b-9ad9-b59f9ca1d3b6",
      "Info": null,
      "CreationTime": "2018-03-19T19:01:58.8212679Z",
      "StartingScheduleId": null,
      "Id": 128211
    }
  ]
}

入力パラメーターにカスタム値を使用してジョブを開始する

/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs エンドポイントへの次の POST 要求では、入力パラメーターにカスタム値を追加すると同時に、特定のロボットでジョブを開始できます。

注:

Please note that a maximum of 10,000 characters is accepted for the entire length of the JSON representation of input parameters, including argument names, all the escaped characters, spaces, brackets, and arguments values.

有効な ASCII 値でもあるジョブ開始の API 呼び出しを行う際に、整数の入力パラメーターの値を設定すると、値が変更されます。たとえば、0065 は 53 になります。

POST

https://{yourDomain}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

{
    "startInfo": {
        "ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
        "RobotIds": [121],
        "JobsCount": 0,
        "Strategy": "Specific",
        "InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
    }
}

応答コード

200 OK

応答本文

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
    "value": [
        {
            "Key": "0fbdbecb-3677-4c33-a491-a1f7ed4ff886",
            "StartTime": null,
            "EndTime": null,
            "State": "Pending",
            "Source": "Manual",
            "SourceType": "Manual",
            "BatchExecutionKey": "e188f409-c504-47b7-b2cf-30b8fe423f87",
            "Info": null,
            "CreationTime": "2018-08-27T16:41:00.4773869Z",
            "StartingScheduleId": null,
            "ReleaseName": "input_output_test_DocEnv",
            "Type": "Unattended",
            "InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}",
            "OutputArguments": null,
            "Id": 21767
        }
    ]
}

指定したロボット グループによって実行されたジョブを取得する

以下の例では、ID が 312 のロボット グループに属するロボットによって実行された最初の 2 つのジョブを取得し、プロセス情報を拡張できます。

GET

https://{yourDomain}/odata/Jobs?$top=2&$expand=Release&$filter=Release/EnvironmentId eq 312

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
    "@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
    "@odata.count": 26,
    "value": [
        {
            "Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
            "StartTime": "2018-01-15T18:03:42.51Z",
            "EndTime": "2018-01-15T18:03:44.353Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:03:41.56Z",
            "StartingScheduleId": null,
            "Id": 125153,
            "Release": {
                "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
                "ProcessKey": "Release_Project",
                "ProcessVersion": "",
                "IsLatestVersion": false,
                "IsProcessDeleted": false,
                "Description": "rockerii",
                "Name": "Release_Project_doc_env",
                "EnvironmentId": 312,
                "EnvironmentName": null,
                "Id": 440
            }
        },
        {
            "Key": "93b0bfc1-cb80-4594-bb3e-9f35f3efc828",
            "StartTime": "2018-01-15T18:05:42.393Z",
            "EndTime": "2018-01-15T18:05:42.393Z",
            "State": "Faulted",
            "Source": "Manual",
            "BatchExecutionKey": "2f894a2b-7ba1-4eee-b399-c67894a9b3ec",
            "Info": "Logon failure: unknown user name or bad password",
            "CreationTime": "2018-01-15T18:05:41.093Z",
            "StartingScheduleId": null,
            "Id": 125154,
            "Release": {
                "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
                "ProcessKey": "Release_Project",
                "ProcessVersion": "",
                "IsLatestVersion": false,
                "IsProcessDeleted": false,
                "Description": "rockerii",
                "Name": "Release_Project_doc_env",
                "EnvironmentId": 312,
                "EnvironmentName": null,
                "Id": 440
            }
        }
    ]
}

エラーに従って失敗したジョブを取得する

The call below helps you display the first 2 jobs that failed with the "Logon failure: unknown user name or bad password" error, and expands the Robot and process details. You can use this query for any kind of error that is displayed in the Job Details window.

GET

https://{yourDomain}/odata/Jobs?$filter=(CreationTime gt 2017-01-01T00:00:00.000Z and State eq '4' and indexof(Info,'Logon failure: unknown user name or bad password') ne -1)&$expand=Robot,Release&$top=2

要求ヘッダー

キー	値 (Value)
認可	Bearer

応答コード

200 OK

応答本文

{
  "@odata.context": "https://{yourDomain}/odata/$metadata#Jobs",
  "@odata.count": 5,
  "value": [
    {
      "Key": "d3780aac-1e80-49b0-bfd3-c8ec6a3939db",
      "StartTime": "2018-01-15T18:03:42.51Z",
      "EndTime": "2018-01-15T18:03:44.353Z",
      "State": "Faulted",
      "Source": "Manual",
      "BatchExecutionKey": "c08beec5-243c-4e08-854d-7c100cd35214",
      "Info": "Logon failure: unknown user name or bad password",
      "CreationTime": "2018-01-15T18:03:41.56Z",
      "StartingScheduleId": null,
      "Id": 125153,
      "Robot": {
        "LicenseKey": null,
        "MachineName": "DESKTOP-PMFQGCB",
        "Name": "RoboDrulea",
        "Username": "ALEX",
        "Description": null,
        "Type": "Unattended",
        "Password": null,
        "RobotEnvironments": "",
        "Id": 758,
        "ExecutionSettings": null
      },
      "Release": {
        "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
        "ProcessKey": "Release_Project",
        "ProcessVersion": "",
        "IsLatestVersion": false,
        "IsProcessDeleted": false,
        "Description": null,
        "Name": "Release_Project_doc_env",
        "EnvironmentId": 312,
        "EnvironmentName": null,
        "Id": 440
      }
    },
    {
      "Key": "93b0bfc1-cb80-4594-bb3e-9f35f3efc828",
      "StartTime": "2018-01-15T18:05:42.393Z",
      "EndTime": "2018-01-15T18:05:42.393Z",
      "State": "Faulted",
      "Source": "Manual",
      "BatchExecutionKey": "2f894a2b-7ba1-4eee-b399-c67894a9b3ec",
      "Info": "Logon failure: unknown user name or bad password",
      "CreationTime": "2018-01-15T18:05:41.093Z",
      "StartingScheduleId": null,
      "Id": 125154,
      "Robot": {
        "LicenseKey": null,
        "MachineName": "DESKTOP-PMFQGCB",
        "Name": "RoboDrulea",
        "Username": "ALEX",
        "Description": null,
        "Type": "Unattended",
        "Password": null,
        "RobotEnvironments": "",
        "Id": 758,
        "ExecutionSettings": null
      },
      "Release": {
        "Key": "766d80d3-cc02-4635-b36c-e30fcf1008b1",
        "ProcessKey": "Release_Project",
        "ProcessVersion": "",
        "IsLatestVersion": false,
        "IsProcessDeleted": false,
        "Description": null,
        "Name": "Release_Project_doc_env",
        "EnvironmentId": 312,
        "EnvironmentName": null,
        "Id": 440
      }
    }
  ]
}

Stopping Multiple Jobs

The request below enables us to forcefully stop (kill) two jobs.

注:

The strategy parameter can be populated with the following values:

• SoftStop または 1
• Kill or 2.

POST

https://{yourDomain}/odata/Jobs/UiPath.Server.Configuration.OData.StopJobs

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

{
    "jobIds": [22450719, 22450728],
    "strategy": "1"
}

応答コード

200 OK

ジョブをエクスポートする

このアクションでは、さまざまなエンドポイントを呼び出す必要があります。

1. エクスポートを開始するには、POST https://{yourDomain}//odata/Jobs/UiPath.Server.Configuration.OData.Export を呼び出します。必要に応じてフィルターを追加します。

   要求本文は次のようになります。

   POST https://{yourDomain}/odata/Jobs/UiPath.Server.Configuration.OData.Export?$top=1000&$expand=Robot,Machine,Release&$orderby=CreationTime%20desc HTTP/1.1
   Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1
   X-Uipath-Organizationunitid: 770643

   応答には、後続の手順で必要な ID が含まれます。

   {"@odata.context":"https://{yourDomain}/odata/$metadata#Exports/$entity","Id":8661,"Name":"jobs-02c0398c-227b-47f4-aade-2252146d7d8f","Type":"Jobs","Status":"New","RequestedAt":"2024-01-15T07:48:34.8805788Z","ExecutedAt":null,"Size":null}

2. GET https://{yourDomain}/orchestrator_/odata/Exports(8661) を呼び出して要求の状態を取得します。角かっこで囲まれたテキストは、手順 1 で返された ID です。

   要求本文は次のようになります。

   GET https://{yourDomain}/odata/Exports(8661) HTTP/1.1
   Host: alpha.uipath.com
   Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1
   X-Uipath-Organizationunitid: 770643
   Cookie: __cf_bm=lxqtVnB6oC_KS1nxJsWcqGK87Up9b5TGUCkZLeoaLP8-1705304914-1-AcpGG76FE03iiFdCw+u2Sq/xV3T38gqfvE7vjjZ5YHs5Iwjmrw1/1DjR5RSlqdQU1ocpukAZ1I0JLAGnkdOnumA=

   応答が完了するまで待ちます。

   {"@odata.context":"https://{yourDomain}/odata/$metadata#Exports/$entity","Id":8661,"Name":"jobs-02c0398c-227b-47f4-aade-2252146d7d8f","Type":"Jobs","Status":"Completed","RequestedAt":"2024-01-15T07:48:34.88Z","ExecutedAt":"2024-01-15T07:48:38.51Z","Size":692}

3. GET https://{yourDomain}/odata/Exports(8661)/UiPath.Server.Configuration.OData.GetDownloadLink を呼び出してダウンロード リンクを取得します。かっこで囲まれたテキストは、手順 1 で返された ID です。

   要求本文は次のようになります。

   GET https://{yourDomain}/odata/Exports(8661)/UiPath.Server.Configuration.OData.GetDownloadLink HTTP/1.1
   Authorization: Bearer rt_45D8A3C5FF2AC56A92A906EE14FB0B8B004D76BAC67AE375521C373F23447684-1
   X-Uipath-Organizationunitid: 770643

   応答には、データの CSV エクスポートを取得するために使用できる URI が含まれています。

   {"@odata.context":"https://{yourDomain}/odata/$metadata#UiPath.Server.Configuration.OData.BlobFileAccessDto","Uri":"<Download URI>","Verb":"GET","RequiresAuth":false,"Headers":{"Keys":[],"Values":[]}}

4. 手順 3 で返された URI に GET 要求を送信します。これにより、CSV エクスポートのダウンロードがトリガーされます。形式と命名規則について詳しくは、ユーザー ガイドの「 エクスポートされたレポート 」をご覧ください。