Chilkat Online Tools

C / Orchestrator API Documentation / Start Process

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject json;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *Key;
    const char *StartTime;
    const char *EndTime;
    const char *State;
    const char *JobPriority;
    const char *Source;
    const char *SourceType;
    const char *BatchExecutionKey;
    const char *Info;
    const char *CreationTime;
    const char *StartingScheduleId;
    const char *ReleaseName;
    const char *v_Type;
    const char *InputArguments;
    const char *OutputArguments;
    const char *HostMachineName;
    BOOL HasMediaRecorded;
    const char *PersistenceId;
    const char *ResumeVersion;
    const char *StopStrategy;
    const char *RuntimeType;
    BOOL RequiresUserInteraction;
    const char *ReleaseVersionId;
    const char *EntryPointPath;
    int OrganizationUnitId;
    const char *OrganizationUnitFullyQualifiedName;
    const char *Reference;
    const char *ProcessType;
    int Id;
    const char *odata_context;
    int i;
    int count_i;

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

    http = CkHttp_Create();

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

    json = CkJsonObject_Create();
    CkJsonObject_UpdateString(json,"startInfo.ReleaseKey","{{releaseKey}}");
    CkJsonObject_UpdateString(json,"startInfo.Strategy","ModernJobsCount");
    CkJsonObject_UpdateInt(json,"startInfo.JobsCount",1);
    CkJsonObject_UpdateString(json,"startInfo.InputArguments","{}");

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

    resp = CkHttp_PostJson3(http,"https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs","application/json",json);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    CkHttpResponse_Dispose(resp);

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    odata_context = CkJsonObject_stringOf(jResp,"\"@odata.context\"");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"value");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        Key = CkJsonObject_stringOf(jResp,"value[i].Key");
        StartTime = CkJsonObject_stringOf(jResp,"value[i].StartTime");
        EndTime = CkJsonObject_stringOf(jResp,"value[i].EndTime");
        State = CkJsonObject_stringOf(jResp,"value[i].State");
        JobPriority = CkJsonObject_stringOf(jResp,"value[i].JobPriority");
        Source = CkJsonObject_stringOf(jResp,"value[i].Source");
        SourceType = CkJsonObject_stringOf(jResp,"value[i].SourceType");
        BatchExecutionKey = CkJsonObject_stringOf(jResp,"value[i].BatchExecutionKey");
        Info = CkJsonObject_stringOf(jResp,"value[i].Info");
        CreationTime = CkJsonObject_stringOf(jResp,"value[i].CreationTime");
        StartingScheduleId = CkJsonObject_stringOf(jResp,"value[i].StartingScheduleId");
        ReleaseName = CkJsonObject_stringOf(jResp,"value[i].ReleaseName");
        v_Type = CkJsonObject_stringOf(jResp,"value[i].Type");
        InputArguments = CkJsonObject_stringOf(jResp,"value[i].InputArguments");
        OutputArguments = CkJsonObject_stringOf(jResp,"value[i].OutputArguments");
        HostMachineName = CkJsonObject_stringOf(jResp,"value[i].HostMachineName");
        HasMediaRecorded = CkJsonObject_BoolOf(jResp,"value[i].HasMediaRecorded");
        PersistenceId = CkJsonObject_stringOf(jResp,"value[i].PersistenceId");
        ResumeVersion = CkJsonObject_stringOf(jResp,"value[i].ResumeVersion");
        StopStrategy = CkJsonObject_stringOf(jResp,"value[i].StopStrategy");
        RuntimeType = CkJsonObject_stringOf(jResp,"value[i].RuntimeType");
        RequiresUserInteraction = CkJsonObject_BoolOf(jResp,"value[i].RequiresUserInteraction");
        ReleaseVersionId = CkJsonObject_stringOf(jResp,"value[i].ReleaseVersionId");
        EntryPointPath = CkJsonObject_stringOf(jResp,"value[i].EntryPointPath");
        OrganizationUnitId = CkJsonObject_IntOf(jResp,"value[i].OrganizationUnitId");
        OrganizationUnitFullyQualifiedName = CkJsonObject_stringOf(jResp,"value[i].OrganizationUnitFullyQualifiedName");
        Reference = CkJsonObject_stringOf(jResp,"value[i].Reference");
        ProcessType = CkJsonObject_stringOf(jResp,"value[i].ProcessType");
        Id = CkJsonObject_IntOf(jResp,"value[i].Id");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

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