Chilkat Online Tools

VB.NET / Orchestrator API Documentation / Start Process

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

' 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": "{}"
'   }
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("startInfo.ReleaseKey","{{releaseKey}}")
json.UpdateString("startInfo.Strategy","ModernJobsCount")
json.UpdateInt("startInfo.JobsCount",1)
json.UpdateString("startInfo.InputArguments","{}")

http.SetRequestHeader("Content-Type","application/json")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")
http.SetRequestHeader("X-UIPATH-TenantName","{{tenant}}")

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' 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



Dim Key As String
Dim StartTime As String
Dim EndTime As String
Dim State As String
Dim JobPriority As String
Dim Source As String
Dim SourceType As String
Dim BatchExecutionKey As String
Dim Info As String
Dim CreationTime As String
Dim StartingScheduleId As String
Dim ReleaseName As String
Dim v_Type As String
Dim InputArguments As String
Dim OutputArguments As String
Dim HostMachineName As String
Dim HasMediaRecorded As Boolean
Dim PersistenceId As String
Dim ResumeVersion As String
Dim StopStrategy As String
Dim RuntimeType As String
Dim RequiresUserInteraction As Boolean
Dim ReleaseVersionId As String
Dim EntryPointPath As String
Dim OrganizationUnitId As Integer
Dim OrganizationUnitFullyQualifiedName As String
Dim Reference As String
Dim ProcessType As String
Dim Id As Integer

Dim odata_context As String = jResp.StringOf("""@odata.context""")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("value")
While i < count_i
    jResp.I = i
    Key = jResp.StringOf("value[i].Key")
    StartTime = jResp.StringOf("value[i].StartTime")
    EndTime = jResp.StringOf("value[i].EndTime")
    State = jResp.StringOf("value[i].State")
    JobPriority = jResp.StringOf("value[i].JobPriority")
    Source = jResp.StringOf("value[i].Source")
    SourceType = jResp.StringOf("value[i].SourceType")
    BatchExecutionKey = jResp.StringOf("value[i].BatchExecutionKey")
    Info = jResp.StringOf("value[i].Info")
    CreationTime = jResp.StringOf("value[i].CreationTime")
    StartingScheduleId = jResp.StringOf("value[i].StartingScheduleId")
    ReleaseName = jResp.StringOf("value[i].ReleaseName")
    v_Type = jResp.StringOf("value[i].Type")
    InputArguments = jResp.StringOf("value[i].InputArguments")
    OutputArguments = jResp.StringOf("value[i].OutputArguments")
    HostMachineName = jResp.StringOf("value[i].HostMachineName")
    HasMediaRecorded = jResp.BoolOf("value[i].HasMediaRecorded")
    PersistenceId = jResp.StringOf("value[i].PersistenceId")
    ResumeVersion = jResp.StringOf("value[i].ResumeVersion")
    StopStrategy = jResp.StringOf("value[i].StopStrategy")
    RuntimeType = jResp.StringOf("value[i].RuntimeType")
    RequiresUserInteraction = jResp.BoolOf("value[i].RequiresUserInteraction")
    ReleaseVersionId = jResp.StringOf("value[i].ReleaseVersionId")
    EntryPointPath = jResp.StringOf("value[i].EntryPointPath")
    OrganizationUnitId = jResp.IntOf("value[i].OrganizationUnitId")
    OrganizationUnitFullyQualifiedName = jResp.StringOf("value[i].OrganizationUnitFullyQualifiedName")
    Reference = jResp.StringOf("value[i].Reference")
    ProcessType = jResp.StringOf("value[i].ProcessType")
    Id = jResp.IntOf("value[i].Id")
    i = i + 1
End While

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}"
    }
  ]
}