Suggest Edits

Jobs Requests

 

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 2 were returned as only one job was found that was executed on the Robot with the 273842 Id.

GET
https://platform.uipath.com/Docs/Docs/odata/Jobs?$top=3&$filter=Robot/Id eq 273842

Headers

Key
Value
Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt 6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
X-UIPATH-OrganizationUnitId
36886

Request


      

    

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/Docs/Docs/odata/$metadata#Jobs",
  "@odata.count": 2,
  "value": [
    {
      "Key": "4256be4e-4de7-49c9-9030-0f31063a234c",
      "StartTime": "2020-03-25T17:36:22.277Z",
      "EndTime": "2020-03-25T17:36:30.247Z",
      "State": "Successful",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "d1b7d60c-951a-4789-8537-b6a0ba620ceb",
      "Info": "Job completed",
      "CreationTime": "2020-03-25T17:36:21.587Z",
      "StartingScheduleId": null,
      "ReleaseName": "OrchestratorHelloWorld_BLA",
      "Type": "Unattended",
      "InputArguments": null,
      "OutputArguments": "{}",
      "HostMachineName": "BOBOMADALINA",
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": null,
      "RuntimeType": "Unattended",
      "RequiresUserInteraction": true,
      "ReleaseVersionId": 539565,
      "EntryPointPath": null,
      "Id": 22405775
    },
    {
      "Key": "4d5c441f-9dfc-49bf-8d8c-bb205d56fc72",
      "StartTime": "2020-03-26T17:33:29.713Z",
      "EndTime": "2020-03-26T17:33:34.58Z",
      "State": "Successful",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "ef627ac5-3585-4c36-bc27-9a27617b4025",
      "Info": "Job completed",
      "CreationTime": "2020-03-26T17:33:28.697Z",
      "StartingScheduleId": null,
      "ReleaseName": "OrchestratorHelloWorld_BLA",
      "Type": "Unattended",
      "InputArguments": null,
      "OutputArguments": "{}",
      "HostMachineName": "BOBOMADALINA",
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": null,
      "RuntimeType": "Unattended",
      "RequiresUserInteraction": true,
      "ReleaseVersionId": 539565,
      "EntryPointPath": null,
      "Id": 22427134
    }
  ]
}
      

According to the Robot Name

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://platform.uipath.com/Docs/Docs/odata/Jobs?$top=10&$filter=Robot/Name eq 'DocBot'

Headers

Key
Value
Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt 6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
X-UIPATH-OrganizationUnitId
36886

Request


      

    

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/Docs/Docs/odata/$metadata#Jobs",
  "@odata.count": 1,
  "value": [
    {
      "Key": "16ec142d-d49e-4965-8b93-be08018b7f40",
      "StartTime": "2020-03-25T17:13:29.85Z",
      "EndTime": "2020-03-25T17:13:29.85Z",
      "State": "Stopped",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "20c36875-bf6e-4425-a59a-cbb0b1ebae30",
      "Info": null,
      "CreationTime": "2020-03-25T17:12:35.327Z",
      "StartingScheduleId": null,
      "ReleaseName": "OrchestratorHelloWorld_BLA",
      "Type": "Unattended",
      "InputArguments": null,
      "OutputArguments": null,
      "HostMachineName": null,
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": "SoftStop",
      "RuntimeType": null,
      "RequiresUserInteraction": true,
      "ReleaseVersionId": null,
      "EntryPointPath": null,
      "Id": 22405480
    }
  ]
}
      

According to a Specific Robot Id, with a Specific State

The following example looks for the first 10 jobs that were processed by a Robot with the 273842 Id and are in the Successful state. As you can see, only two results were returned.

GET
https://platform.uipath.com/Docs/Docs/odata/Jobs?$top=10&$filter=Robot/Id eq 273842 and State eq 'Successful'

Headers

Key
Value
Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt 6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
X-UIPATH-OrganizationUnitId
36886

