Chilkat Online Tools

Xojo / Orchestrator API Documentation / Restart 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.

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

Dim json As New Chilkat.JsonObject
success = json.UpdateInt("jobId",123)

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

Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob","application/json",json)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

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

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

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

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

Dim odata_context As String
odata_context = jResp.StringOf("""@odata.context""")
Dim Key As String
Key = jResp.StringOf("Key")
Dim StartTime As String
StartTime = jResp.StringOf("StartTime")
Dim EndTime As String
EndTime = jResp.StringOf("EndTime")
Dim State As String
State = jResp.StringOf("State")
Dim JobPriority As String
JobPriority = jResp.StringOf("JobPriority")
Dim Source As String
Source = jResp.StringOf("Source")
Dim SourceType As String
SourceType = jResp.StringOf("SourceType")
Dim BatchExecutionKey As String
BatchExecutionKey = jResp.StringOf("BatchExecutionKey")
Dim Info As String
Info = jResp.StringOf("Info")
Dim CreationTime As String
CreationTime = jResp.StringOf("CreationTime")
Dim StartingScheduleId As String
StartingScheduleId = jResp.StringOf("StartingScheduleId")
Dim ReleaseName As String
ReleaseName = jResp.StringOf("ReleaseName")
Dim v_Type As String
v_Type = jResp.StringOf("Type")
Dim InputArguments As String
InputArguments = jResp.StringOf("InputArguments")
Dim OutputArguments As String
OutputArguments = jResp.StringOf("OutputArguments")
Dim HostMachineName As String
HostMachineName = jResp.StringOf("HostMachineName")
Dim HasMediaRecorded As Boolean
HasMediaRecorded = jResp.BoolOf("HasMediaRecorded")
Dim PersistenceId As String
PersistenceId = jResp.StringOf("PersistenceId")
Dim ResumeVersion As String
ResumeVersion = jResp.StringOf("ResumeVersion")
Dim StopStrategy As String
StopStrategy = jResp.StringOf("StopStrategy")
Dim RuntimeType As String
RuntimeType = jResp.StringOf("RuntimeType")
Dim RequiresUserInteraction As Boolean
RequiresUserInteraction = jResp.BoolOf("RequiresUserInteraction")
Dim ReleaseVersionId As String
ReleaseVersionId = jResp.StringOf("ReleaseVersionId")
Dim EntryPointPath As String
EntryPointPath = jResp.StringOf("EntryPointPath")
Dim OrganizationUnitId As Int32
OrganizationUnitId = jResp.IntOf("OrganizationUnitId")
Dim OrganizationUnitFullyQualifiedName As String
OrganizationUnitFullyQualifiedName = jResp.StringOf("OrganizationUnitFullyQualifiedName")
Dim Reference As String
Reference = jResp.StringOf("Reference")
Dim ProcessType As String
ProcessType = jResp.StringOf("ProcessType")
Dim Id As Int32
Id = jResp.IntOf("Id")

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