Chilkat Tools

Perl / Orchestrator / Environments - Get all

use chilkat();

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

$http = chilkat::CkHttp->new();

$queryParams = chilkat::CkJsonObject->new();
$queryParams->UpdateString("$expand","Robots");

$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}}");

# resp is a HttpResponse
$resp = $http->QuickRequestParams("GET","https://domain.com/odata/Environments",$queryParams);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

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

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";

    exit;
}

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

# {
#   "@odata.context": "https://platform.uipath.com/odata/$metadata#Environments",
#   "@odata.count": 1,
#   "value": [
#     {
#       "Name": "playground",
#       "Description": "Test environment for postman",
#       "Type": "Dev",
#       "Id": 23282,
#       "Robots": [
#         {
#           "LicenseKey": null,
#           "MachineName": "AnotherFakeOne",
#           "MachineId": 20967,
#           "Name": "Cassius",
#           "Username": "cassius",
#           "Description": "A dev bot for testing",
#           "Version": null,
#           "Type": "Development",
#           "HostingType": "Standard",
#           "Password": null,
#           "CredentialType": null,
#           "RobotEnvironments": "",
#           "Id": 33420,
#           "ExecutionSettings": 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);
    $Name = $jResp->stringOf("value[i].Name");
    $Description = $jResp->stringOf("value[i].Description");
    $v_Type = $jResp->stringOf("value[i].Type");
    $Id = $jResp->IntOf("value[i].Id");
    $j = 0;
    $count_j = $jResp->SizeOfArray("value[i].Robots");
    while ($j < $count_j) {
        $jResp->put_J($j);
        $LicenseKey = $jResp->stringOf("value[i].Robots[j].LicenseKey");
        $MachineName = $jResp->stringOf("value[i].Robots[j].MachineName");
        $MachineId = $jResp->IntOf("value[i].Robots[j].MachineId");
        $Name = $jResp->stringOf("value[i].Robots[j].Name");
        $Username = $jResp->stringOf("value[i].Robots[j].Username");
        $Description = $jResp->stringOf("value[i].Robots[j].Description");
        $Version = $jResp->stringOf("value[i].Robots[j].Version");
        $v_Type = $jResp->stringOf("value[i].Robots[j].Type");
        $HostingType = $jResp->stringOf("value[i].Robots[j].HostingType");
        $Password = $jResp->stringOf("value[i].Robots[j].Password");
        $CredentialType = $jResp->stringOf("value[i].Robots[j].CredentialType");
        $RobotEnvironments = $jResp->stringOf("value[i].Robots[j].RobotEnvironments");
        $Id = $jResp->IntOf("value[i].Robots[j].Id");
        $ExecutionSettings = $jResp->stringOf("value[i].Robots[j].ExecutionSettings");
        $j = $j + 1;
    }

    $i = $i + 1;
}

Curl Command

curl -G -d "$expand=Robots"
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-H "X-UIPATH-TenantName: {{tenantName}}"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Environments

Postman Collection Item JSON

{
  "name": "Environments - Get all",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "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/Environments?$expand=Robots",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Environments"
      ],
      "query": [
        {
          "key": "$expand",
          "value": "Robots"
        }
      ]
    },
    "description": "Get all Assets. Use query params to narrow the response group."
  },
  "response": [
    {
      "name": "Environments - Get all",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{url}}/odata/Environments?$expand=Robots",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Environments"
          ],
          "query": [
            {
              "key": "$expand",
              "value": "Robots"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Thu, 14 Feb 2019 18:01:11 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Content-Length",
          "value": "443"
        },
        {
          "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": "4a9170480e5297d4-FRA"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Environments\",\n    \"@odata.count\": 1,\n    \"value\": [\n        {\n            \"Name\": \"playground\",\n            \"Description\": \"Test environment for postman\",\n            \"Type\": \"Dev\",\n            \"Id\": 23282,\n            \"Robots\": [\n                {\n                    \"LicenseKey\": null,\n                    \"MachineName\": \"AnotherFakeOne\",\n                    \"MachineId\": 20967,\n                    \"Name\": \"Cassius\",\n                    \"Username\": \"cassius\",\n                    \"Description\": \"A dev bot for testing\",\n                    \"Version\": null,\n                    \"Type\": \"Development\",\n                    \"HostingType\": \"Standard\",\n                    \"Password\": null,\n                    \"CredentialType\": null,\n                    \"RobotEnvironments\": \"\",\n                    \"Id\": 33420,\n                    \"ExecutionSettings\": null\n                }\n            ]\n        }\n    ]\n}"
    }
  ]
}

Chilkat Online Tools

Perl / Orchestrator / Environments - Get all

Curl Command

Postman Collection Item JSON