Chilkat Online Tools

C / Orchestrator API Documentation / Restart 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 *odata_context;
    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;

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

    // {
    //   "jobId": 123
    // }

    json = CkJsonObject_Create();
    CkJsonObject_UpdateInt(json,"jobId",123);

    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","{{tenantName}}");

    resp = CkHttp_PostJson3(http,"https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob","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/$entity",
    //   "Key": "64eb533a-5b10-437f-8a16-c896419f1793",
    //   "StartTime": null,
    //   "EndTime": null,
    //   "State": "Pending",
    //   "JobPriority": "Normal",
    //   "Source": "Manual",
    //   "SourceType": "Manual",
    //   "BatchExecutionKey": "26918b13-2e8f-456f-85e1-f2d6a164427e",
    //   "Info": null,
    //   "CreationTime": "2021-03-31T12:55:07.273Z",
    //   "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": 12764707
    // }

    // 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\"");
    Key = CkJsonObject_stringOf(jResp,"Key");
    StartTime = CkJsonObject_stringOf(jResp,"StartTime");
    EndTime = CkJsonObject_stringOf(jResp,"EndTime");
    State = CkJsonObject_stringOf(jResp,"State");
    JobPriority = CkJsonObject_stringOf(jResp,"JobPriority");
    Source = CkJsonObject_stringOf(jResp,"Source");
    SourceType = CkJsonObject_stringOf(jResp,"SourceType");
    BatchExecutionKey = CkJsonObject_stringOf(jResp,"BatchExecutionKey");
    Info = CkJsonObject_stringOf(jResp,"Info");
    CreationTime = CkJsonObject_stringOf(jResp,"CreationTime");
    StartingScheduleId = CkJsonObject_stringOf(jResp,"StartingScheduleId");
    ReleaseName = CkJsonObject_stringOf(jResp,"ReleaseName");
    v_Type = CkJsonObject_stringOf(jResp,"Type");
    InputArguments = CkJsonObject_stringOf(jResp,"InputArguments");
    OutputArguments = CkJsonObject_stringOf(jResp,"OutputArguments");
    HostMachineName = CkJsonObject_stringOf(jResp,"HostMachineName");
    HasMediaRecorded = CkJsonObject_BoolOf(jResp,"HasMediaRecorded");
    PersistenceId = CkJsonObject_stringOf(jResp,"PersistenceId");
    ResumeVersion = CkJsonObject_stringOf(jResp,"ResumeVersion");
    StopStrategy = CkJsonObject_stringOf(jResp,"StopStrategy");
    RuntimeType = CkJsonObject_stringOf(jResp,"RuntimeType");
    RequiresUserInteraction = CkJsonObject_BoolOf(jResp,"RequiresUserInteraction");
    ReleaseVersionId = CkJsonObject_stringOf(jResp,"ReleaseVersionId");
    EntryPointPath = CkJsonObject_stringOf(jResp,"EntryPointPath");
    OrganizationUnitId = CkJsonObject_IntOf(jResp,"OrganizationUnitId");
    OrganizationUnitFullyQualifiedName = CkJsonObject_stringOf(jResp,"OrganizationUnitFullyQualifiedName");
    Reference = CkJsonObject_stringOf(jResp,"Reference");
    ProcessType = CkJsonObject_stringOf(jResp,"ProcessType");
    Id = CkJsonObject_IntOf(jResp,"Id");


    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: {{tenantName}}"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
	-d '{
    "jobId": {{lastJobId}}
}'
https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob

Postman Collection Item JSON

{
  "name": "Restart Process",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "pm.test(\"Status code is 200\", function () {\r",
          "    pm.response.to.have.status(200);\r",
          "});\r",
          "\r",
          "//set JobId key\r",
          "var myResponse = pm.response.json();\r",
          "pm.collectionVariables.set(\"jobId\", myResponse.Id);\r",
          "console.log(pm.collectionVariables.get(\"jobId\"));\r",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "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    \"jobId\": {{lastJobId}}\r\n}"
    },
    "url": {
      "raw": "{{url}}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob",
      "host": [
        "{{url}}"
      ],
      "path": [
        "orchestrator_",
        "odata",
        "Jobs",
        "UiPath.Server.Configuration.OData.RestartJob"
      ]
    }
  },
  "response": [
    {
      "name": "Restart Process",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "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    \"jobId\": {{lastJobId}}\r\n}"
        },
        "url": {
          "raw": "{{url}}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob",
          "host": [
            "{{url}}"
          ],
          "path": [
            "orchestrator_",
            "odata",
            "Jobs",
            "UiPath.Server.Configuration.OData.RestartJob"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Wed, 31 Mar 2021 12:55:07 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": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "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": "8abd67df-6582-4561-a41f-a96ecce1cd89"
        },
        {
          "key": "OData-Version",
          "value": "4.0"
        },
        {
          "key": "api-supported-versions",
          "value": "12.0"
        },
        {
          "key": "CF-Cache-Status",
          "value": "DYNAMIC"
        },
        {
          "key": "cf-request-id",
          "value": "0929f328050000cba0ef84b000000001"
        },
        {
          "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": "6389baecd807cba0-VIE"
        },
        {
          "key": "Content-Encoding",
          "value": "br"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://cloud.uipath.com/org/tenant/orchestrator_/odata/$metadata#Jobs/$entity\",\n    \"Key\": \"64eb533a-5b10-437f-8a16-c896419f1793\",\n    \"StartTime\": null,\n    \"EndTime\": null,\n    \"State\": \"Pending\",\n    \"JobPriority\": \"Normal\",\n    \"Source\": \"Manual\",\n    \"SourceType\": \"Manual\",\n    \"BatchExecutionKey\": \"26918b13-2e8f-456f-85e1-f2d6a164427e\",\n    \"Info\": null,\n    \"CreationTime\": \"2021-03-31T12:55:07.273Z\",\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\": 12764707\n}"
    }
  ]
}