Chilkat Online Tools

Ruby / Orchestrator / Assets - Get all

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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 = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/odata/Assets",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

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

# {
#   "@odata.context": "https://platform.uipath.com/deanmauro/dean/odata/$metadata#Assets",
#   "@odata.count": 15,
#   "value": [
#     {
#       "Name": "Asset 2",
#       "CanBeDeleted": true,
#       "ValueScope": "Global",
#       "ValueType": "Text",
#       "Value": "I would not, Cassius, yet I love him well.",
#       "StringValue": "I would not, Cassius, yet I love him well.",
#       "BoolValue": false,
#       "IntValue": 0,
#       "CredentialUsername": "",
#       "CredentialPassword": "",
#       "ExternalName": "",
#       "CredentialStoreId": null,
#       "HasDefaultValue": true,
#       "Description": null,
#       "Id": 8558,
#       "KeyValueList": [
#       ]
#     },
#     {
#       "Name": "blah",
#       "CanBeDeleted": true,
#       "ValueScope": "PerRobot",
#       "ValueType": "Integer",
#       "Value": null,
#       "StringValue": "",
#       "BoolValue": false,
#       "IntValue": 0,
#       "CredentialUsername": "",
#       "CredentialPassword": "",
#       "ExternalName": "",
#       "CredentialStoreId": null,
#       "HasDefaultValue": false,
#       "Description": null,
#       "Id": 23446,
#       "KeyValueList": [
#       ]
#     },
#     {
#       "Name": "Caesar",
#       "CanBeDeleted": true,
#       "ValueScope": "Global",
#       "ValueType": "Text",
#       "Value": "Et tu Asset 2",
#       "StringValue": "Et tu Asset 2",
#       "BoolValue": false,
#       "IntValue": 0,
#       "CredentialUsername": "",
#       "CredentialPassword": "",
#       "ExternalName": "",
#       "CredentialStoreId": null,
#       "HasDefaultValue": true,
#       "Description": null,
#       "Id": 8735,
#       "KeyValueList": [
#       ]
#     }
#   ]
# }

# 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")
    CanBeDeleted = jResp.BoolOf("value[i].CanBeDeleted")
    ValueScope = jResp.stringOf("value[i].ValueScope")
    ValueType = jResp.stringOf("value[i].ValueType")
    Value = jResp.stringOf("value[i].Value")
    StringValue = jResp.stringOf("value[i].StringValue")
    BoolValue = jResp.BoolOf("value[i].BoolValue")
    IntValue = jResp.IntOf("value[i].IntValue")
    CredentialUsername = jResp.stringOf("value[i].CredentialUsername")
    CredentialPassword = jResp.stringOf("value[i].CredentialPassword")
    ExternalName = jResp.stringOf("value[i].ExternalName")
    CredentialStoreId = jResp.stringOf("value[i].CredentialStoreId")
    HasDefaultValue = jResp.BoolOf("value[i].HasDefaultValue")
    Description = jResp.stringOf("value[i].Description")
    Id = jResp.IntOf("value[i].Id")
    j = 0
    count_j = jResp.SizeOfArray("value[i].KeyValueList")
    while j < count_j
        jResp.put_J(j)
        j = j + 1
    end
    i = i + 1
end

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "X-UIPATH-TenantName: {{tenantName}}"
	-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Assets

Postman Collection Item JSON

{
  "name": "Assets - Get all",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "X-UIPATH-TenantName",
        "value": "{{tenantName}}",
        "type": "text"
      },
      {
        "key": "X-UIPATH-OrganizationUnitId",
        "value": "{{folderId}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{url}}/odata/Assets",
      "host": [
        "{{url}}"
      ],
      "path": [
        "odata",
        "Assets"
      ]
    },
    "description": "Get all Assets. Use query params to narrow the response group."
  },
  "response": [
    {
      "name": "Assets - Get all",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "X-UIPATH-TenantName",
            "value": "{{tenantName}}",
            "type": "text"
          },
          {
            "key": "X-UIPATH-OrganizationUnitId",
            "value": "{{folderId}}",
            "type": "text"
          }
        ],
        "url": {
          "raw": "{{url}}/odata/Assets",
          "host": [
            "{{url}}"
          ],
          "path": [
            "odata",
            "Assets"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Fri, 13 Dec 2019 18:47:31 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; odata.metadata=minimal"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "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": "api-supported-versions",
          "value": "9.0"
        },
        {
          "key": "OData-Version",
          "value": "4.0"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Frame-Options",
          "value": "DENY"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=31536000; includeSubDomains"
        },
        {
          "key": "CF-Cache-Status",
          "value": "DYNAMIC"
        },
        {
          "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": "544a1b60c919f019-EWR"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"@odata.context\": \"https://platform.uipath.com/deanmauro/dean/odata/$metadata#Assets\",\n    \"@odata.count\": 15,\n    \"value\": [\n        {\n            \"Name\": \"Asset 2\",\n            \"CanBeDeleted\": true,\n            \"ValueScope\": \"Global\",\n            \"ValueType\": \"Text\",\n            \"Value\": \"I would not, Cassius, yet I love him well.\",\n            \"StringValue\": \"I would not, Cassius, yet I love him well.\",\n            \"BoolValue\": false,\n            \"IntValue\": 0,\n            \"CredentialUsername\": \"\",\n            \"CredentialPassword\": \"\",\n            \"ExternalName\": \"\",\n            \"CredentialStoreId\": null,\n            \"HasDefaultValue\": true,\n            \"Description\": null,\n            \"Id\": 8558,\n            \"KeyValueList\": []\n        },\n        {\n            \"Name\": \"blah\",\n            \"CanBeDeleted\": true,\n            \"ValueScope\": \"PerRobot\",\n            \"ValueType\": \"Integer\",\n            \"Value\": null,\n            \"StringValue\": \"\",\n            \"BoolValue\": false,\n            \"IntValue\": 0,\n            \"CredentialUsername\": \"\",\n            \"CredentialPassword\": \"\",\n            \"ExternalName\": \"\",\n            \"CredentialStoreId\": null,\n            \"HasDefaultValue\": false,\n            \"Description\": null,\n            \"Id\": 23446,\n            \"KeyValueList\": []\n        },\n        {\n            \"Name\": \"Caesar\",\n            \"CanBeDeleted\": true,\n            \"ValueScope\": \"Global\",\n            \"ValueType\": \"Text\",\n            \"Value\": \"Et tu Asset 2\",\n            \"StringValue\": \"Et tu Asset 2\",\n            \"BoolValue\": false,\n            \"IntValue\": 0,\n            \"CredentialUsername\": \"\",\n            \"CredentialPassword\": \"\",\n            \"ExternalName\": \"\",\n            \"CredentialStoreId\": null,\n            \"HasDefaultValue\": true,\n            \"Description\": null,\n            \"Id\": 8735,\n            \"KeyValueList\": []\n        }\n    ]\n}"
    }
  ]
}