- Getting Started
- Swagger Definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Personal Workspaces Requests
- Processes Requests
- Process Data Retention Policy Requests
- Queue Items Requests
- Queue Retention Policy Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Storage Bucket Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
Jobs Requests
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://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=3&$filter=Robot/Id eq 749
Request headers
Key |
Value |
---|---|
Authorization |
Bearer |
Response code
200 OK
Response body
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
]
}
This call requests all top 10 jobs that were executed by a Robot with the "DocBot" name, but only 1 was returned as only one job was found.
GET
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=10&$filter=Robot/Name eq 'DocBot'
Request headers
Key |
Value |
---|---|
Authorization |
Bearer |
Response code
200 OK
Response body
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
]
}
The following example looks for the first 10 jobs that were processed by a Robot with the 749 Id and are in the Successful state. As you can see, only two results were returned.
GET
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=10&$filter=Robot/Id eq 749 and State eq 'Successful'
Request headers
Key |
Value |
---|---|
Authorization |
Bearer |
Response code
200 OK
Response body
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/$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
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/$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
}
]
}
The example below enables you to look for the first 10 jobs that were executed by the Robot with the 759 Id and finished running after the 22nd of February 2018, 10:00:00.837. Since only three jobs matched all these parameters, only those were returned in the Response section.
GET
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=10&$filter=Robot/Id eq 759 and EndTime lt 2018-02-22T10:00:00.837Z
Request headers
Key |
Value |
---|---|
Authorization |
Bearer |
Response code
200 OK
Response body
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
]
}
The following query searches for the top 10 jobs that were executed by a Robot with the 749 Id, starting with the 22nd of September 2017, 09:59:22.837.
GET
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=10&$filter=Robot/Id eq 749 and State eq 'Successful'
Request headers
Key |
Value |
---|---|
Authorization |
Bearer |
Response code
200 OK
Response body
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/$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
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/$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
}
]
}
The following request enables you to start the execution of the indicated process (through the ReleaseKey parameter), on all the available Robots that are in the associated environment.
POST
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
{
"startInfo": {
"ReleaseKey": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
"Strategy": "All",
"RobotIds": [],
"NoOfRobots": 0
}
}
{
"startInfo": {
"ReleaseKey": "795cbab2-8008-4a54-b1cb-f9ff1ece139e",
"Strategy": "All",
"RobotIds": [],
"NoOfRobots": 0
}
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
endpoint enables you to add custom values for input parameters while also starting a job on a specific Robot.
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.
0065
becomes 53
.
POST
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
{
"startInfo": {
"ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
"RobotIds": [121],
"JobsCount": 0,
"Strategy": "Specific",
"InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
}
}
{
"startInfo": {
"ReleaseKey": "429cf1cc-283c-424f-a935-43f72c2ca719",
"RobotIds": [121],
"JobsCount": 0,
"Strategy": "Specific",
"InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
}
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
]
}
The following example enables us to get the first two jobs that were executed by Robots that are part of the environment with the 312 Id and expand the process information.
GET
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Jobs?$top=2&$expand=Release&$filter=Release/EnvironmentId eq 312
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
}
]
}
{
"@odata.context": "https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/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
}
}
]
}
The request below enables us to forcefully stop (kill) two jobs.
strategy
parameter can be populated with the following values:
SoftStop
or1
Kill
or2
.
POST
https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StopJobs
{
"jobIds": [22450719, 22450728],
"strategy": "1"
}
{
"jobIds": [22450719, 22450728],
"strategy": "1"
}
- Requesting Jobs Started By a Specific Robot
- According to the Robot Id
- According to the Robot Name
- According to a Specific Robot Id, With a Specific State
- According to Robot Id and End Date
- According to Start Date and Robot Id
- Starting a Job
- Request headers
- Request body
- Response code
- Response body
- Starting a Job With Custom Values for Input Parameters
- Request headers
- Request body
- Response code
- Response body
- Retrieving Jobs That Were Executed by an Indicated Environment
- Request headers
- Response code
- Response body
- Retrieving Faulted Jobs According to Errors
- Request headers
- Response code
- Response body
- Stopping Multiple Jobs
- Request headers
- Request body
- Response code
- Exporting jobs