Request


      

    

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/Docs/Docs/odata/$metadata#Jobs",
  "@odata.count": 2,
  "value": [
    {
      "Key": "4256be4e-4de7-49c9-9030-0f31063a234c",
      "StartTime": "2020-03-25T17:36:22.277Z",
      "EndTime": "2020-03-25T17:36:30.247Z",
      "State": "Successful",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "d1b7d60c-951a-4789-8537-b6a0ba620ceb",
      "Info": "Job completed",
      "CreationTime": "2020-03-25T17:36:21.587Z",
      "StartingScheduleId": null,
      "ReleaseName": "OrchestratorHelloWorld_BLA",
      "Type": "Unattended",
      "InputArguments": null,
      "OutputArguments": "{}",
      "HostMachineName": "BOBOMADALINA",
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": null,
      "RuntimeType": "Unattended",
      "RequiresUserInteraction": true,
      "ReleaseVersionId": 539565,
      "EntryPointPath": null,
      "Id": 22405775
    },
    {
      "Key": "4d5c441f-9dfc-49bf-8d8c-bb205d56fc72",
      "StartTime": "2020-03-26T17:33:29.713Z",
      "EndTime": "2020-03-26T17:33:34.58Z",
      "State": "Successful",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "ef627ac5-3585-4c36-bc27-9a27617b4025",
      "Info": "Job completed",
      "CreationTime": "2020-03-26T17:33:28.697Z",
      "StartingScheduleId": null,
      "ReleaseName": "OrchestratorHelloWorld_BLA",
      "Type": "Unattended",
      "InputArguments": null,
      "OutputArguments": "{}",
      "HostMachineName": "BOBOMADALINA",
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": null,
      "RuntimeType": "Unattended",
      "RequiresUserInteraction": true,
      "ReleaseVersionId": 539565,
      "EntryPointPath": null,
      "Id": 22427134
    }
  ]
}
      

According to Robot Id and End Date

The example below enables you to look for the first 10 jobs that were executed by the Robot with the 273842 Id and finished running after the 26th of March 2020, 10:00:00.837. Since only 1 job matched all these parameters, only that was returned in the Response section.

GET
https://platform.uipath.com/odata/Jobs?$top=10&$filter=Robot/Id eq 273842 and EndTime lt 2020-03-26T10:00:00.837Z

Headers

Key
Value
Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt 6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
X-UIPATH-OrganizationUnitId
36886

Request


      

    

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/Documentatioon/Documentation/odata/$metadata#Jobs",
  "@odata.count": 1,
  "value": [
    {
      "Key": "4256be4e-4de7-49c9-9030-0f31063a234c",
      "StartTime": "2020-03-25T17:36:22.277Z",
      "EndTime": "2020-03-25T17:36:30.247Z",
      "State": "Successful",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "d1b7d60c-951a-4789-8537-b6a0ba620ceb",
      "Info": "Job completed",
      "CreationTime": "2020-03-25T17:36:21.587Z",
      "StartingScheduleId": null,
      "ReleaseName": "OrchestratorHelloWorld_BLA",
      "Type": "Unattended",
      "InputArguments": null,
      "OutputArguments": "{}",
      "HostMachineName": "BOBOMADALINA",
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": null,
      "RuntimeType": "Unattended",
      "RequiresUserInteraction": true,
      "ReleaseVersionId": 539565,
      "EntryPointPath": null,
      "Id": 22405775
    }
  ]
}
      

Starting a Job

The following request enables you to start the execution of the indicated process (through the ReleaseKey parameter) dynamically - on any associated available Robot or Robots 3 times. The later information is sent through the JobsCount parameter. As a response, we receive all the created jobs and their statuses.

POST
https://platform.uipath.com/Docs/Docs/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

Headers

Key
Value
Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt 6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
X-UIPATH-OrganizationUnitId
36886

Request

Content-Type: application/json
{
	"startInfo": {
		"ReleaseKey": "a86e1dfc-d617-4ee9-8b20-f2cdd0feaaaf",
		"RobotIds": [],
		"JobsCount": "3",
		"JobPriority": "Normal",
		"Strategy": "JobsCount",
		"InputArguments": "{}"
	}
}
      

Response

