Chilkat Online Tools

TCL / Orchestrator / Machines - Get All

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "X-UIPATH-OrganizationUnitId" "{{folderId}}"
CkHttp_SetRequestHeader $http "X-UIPATH-TenantName" "{{tenantName}}"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/odata/Machines" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

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

# {
#   "@odata.context": "https://platform.uipath.com/odata/$metadata#Machines",
#   "@odata.count": 2,
#   "value": [
#     {
#       "LicenseKey": null,
#       "Name": "FAKEMACHINE",
#       "Type": "Standard",
#       "NonProductionSlots": 0,
#       "UnattendedSlots": 0,
#       "Id": 20979,
#       "RobotVersions": [
#         {
#           "Count": 1,
#           "Version": null
#         }
#       ]
#     },
#     {
#       "LicenseKey": null,
#       "Name": "AnotherFakeOne",
#       "Type": "Standard",
#       "NonProductionSlots": 0,
#       "UnattendedSlots": 0,
#       "Id": 20967,
#       "RobotVersions": [
#         {
#           "Count": 1,
#           "Version": null
#         }
#       ]
#     }
#   ]
# }

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

set odata_context [CkJsonObject_stringOf $jResp "\"@odata.context\""]
set odata_count [CkJsonObject_IntOf $jResp "\"@odata.count\""]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "value"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set LicenseKey [CkJsonObject_stringOf $jResp "value[i].LicenseKey"]
    set Name [CkJsonObject_stringOf $jResp "value[i].Name"]
    set v_Type [CkJsonObject_stringOf $jResp "value[i].Type"]
    set NonProductionSlots [CkJsonObject_IntOf $jResp "value[i].NonProductionSlots"]
    set UnattendedSlots [CkJsonObject_IntOf $jResp "value[i].UnattendedSlots"]
    set Id [CkJsonObject_IntOf $jResp "value[i].Id"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "value[i].RobotVersions"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set Count [CkJsonObject_IntOf $jResp "value[i].RobotVersions[j].Count"]
        set Version [CkJsonObject_stringOf $jResp "value[i].RobotVersions[j].Version"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

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

Postman Collection Item JSON

{
  "name": "Machines - Get All",
  "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/Machines",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Machines"
      ]
    }
  },
  "response": [
    {
      "name": "Machines - Get All",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{url}}/odata/Machines",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Machines"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 10 Dec 2018 20:49:05 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Content-Length",
          "value": "347"
        },
        {
          "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": "487293786b66c5f2-EWR"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Machines\",\n    \"@odata.count\": 2,\n    \"value\": [\n        {\n            \"LicenseKey\": null,\n            \"Name\": \"FAKEMACHINE\",\n            \"Type\": \"Standard\",\n            \"NonProductionSlots\": 0,\n            \"UnattendedSlots\": 0,\n            \"Id\": 20979,\n            \"RobotVersions\": [\n                {\n                    \"Count\": 1,\n                    \"Version\": null\n                }\n            ]\n        },\n        {\n            \"LicenseKey\": null,\n            \"Name\": \"AnotherFakeOne\",\n            \"Type\": \"Standard\",\n            \"NonProductionSlots\": 0,\n            \"UnattendedSlots\": 0,\n            \"Id\": 20967,\n            \"RobotVersions\": [\n                {\n                    \"Count\": 1,\n                    \"Version\": null\n                }\n            ]\n        }\n    ]\n}"
    }
  ]
}