Chilkat Online Tools

TCL / Orchestrator API Documentation / Restart Process

Back to Collection Items

load ./chilkat.dll

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

set http [new_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.

# {
#   "jobId": 123
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateInt $json "jobId" 123

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "X-UIPATH-OrganizationUnitId" "{{folderId}}"
CkHttp_SetRequestHeader $http "X-UIPATH-TenantName" "{{tenantName}}"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpJson $http "POST" "https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob" $json "application/json" $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# 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

set odata_context [CkJsonObject_stringOf $jResp "\"@odata.context\""]
set Key [CkJsonObject_stringOf $jResp "Key"]
set StartTime [CkJsonObject_stringOf $jResp "StartTime"]
set EndTime [CkJsonObject_stringOf $jResp "EndTime"]
set State [CkJsonObject_stringOf $jResp "State"]
set JobPriority [CkJsonObject_stringOf $jResp "JobPriority"]
set Source [CkJsonObject_stringOf $jResp "Source"]
set SourceType [CkJsonObject_stringOf $jResp "SourceType"]
set BatchExecutionKey [CkJsonObject_stringOf $jResp "BatchExecutionKey"]
set Info [CkJsonObject_stringOf $jResp "Info"]
set CreationTime [CkJsonObject_stringOf $jResp "CreationTime"]
set StartingScheduleId [CkJsonObject_stringOf $jResp "StartingScheduleId"]
set ReleaseName [CkJsonObject_stringOf $jResp "ReleaseName"]
set v_Type [CkJsonObject_stringOf $jResp "Type"]
set InputArguments [CkJsonObject_stringOf $jResp "InputArguments"]
set OutputArguments [CkJsonObject_stringOf $jResp "OutputArguments"]
set HostMachineName [CkJsonObject_stringOf $jResp "HostMachineName"]
set HasMediaRecorded [CkJsonObject_BoolOf $jResp "HasMediaRecorded"]
set PersistenceId [CkJsonObject_stringOf $jResp "PersistenceId"]
set ResumeVersion [CkJsonObject_stringOf $jResp "ResumeVersion"]
set StopStrategy [CkJsonObject_stringOf $jResp "StopStrategy"]
set RuntimeType [CkJsonObject_stringOf $jResp "RuntimeType"]
set RequiresUserInteraction [CkJsonObject_BoolOf $jResp "RequiresUserInteraction"]
set ReleaseVersionId [CkJsonObject_stringOf $jResp "ReleaseVersionId"]
set EntryPointPath [CkJsonObject_stringOf $jResp "EntryPointPath"]
set OrganizationUnitId [CkJsonObject_IntOf $jResp "OrganizationUnitId"]
set OrganizationUnitFullyQualifiedName [CkJsonObject_stringOf $jResp "OrganizationUnitFullyQualifiedName"]
set Reference [CkJsonObject_stringOf $jResp "Reference"]
set ProcessType [CkJsonObject_stringOf $jResp "ProcessType"]
set Id [CkJsonObject_IntOf $jResp "Id"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $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}"
    }
  ]
}