Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "startInfo": {
// "ReleaseKey": "{{releaseKey}}",
// "Strategy": "ModernJobsCount",
// "JobsCount": 1,
// "InputArguments": "{}"
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("startInfo.ReleaseKey","{{releaseKey}}")
loJson.UpdateString("startInfo.Strategy","ModernJobsCount")
loJson.UpdateInt("startInfo.JobsCount",1)
loJson.UpdateString("startInfo.InputArguments","{}")
loHttp.SetRequestHeader("Content-Type","application/json")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")
loHttp.SetRequestHeader("X-UIPATH-TenantName","{{tenant}}")
loResp = loHttp.PostJson3("https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "@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
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcOdata_context = loJResp.StringOf('"@odata.context"')
i = 0
lnCount_i = loJResp.SizeOfArray("value")
do while i < lnCount_i
loJResp.I = i
lcKey = loJResp.StringOf("value[i].Key")
lcStartTime = loJResp.StringOf("value[i].StartTime")
lcEndTime = loJResp.StringOf("value[i].EndTime")
lcState = loJResp.StringOf("value[i].State")
lcJobPriority = loJResp.StringOf("value[i].JobPriority")
lcSource = loJResp.StringOf("value[i].Source")
lcSourceType = loJResp.StringOf("value[i].SourceType")
lcBatchExecutionKey = loJResp.StringOf("value[i].BatchExecutionKey")
lcInfo = loJResp.StringOf("value[i].Info")
lcCreationTime = loJResp.StringOf("value[i].CreationTime")
lcStartingScheduleId = loJResp.StringOf("value[i].StartingScheduleId")
lcReleaseName = loJResp.StringOf("value[i].ReleaseName")
lcV_Type = loJResp.StringOf("value[i].Type")
lcInputArguments = loJResp.StringOf("value[i].InputArguments")
lcOutputArguments = loJResp.StringOf("value[i].OutputArguments")
lcHostMachineName = loJResp.StringOf("value[i].HostMachineName")
llHasMediaRecorded = loJResp.BoolOf("value[i].HasMediaRecorded")
lcPersistenceId = loJResp.StringOf("value[i].PersistenceId")
lcResumeVersion = loJResp.StringOf("value[i].ResumeVersion")
lcStopStrategy = loJResp.StringOf("value[i].StopStrategy")
lcRuntimeType = loJResp.StringOf("value[i].RuntimeType")
llRequiresUserInteraction = loJResp.BoolOf("value[i].RequiresUserInteraction")
lcReleaseVersionId = loJResp.StringOf("value[i].ReleaseVersionId")
lcEntryPointPath = loJResp.StringOf("value[i].EntryPointPath")
lnOrganizationUnitId = loJResp.IntOf("value[i].OrganizationUnitId")
lcOrganizationUnitFullyQualifiedName = loJResp.StringOf("value[i].OrganizationUnitFullyQualifiedName")
lcReference = loJResp.StringOf("value[i].Reference")
lcProcessType = loJResp.StringOf("value[i].ProcessType")
lnId = loJResp.IntOf("value[i].Id")
i = i + 1
enddo
release loHttp
release loJson
release loSbResponseBody
release loJResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "X-UIPATH-TenantName: {{tenant}}"
-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
-d '{
"startInfo": {
"ReleaseKey": "{{releaseKey}}",
"Strategy": "ModernJobsCount",
"JobsCount": 1,
"InputArguments": "{}"
}
}'
https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
Postman Collection Item JSON
{
"name": "Start Process",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 201\", function () {\r",
" pm.response.to.have.status(201);\r",
"});\r",
"\r",
"//set JobId key\r",
"var myResponse = pm.response.json();\r",
"pm.collectionVariables.set(\"jobId\", myResponse.value[0].Id);\r",
"console.log(pm.collectionVariables.get(\"jobId\"));"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "X-UIPATH-TenantName",
"value": "{{tenant}}",
"type": "text"
},
{
"key": "X-UIPATH-OrganizationUnitId",
"value": "{{folderId}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"startInfo\": {\r\n \"ReleaseKey\": \"{{releaseKey}}\",\r\n \"Strategy\": \"ModernJobsCount\",\r\n \"JobsCount\": 1,\r\n \"InputArguments\": \"{}\"\r\n }\r\n}"
},
"url": {
"raw": "{{url}}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs",
"host": [
"{{url}}"
],
"path": [
"orchestrator_",
"odata",
"Jobs",
"UiPath.Server.Configuration.OData.StartJobs"
]
},
"description": "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:\n\n1. `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.\n2. `Strategy`: For modern folders we recommend to make use of _ModernJobsCount_.\n3. `JobsCount`: How often the job will be executed.\n4. `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.\n\nFind more details on how to start of job [here](https://docs.uipath.com/orchestrator/docs/managing-jobs)."
},
"response": [
{
"name": "Start Process",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
},
{
"key": "X-UIPATH-TenantName",
"value": "{{tenantName}}",
"type": "text"
},
{
"key": "X-UIPATH-OrganizationUnitId",
"value": "{{folderId}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"startInfo\": {\r\n \"ReleaseKey\": \"{{releaseKey}}\",\r\n \"Strategy\": \"ModernJobsCount\",\r\n \"JobsCount\": 1,\r\n \"InputArguments\": \"{}\"\r\n }\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{url}}/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs",
"host": [
"{{url}}"
],
"path": [
"odata",
"Jobs",
"UiPath.Server.Configuration.OData.StartJobs"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 31 Mar 2021 12:54:16 GMT"
},
{
"key": "Content-Type",
"value": "application/json; odata.metadata=minimal; odata.streaming=true"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Cache-Control",
"value": "no-cache, no-store, must-revalidate"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Expires",
"value": "-1"
},
{
"key": "Request-Context",
"value": "appId=cid-v1:04884d99-0742-441b-a23c-847133cb0130"
},
{
"key": "X-Robots-Tag",
"value": "noindex,nofollow"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-XSS-Protection",
"value": "1"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Frame-Options",
"value": "Deny"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self';script-src 'self';style-src 'self' 'unsafe-inline';img-src 'self' data: https://*.blob.core.windows.net https://*.amazonaws.com blob:;font-src 'self' data:;connect-src 'self' wss: https://sentry.io https://studio-feedback.azure-api.net https://storage.googleapis.com https://*.service.signalr.net https://*.blob.core.windows.net https://*.amazonaws.com dc.services.visualstudio.com;worker-src 'self' blob:"
},
{
"key": "X-Correlation-ID",
"value": "f037b495-9025-4cb3-a4aa-c5bcc7cfa38b"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "api-supported-versions",
"value": "12.0"
},
{
"key": "CF-Cache-Status",
"value": "DYNAMIC"
},
{
"key": "cf-request-id",
"value": "0929f25fdf0000cba02d06c000000001"
},
{
"key": "Expect-CT",
"value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""
},
{
"key": "Server",
"value": "cloudflare"
},
{
"key": "CF-RAY",
"value": "6389b9ac9b2ecba0-VIE"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Jobs\",\n \"value\": [\n {\n \"Key\": \"b07ac1db-13d6-46b7-baf5-51a97ef20946\",\n \"StartTime\": null,\n \"EndTime\": null,\n \"State\": \"Pending\",\n \"JobPriority\": \"Normal\",\n \"Source\": \"Manual\",\n \"SourceType\": \"Manual\",\n \"BatchExecutionKey\": \"65bbd1da-623b-4d72-99db-42e70dcb7e52\",\n \"Info\": null,\n \"CreationTime\": \"2021-03-31T12:54:16.023Z\",\n \"StartingScheduleId\": null,\n \"ReleaseName\": \"Add a pet to pet store by queue item\",\n \"Type\": \"Unattended\",\n \"InputArguments\": null,\n \"OutputArguments\": null,\n \"HostMachineName\": null,\n \"HasMediaRecorded\": false,\n \"PersistenceId\": null,\n \"ResumeVersion\": null,\n \"StopStrategy\": null,\n \"RuntimeType\": \"Unattended\",\n \"RequiresUserInteraction\": true,\n \"ReleaseVersionId\": null,\n \"EntryPointPath\": null,\n \"OrganizationUnitId\": 515128,\n \"OrganizationUnitFullyQualifiedName\": null,\n \"Reference\": \"\",\n \"ProcessType\": \"Process\",\n \"Id\": 12764613\n }\n ]\n}"
}
]
}