Content-Type: application/json
{
	"@odata.context": "https://platform.uipath.com/Docs/Docs/odata/$metadata#Jobs",
	"value": [{
		"Key": "8e2e4d78-5980-4bba-939c-4aba00edbe3d",
		"StartTime": null,
		"EndTime": null,
		"State": "Pending",
		"JobPriority": "Normal",
		"Source": "Manual",
		"SourceType": "Manual",
		"BatchExecutionKey": "fa41e327-b557-4320-8595-9d8084ad0249",
		"Info": null,
		"CreationTime": "2020-03-26T18:01:44.133Z",
		"StartingScheduleId": null,
		"ReleaseName": "OrchestratorHelloWorld_BLA",
		"Type": "Unattended",
		"InputArguments": null,
		"OutputArguments": null,
		"HostMachineName": null,
		"HasMediaRecorded": false,
		"PersistenceId": null,
		"ResumeVersion": null,
		"StopStrategy": null,
		"RuntimeType": null,
		"RequiresUserInteraction": true,
		"ReleaseVersionId": null,
		"EntryPointPath": null,
		"Id": 22427656
	}, {
		"Key": "1c5de166-af48-4a01-b28d-6875311c761b",
		"StartTime": null,
		"EndTime": null,
		"State": "Pending",
		"JobPriority": "Normal",
		"Source": "Manual",
		"SourceType": "Manual",
		"BatchExecutionKey": "fa41e327-b557-4320-8595-9d8084ad0249",
		"Info": null,
		"CreationTime": "2020-03-26T18:01:44.133Z",
		"StartingScheduleId": null,
		"ReleaseName": "OrchestratorHelloWorld_BLA",
		"Type": "Unattended",
		"InputArguments": null,
		"OutputArguments": null,
		"HostMachineName": null,
		"HasMediaRecorded": false,
		"PersistenceId": null,
		"ResumeVersion": null,
		"StopStrategy": null,
		"RuntimeType": null,
		"RequiresUserInteraction": true,
		"ReleaseVersionId": null,
		"EntryPointPath": null,
		"Id": 22427657
	}, {
		"Key": "72e212cb-747b-42e8-882a-528ce8ed517f",
		"StartTime": null,
		"EndTime": null,
		"State": "Pending",
		"JobPriority": "Normal",
		"Source": "Manual",
		"SourceType": "Manual",
		"BatchExecutionKey": "fa41e327-b557-4320-8595-9d8084ad0249",
		"Info": null,
		"CreationTime": "2020-03-26T18:01:44.133Z",
		"StartingScheduleId": null,
		"ReleaseName": "OrchestratorHelloWorld_BLA",
		"Type": "Unattended",
		"InputArguments": null,
		"OutputArguments": null,
		"HostMachineName": null,
		"HasMediaRecorded": false,
		"PersistenceId": null,
		"ResumeVersion": null,
		"StopStrategy": null,
		"RuntimeType": null,
		"RequiresUserInteraction": true,
		"ReleaseVersionId": null,
		"EntryPointPath": null,
		"Id": 22427658
	}]
}
      

Starting a Job with Custom Values for Input Parameters

The following POST request to the /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.

Important!

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.

If you provide values for integer input parameters when making start job API calls which are also valid ASCII values, please note that they are changed. For example, 0065 becomes 53.

POST
https://platform.uipath.com/Docs/Docs/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

Headers

Key
Value
Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt 6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
X-UIPATH-OrganizationUnitId
36886

Request

Content-Type: application/json
{
	"startInfo": {
		"ReleaseKey": "a86e1dfc-d617-4ee9-8b20-f2cdd0feaaaf",
		"RobotIds": [273842],
		"JobsCount": 0,
		"Strategy": "Specific",
		"InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
	}
}
      

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/Docs/Docs/odata/$metadata#Jobs",
  "value": [
    {
      "Key": "6609fe4f-9a2b-47bc-b972-ac0ed874da9a",
      "StartTime": null,
      "EndTime": null,
      "State": "Pending",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "03584839-3088-4159-8f8c-83fe12091349",
      "Info": null,
      "CreationTime": "2020-03-26T18:09:03.4973446Z",
      "StartingScheduleId": null,
      "ReleaseName": "OrchestratorHelloWorld_BLA",
      "Type": "Unattended",
      "InputArguments": "{\"age\":33,\"trueOrFalse\":false,\"stringNew\":\"testing\"}",
      "OutputArguments": null,
      "HostMachineName": null,
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": null,
      "RuntimeType": null,
      "RequiresUserInteraction": true,
      "ReleaseVersionId": null,
      "EntryPointPath": null,
      "Id": 22427750
    }
  ]
}
      

Retrieving Jobs that were Executed by an Indicated Environment

The following example enables us to get the first two jobs that were executed by Robots that are part of the environment with the 177564 Id and expands the process information.

GET
https://platform.uipath.com/Docs/Docs/odata/Jobs?$expand=Release&$filter=Release%2FEnvironmentId%20eq%20177564&$top=2

Headers

Key
Value
Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt 6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
X-UIPATH-OrganizationUnitId
36886

