Chilkat Online Tools

Foxpro / Orchestrator API Documentation / Restart Process

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcOdata_context
LOCAL lcKey
LOCAL lcStartTime
LOCAL lcEndTime
LOCAL lcState
LOCAL lcJobPriority
LOCAL lcSource
LOCAL lcSourceType
LOCAL lcBatchExecutionKey
LOCAL lcInfo
LOCAL lcCreationTime
LOCAL lcStartingScheduleId
LOCAL lcReleaseName
LOCAL lcV_Type
LOCAL lcInputArguments
LOCAL lcOutputArguments
LOCAL lcHostMachineName
LOCAL lnHasMediaRecorded
LOCAL lcPersistenceId
LOCAL lcResumeVersion
LOCAL lcStopStrategy
LOCAL lcRuntimeType
LOCAL lnRequiresUserInteraction
LOCAL lcReleaseVersionId
LOCAL lcEntryPointPath
LOCAL lnOrganizationUnitId
LOCAL lcOrganizationUnitFullyQualifiedName
LOCAL lcReference
LOCAL lcProcessType
LOCAL lnId

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateInt("jobId",123)

loHttp.SetRequestHeader("Content-Type","application/json")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")
loHttp.SetRequestHeader("X-UIPATH-TenantName","{{tenantName}}")

loResp = loHttp.PostJson3("https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcOdata_context = loJResp.StringOf('"@odata.context"')
lcKey = loJResp.StringOf("Key")
lcStartTime = loJResp.StringOf("StartTime")
lcEndTime = loJResp.StringOf("EndTime")
lcState = loJResp.StringOf("State")
lcJobPriority = loJResp.StringOf("JobPriority")
lcSource = loJResp.StringOf("Source")
lcSourceType = loJResp.StringOf("SourceType")
lcBatchExecutionKey = loJResp.StringOf("BatchExecutionKey")
lcInfo = loJResp.StringOf("Info")
lcCreationTime = loJResp.StringOf("CreationTime")
lcStartingScheduleId = loJResp.StringOf("StartingScheduleId")
lcReleaseName = loJResp.StringOf("ReleaseName")
lcV_Type = loJResp.StringOf("Type")
lcInputArguments = loJResp.StringOf("InputArguments")
lcOutputArguments = loJResp.StringOf("OutputArguments")
lcHostMachineName = loJResp.StringOf("HostMachineName")
lnHasMediaRecorded = loJResp.BoolOf("HasMediaRecorded")
lcPersistenceId = loJResp.StringOf("PersistenceId")
lcResumeVersion = loJResp.StringOf("ResumeVersion")
lcStopStrategy = loJResp.StringOf("StopStrategy")
lcRuntimeType = loJResp.StringOf("RuntimeType")
lnRequiresUserInteraction = loJResp.BoolOf("RequiresUserInteraction")
lcReleaseVersionId = loJResp.StringOf("ReleaseVersionId")
lcEntryPointPath = loJResp.StringOf("EntryPointPath")
lnOrganizationUnitId = loJResp.IntOf("OrganizationUnitId")
lcOrganizationUnitFullyQualifiedName = loJResp.StringOf("OrganizationUnitFullyQualifiedName")
lcReference = loJResp.StringOf("Reference")
lcProcessType = loJResp.StringOf("ProcessType")
lnId = loJResp.IntOf("Id")

RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp

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