Chilkat Online Tools

DataFlex / Orchestrator API Documentation / Restart Process

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sOdata_context
    String sKey
    String sStartTime
    String sEndTime
    String sState
    String sJobPriority
    String sSource
    String sSourceType
    String sBatchExecutionKey
    String sInfo
    String sCreationTime
    String sStartingScheduleId
    String sReleaseName
    String sV_Type
    String sInputArguments
    String sOutputArguments
    String sHostMachineName
    Boolean iHasMediaRecorded
    String sPersistenceId
    String sResumeVersion
    String sStopStrategy
    String sRuntimeType
    Boolean iRequiresUserInteraction
    String sReleaseVersionId
    String sEntryPointPath
    Integer iOrganizationUnitId
    String sOrganizationUnitFullyQualifiedName
    String sReference
    String sProcessType
    Integer iId
    String sTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateInt Of hoJson "jobId" 123 To iSuccess

    Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
    // Adds the "Authorization: Bearer <access_token>" header.
    Set ComAuthToken Of hoHttp To "<access_token>"
    Send ComSetRequestHeader To hoHttp "X-UIPATH-OrganizationUnitId" "{{folderId}}"
    Send ComSetRequestHeader To hoHttp "X-UIPATH-TenantName" "{{tenantName}}"

    Get pvComObject of hoJson to vJson
    Get ComPostJson3 Of hoHttp "https://domain.com/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob" "application/json" vJson To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

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

    Get ComStringOf Of hoJResp '"@odata.context"' To sOdata_context
    Get ComStringOf Of hoJResp "Key" To sKey
    Get ComStringOf Of hoJResp "StartTime" To sStartTime
    Get ComStringOf Of hoJResp "EndTime" To sEndTime
    Get ComStringOf Of hoJResp "State" To sState
    Get ComStringOf Of hoJResp "JobPriority" To sJobPriority
    Get ComStringOf Of hoJResp "Source" To sSource
    Get ComStringOf Of hoJResp "SourceType" To sSourceType
    Get ComStringOf Of hoJResp "BatchExecutionKey" To sBatchExecutionKey
    Get ComStringOf Of hoJResp "Info" To sInfo
    Get ComStringOf Of hoJResp "CreationTime" To sCreationTime
    Get ComStringOf Of hoJResp "StartingScheduleId" To sStartingScheduleId
    Get ComStringOf Of hoJResp "ReleaseName" To sReleaseName
    Get ComStringOf Of hoJResp "Type" To sV_Type
    Get ComStringOf Of hoJResp "InputArguments" To sInputArguments
    Get ComStringOf Of hoJResp "OutputArguments" To sOutputArguments
    Get ComStringOf Of hoJResp "HostMachineName" To sHostMachineName
    Get ComBoolOf Of hoJResp "HasMediaRecorded" To iHasMediaRecorded
    Get ComStringOf Of hoJResp "PersistenceId" To sPersistenceId
    Get ComStringOf Of hoJResp "ResumeVersion" To sResumeVersion
    Get ComStringOf Of hoJResp "StopStrategy" To sStopStrategy
    Get ComStringOf Of hoJResp "RuntimeType" To sRuntimeType
    Get ComBoolOf Of hoJResp "RequiresUserInteraction" To iRequiresUserInteraction
    Get ComStringOf Of hoJResp "ReleaseVersionId" To sReleaseVersionId
    Get ComStringOf Of hoJResp "EntryPointPath" To sEntryPointPath
    Get ComIntOf Of hoJResp "OrganizationUnitId" To iOrganizationUnitId
    Get ComStringOf Of hoJResp "OrganizationUnitFullyQualifiedName" To sOrganizationUnitFullyQualifiedName
    Get ComStringOf Of hoJResp "Reference" To sReference
    Get ComStringOf Of hoJResp "ProcessType" To sProcessType
    Get ComIntOf Of hoJResp "Id" To iId


End_Procedure

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