Request


      

    

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/Docs/Docs/odata/$metadata#Jobs",
  "@odata.count": 11,
  "value": [
    {
      "Key": "7e32f8c2-a457-4dc2-9f70-ecb74236e21b",
      "StartTime": "2020-03-02T11:20:23.673Z",
      "EndTime": "2020-03-02T11:20:23.673Z",
      "State": "Stopped",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "2019f25b-090a-462b-b29c-64befd863e5a",
      "Info": null,
      "CreationTime": "2020-03-02T10:59:53.78Z",
      "StartingScheduleId": null,
      "ReleaseName": "SystemActivities_BLA",
      "Type": "Unattended",
      "InputArguments": null,
      "OutputArguments": null,
      "HostMachineName": null,
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": "SoftStop",
      "RuntimeType": null,
      "RequiresUserInteraction": true,
      "ReleaseVersionId": null,
      "EntryPointPath": null,
      "Id": 21544381,
      "Release": {
        "Key": "46bd7f94-b77e-44ef-92dc-d2f0d1bd1512",
        "ProcessKey": "SystemActivities",
        "ProcessVersion": "",
        "IsLatestVersion": false,
        "IsProcessDeleted": false,
        "Description": "",
        "Name": "SystemActivities_BLA",
        "EnvironmentId": 177564,
        "EnvironmentName": null,
        "InputArguments": null,
        "ProcessType": "BusinessProcess",
        "SupportsMultipleEntryPoints": false,
        "RequiresUserInteraction": true,
        "AutoUpdate": false,
        "_FeedId": "00000000-0000-0000-0000-000000000000",
        "JobPriority": "Normal",
        "Id": 309517,
        "Arguments": null,
        "ProcessSettings": null
      }
    },
    {
      "Key": "16ec142d-d49e-4965-8b93-be08018b7f40",
      "StartTime": "2020-03-25T17:13:29.85Z",
      "EndTime": "2020-03-25T17:13:29.85Z",
      "State": "Stopped",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "20c36875-bf6e-4425-a59a-cbb0b1ebae30",
      "Info": null,
      "CreationTime": "2020-03-25T17:12:35.327Z",
      "StartingScheduleId": null,
      "ReleaseName": "OrchestratorHelloWorld_BLA",
      "Type": "Unattended",
      "InputArguments": null,
      "OutputArguments": null,
      "HostMachineName": null,
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": "SoftStop",
      "RuntimeType": null,
      "RequiresUserInteraction": true,
      "ReleaseVersionId": null,
      "EntryPointPath": null,
      "Id": 22405480,
      "Release": {
        "Key": "a86e1dfc-d617-4ee9-8b20-f2cdd0feaaaf",
        "ProcessKey": "OrchestratorHelloWorld",
        "ProcessVersion": "",
        "IsLatestVersion": false,
        "IsProcessDeleted": false,
        "Description": "",
        "Name": "OrchestratorHelloWorld_BLA",
        "EnvironmentId": 177564,
        "EnvironmentName": null,
        "InputArguments": null,
        "ProcessType": "Undefined",
        "SupportsMultipleEntryPoints": false,
        "RequiresUserInteraction": true,
        "AutoUpdate": false,
        "_FeedId": "00000000-0000-0000-0000-000000000000",
        "JobPriority": "Normal",
        "Id": 308022,
        "Arguments": null,
        "ProcessSettings": null
      }
    }
  ]
}
      

Retrieving Faulted Jobs According to Errors

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://platform.uipath.com/Docs/Docs/odata/Jobs?$filter=(CreationTime gt 2020-03-25T00: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

Headers

Key
Value
Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt 6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
X-UIPATH-OrganizationUnitId
36886

Request


      

    

Response

