Chilkat Online Tools

phpExt / Orchestrator / Process Versions - Get single

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

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

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://domain.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "@odata.context": "https://platform.uipath.com/odata/$metadata#Processes",
//   "@odata.count": 1,
//   "value": [
//     {
//       "IsActive": true,
//       "Title": null,
//       "Version": "1.0.6705.14383",
//       "Key": "Heyyo:1.0.6705.14383",
//       "Description": "Jobs for Orchestrator",
//       "Published": "2019-01-31T17:54:39.9213054Z",
//       "IsLatestVersion": true,
//       "OldVersion": null,
//       "ReleaseNotes": null,
//       "Authors": "Dean",
//       "Id": "Heyyo",
//       "Arguments": {
//         "Input": null,
//         "Output": null
//       }
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$odata_context = $jResp->stringOf('\'@odata.context\'');
$odata_count = $jResp->IntOf('\'@odata.count\'');
$i = 0;
$count_i = $jResp->SizeOfArray('value');
while ($i < $count_i) {
    $jResp->put_I($i);
    $IsActive = $jResp->BoolOf('value[i].IsActive');
    $Title = $jResp->stringOf('value[i].Title');
    $Version = $jResp->stringOf('value[i].Version');
    $Key = $jResp->stringOf('value[i].Key');
    $Description = $jResp->stringOf('value[i].Description');
    $Published = $jResp->stringOf('value[i].Published');
    $IsLatestVersion = $jResp->BoolOf('value[i].IsLatestVersion');
    $OldVersion = $jResp->stringOf('value[i].OldVersion');
    $ReleaseNotes = $jResp->stringOf('value[i].ReleaseNotes');
    $Authors = $jResp->stringOf('value[i].Authors');
    $Id = $jResp->stringOf('value[i].Id');
    $Input = $jResp->stringOf('value[i].Arguments.Input');
    $Output = $jResp->stringOf('value[i].Arguments.Output');
    $i = $i + 1;
}


?>

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "X-UIPATH-TenantName: {{tenantName}}"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')

Postman Collection Item JSON

{
  "name": "Process Versions - Get single",
  "request": {
    "method": "GET",
    "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"
      }
    ],
    "url": {
      "raw": "{{url}}/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Processes",
        "UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')"
      ]
    }
  },
  "response": [
    {
      "name": "Process Versions - Get single",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{url}}/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Processes",
            "UiPath.Server.Configuration.OData.GetProcessVersions(processId='Heyyo')"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 31 Jan 2019 17:57:18 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Content-Length",
          "value": "401"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Cache-Control",
          "value": "no-store, must-revalidate, no-cache, max-age=0"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Set-Cookie",
          "value": "; SameSite=lax"
        },
        {
          "key": "api-supported-versions",
          "value": "7.0"
        },
        {
          "key": "OData-Version",
          "value": "4.0"
        },
        {
          "key": "Request-Context",
          "value": "appId=cid-v1:d00ce63d-0891-41e4-a17c-25b2c5382e49"
        },
        {
          "key": "Access-Control-Expose-Headers",
          "value": "Request-Context"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Frame-Options",
          "value": "DENY"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains"
        },
        {
          "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": "4a1e0f552fcb2462-IAD"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Processes\",\n    \"@odata.count\": 1,\n    \"value\": [\n        {\n            \"IsActive\": true,\n            \"Title\": null,\n            \"Version\": \"1.0.6705.14383\",\n            \"Key\": \"Heyyo:1.0.6705.14383\",\n            \"Description\": \"Jobs for Orchestrator\",\n            \"Published\": \"2019-01-31T17:54:39.9213054Z\",\n            \"IsLatestVersion\": true,\n            \"OldVersion\": null,\n            \"ReleaseNotes\": null,\n            \"Authors\": \"Dean\",\n            \"Id\": \"Heyyo\",\n            \"Arguments\": {\n                \"Input\": null,\n                \"Output\": null\n            }\n        }\n    ]\n}"
    }
  ]
}