Chilkat Online Tools

unicodeC / Orchestrator API Documentation / Restart Process

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW json;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *odata_context;
    const wchar_t *Key;
    const wchar_t *StartTime;
    const wchar_t *EndTime;
    const wchar_t *State;
    const wchar_t *JobPriority;
    const wchar_t *Source;
    const wchar_t *SourceType;
    const wchar_t *BatchExecutionKey;
    const wchar_t *Info;
    const wchar_t *CreationTime;
    const wchar_t *StartingScheduleId;
    const wchar_t *ReleaseName;
    const wchar_t *v_Type;
    const wchar_t *InputArguments;
    const wchar_t *OutputArguments;
    const wchar_t *HostMachineName;
    BOOL HasMediaRecorded;
    const wchar_t *PersistenceId;
    const wchar_t *ResumeVersion;
    const wchar_t *StopStrategy;
    const wchar_t *RuntimeType;
    BOOL RequiresUserInteraction;
    const wchar_t *ReleaseVersionId;
    const wchar_t *EntryPointPath;
    int OrganizationUnitId;
    const wchar_t *OrganizationUnitFullyQualifiedName;
    const wchar_t *Reference;
    const wchar_t *ProcessType;
    int Id;

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

    http = CkHttpW_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 = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateInt(json,L"jobId",123);

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

    resp = CkHttpW_PostJson3(http,L"https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob",L"application/json",json);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(json);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_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 = CkJsonObjectW_stringOf(jResp,L"\"@odata.context\"");
    Key = CkJsonObjectW_stringOf(jResp,L"Key");
    StartTime = CkJsonObjectW_stringOf(jResp,L"StartTime");
    EndTime = CkJsonObjectW_stringOf(jResp,L"EndTime");
    State = CkJsonObjectW_stringOf(jResp,L"State");
    JobPriority = CkJsonObjectW_stringOf(jResp,L"JobPriority");
    Source = CkJsonObjectW_stringOf(jResp,L"Source");
    SourceType = CkJsonObjectW_stringOf(jResp,L"SourceType");
    BatchExecutionKey = CkJsonObjectW_stringOf(jResp,L"BatchExecutionKey");
    Info = CkJsonObjectW_stringOf(jResp,L"Info");
    CreationTime = CkJsonObjectW_stringOf(jResp,L"CreationTime");
    StartingScheduleId = CkJsonObjectW_stringOf(jResp,L"StartingScheduleId");
    ReleaseName = CkJsonObjectW_stringOf(jResp,L"ReleaseName");
    v_Type = CkJsonObjectW_stringOf(jResp,L"Type");
    InputArguments = CkJsonObjectW_stringOf(jResp,L"InputArguments");
    OutputArguments = CkJsonObjectW_stringOf(jResp,L"OutputArguments");
    HostMachineName = CkJsonObjectW_stringOf(jResp,L"HostMachineName");
    HasMediaRecorded = CkJsonObjectW_BoolOf(jResp,L"HasMediaRecorded");
    PersistenceId = CkJsonObjectW_stringOf(jResp,L"PersistenceId");
    ResumeVersion = CkJsonObjectW_stringOf(jResp,L"ResumeVersion");
    StopStrategy = CkJsonObjectW_stringOf(jResp,L"StopStrategy");
    RuntimeType = CkJsonObjectW_stringOf(jResp,L"RuntimeType");
    RequiresUserInteraction = CkJsonObjectW_BoolOf(jResp,L"RequiresUserInteraction");
    ReleaseVersionId = CkJsonObjectW_stringOf(jResp,L"ReleaseVersionId");
    EntryPointPath = CkJsonObjectW_stringOf(jResp,L"EntryPointPath");
    OrganizationUnitId = CkJsonObjectW_IntOf(jResp,L"OrganizationUnitId");
    OrganizationUnitFullyQualifiedName = CkJsonObjectW_stringOf(jResp,L"OrganizationUnitFullyQualifiedName");
    Reference = CkJsonObjectW_stringOf(jResp,L"Reference");
    ProcessType = CkJsonObjectW_stringOf(jResp,L"ProcessType");
    Id = CkJsonObjectW_IntOf(jResp,L"Id");


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(json);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_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}"
    }
  ]
}