Content-Type: application/json
{
  "@odata.context": "https://platform.uipath.com/Docs/Docs/odata/$metadata#Jobs",
  "@odata.count": 13,
  "value": [
    {
      "Key": "7e32f8c2-a457-4dc2-9f70-ecb74236e21b",
      "StartTime": "2020-03-02T11:20:23.673Z",
      "EndTime": "2020-03-02T11:20:23.673Z",
      "State": "Faulted",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "2019f25b-090a-462b-b29c-64befd863e5a",
      "Info": "Logon failure: unknown user name or bad password",
      "CreationTime": "2020-03-02T10:59:53.78Z",
      "StartingScheduleId": null,
      "ReleaseName": "SystemActivities_BLA",
      "Type": "Unattended",
      "InputArguments": null,
      "OutputArguments": null,
      "HostMachineName": null,
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": "SoftStop",
      "RuntimeType": null,
      "RequiresUserInteraction": true,
      "ReleaseVersionId": null,
      "EntryPointPath": null,
      "Id": 21544381,
      "Release": {
        "Key": "46bd7f94-b77e-44ef-92dc-d2f0d1bd1512",
        "ProcessKey": "SystemActivities",
        "ProcessVersion": "",
        "IsLatestVersion": false,
        "IsProcessDeleted": false,
        "Description": "",
        "Name": "SystemActivities_BLA",
        "EnvironmentId": 177564,
        "EnvironmentName": null,
        "InputArguments": null,
        "ProcessType": "BusinessProcess",
        "SupportsMultipleEntryPoints": false,
        "RequiresUserInteraction": true,
        "AutoUpdate": false,
        "_FeedId": "00000000-0000-0000-0000-000000000000",
        "JobPriority": "Normal",
        "Id": 309517,
        "Arguments": null,
        "ProcessSettings": null
      },
      "Robot": null
    },
    {
      "Key": "16ec142d-d49e-4965-8b93-be08018b7f40",
      "StartTime": "2020-03-25T17:13:29.85Z",
      "EndTime": "2020-03-25T17:13:29.85Z",
      "State": "Faulted",
      "JobPriority": "Normal",
      "Source": "Manual",
      "SourceType": "Manual",
      "BatchExecutionKey": "20c36875-bf6e-4425-a59a-cbb0b1ebae30",
      "Info": "Logon failure: unknown user name or bad password",
      "CreationTime": "2020-03-25T17:12:35.327Z",
      "StartingScheduleId": null,
      "ReleaseName": "OrchestratorHelloWorld_BLA",
      "Type": "Unattended",
      "InputArguments": null,
      "OutputArguments": null,
      "HostMachineName": null,
      "HasMediaRecorded": false,
      "PersistenceId": null,
      "ResumeVersion": null,
      "StopStrategy": "SoftStop",
      "RuntimeType": null,
      "RequiresUserInteraction": true,
      "ReleaseVersionId": null,
      "EntryPointPath": null,
      "Id": 22405480,
      "Release": {
        "Key": "a86e1dfc-d617-4ee9-8b20-f2cdd0feaaaf",
        "ProcessKey": "OrchestratorHelloWorld",
        "ProcessVersion": "",
        "IsLatestVersion": false,
        "IsProcessDeleted": false,
        "Description": "",
        "Name": "OrchestratorHelloWorld_BLA",
        "EnvironmentId": 177564,
        "EnvironmentName": null,
        "InputArguments": null,
        "ProcessType": "Undefined",
        "SupportsMultipleEntryPoints": false,
        "RequiresUserInteraction": true,
        "AutoUpdate": false,
        "_FeedId": "00000000-0000-0000-0000-000000000000",
        "JobPriority": "Normal",
        "Id": 308022,
        "Arguments": null,
        "ProcessSettings": null
      },
      "Robot": {
        "LicenseKey": null,
        "MachineName": "MaMachine",
        "MachineId": 255152,
        "Name": "DocBot",
        "Username": "uipath\\madalina.boboc",
        "ExternalName": null,
        "Description": null,
        "Version": null,
        "Type": "Unattended",
        "HostingType": "Standard",
        "ProvisionType": "Manual",
        "Password": null,
        "CredentialStoreId": null,
        "UserId": null,
        "CredentialType": null,
        "RobotEnvironments": "",
        "IsExternalLicensed": false,
        "Id": 273836,
        "ExecutionSettings": null
      }
    }
  ]
}
      

Stopping Multiple Jobs

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

Note:

The strategy parameter can be populated with the following values:

  • SoftStop or 1
  • Kill or 2.
POST
https://platform.uipath.com/Docs/Docs/odata/Jobs/UiPath.Server.Configuration.OData.StopJobs

Headers

Key
Value
Authorization
Bearer zyRELz1KeWURamr0dB-rila5lDgrkN-Cnbft7f3o5e7KfmjOW4xBRQeqdK7JgTof6hE0x_vGgS55ydlSl4799MWPtDY_pPFRcV1cWrpaj7zDwrtxt_mTFYRsyFjUpzgdBoXmIJ527b7bOZqA5rtER_ccPwjLY5KRdzyQD2BSOjanqDZj7mODpflaz5i6m3oWQRwL29SgceGytn5-nV8-g1Irt1ly7ApmTQavM2c1OCgZeWCD_UgwcNglLx5IB8hmGvqGJB4OVNGjRwB_-4KHcCE1OZrEa21oQdw6U4VrtRIoMOTFmdfb7OdLKb44uD1PuNt 6NAHEf1c6HDI8z2Vh69cvZdJY8hmRejGnnWih2dK7GFWYN5mqyJPodlq6E0JqyRcCnx3JkdnJ0Opgf4PAAGU9aDeLZIAwCPyWMeWnkfG3fxUYL5aSxrltVuIGf8TRQuF7roW2g1s0Ur4XeP-zZJJvXk0JgE1GzW7UQsUp00zTSsiaDXzV8jMd95puxczbJswofLp_f2AF5bLK9ypbHO5fQzUSFb_4EQFgdfwwveE
X-UIPATH-OrganizationUnitId
36886

Request

Content-Type: application/json
{
	"jobIds": [22450719, 22450728],
	"strategy": "1"
}
      

Response


      
200 OK