Start Process

POST {{cloudUrl}}/{{cloudOrg}}/{{cloudTenant}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

Within Orchestrator, a Process that is running or has been run is called a Job. To start a Job you need to hand over at least the following request body input parameters:

1. ReleaseKey: The ID you get in the previous step GET Releases by name. The Orchestator needs this key to run a specific version of a process.
2. Strategy: For modern folders we recommend to make use of ModernJobsCount.
3. JobsCount: How often the job will be executed.
4. InputArguments: If your job has input parameters, they can be sent as a JSON string in the InputArguments field. If it does not, this field will be ignored. See how input arguments are handed over in the next example.

Find more details on how to start of job here.

Request Body

{"startInfo"=>{"ReleaseKey"=>"{{releaseKey}}", "Strategy"=>"ModernJobsCount", "JobsCount"=>1, "InputArguments"=>"{\"InventoryData\":[{\"Product ID\":\"FUR-FU-10002874\",\"Measure Names\":\"Sales Forecast\",\"Measure Values\":\"$96\"},{\"Product ID\":\"FUR-FU-10002874\",\"Measure Names\":\"Quantity\",\"Measure Values\":\"2\"}]}"}}

HEADERS

RESPONSES

status: Created

{"@odata.context":"https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Jobs","value":[{"Key":"b07ac1db-13d6-46b7-baf5-51a97ef20946","StartTime":null,"EndTime":null,"State":"Pending","JobPriority":"Normal","Source":"Manual","SourceType":"Manual","BatchExecutionKey":"65bbd1da-623b-4d72-99db-42e70dcb7e52","Info":null,"CreationTime":"2021-03-31T12:54:16.023Z","StartingScheduleId":null,"ReleaseName":"Add a pet to pet store by queue item","Type":"Unattended","InputArguments":null,"OutputArguments":null,"HostMachineName":null,"HasMediaRecorded":false,"PersistenceId":null,"ResumeVersion":null,"StopStrategy":null,"RuntimeType":"Unattended","RequiresUserInteraction":true,"ReleaseVersionId":null,"EntryPointPath":null,"OrganizationUnitId":515128,"OrganizationUnitFullyQualifiedName":null,"Reference":"","ProcessType":"Process","Id":12764613}]}