Chilkat Online Tools

PowerBuilder / Orchestrator / Assets - Get all

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Name
integer li_CanBeDeleted
string ls_ValueScope
string ls_ValueType
string ls_Value
string ls_StringValue
integer li_BoolValue
integer li_IntValue
string ls_CredentialUsername
string ls_CredentialPassword
string ls_ExternalName
string ls_CredentialStoreId
integer li_HasDefaultValue
string ls_Description
integer li_Id
integer j
integer li_Count_j
string ls_Odata_context
integer li_Odata_count
integer i
integer li_Count_i

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("X-UIPATH-OrganizationUnitId","{{folderId}}")
loo_Http.SetRequestHeader("X-UIPATH-TenantName","{{tenantName}}")

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://domain.com/odata/Assets",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

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

ls_Odata_context = loo_JResp.StringOf("~"@odata.context~"")
li_Odata_count = loo_JResp.IntOf("~"@odata.count~"")
i = 0
li_Count_i = loo_JResp.SizeOfArray("value")
do while i < li_Count_i
    loo_JResp.I = i
    ls_Name = loo_JResp.StringOf("value[i].Name")
    li_CanBeDeleted = loo_JResp.BoolOf("value[i].CanBeDeleted")
    ls_ValueScope = loo_JResp.StringOf("value[i].ValueScope")
    ls_ValueType = loo_JResp.StringOf("value[i].ValueType")
    ls_Value = loo_JResp.StringOf("value[i].Value")
    ls_StringValue = loo_JResp.StringOf("value[i].StringValue")
    li_BoolValue = loo_JResp.BoolOf("value[i].BoolValue")
    li_IntValue = loo_JResp.IntOf("value[i].IntValue")
    ls_CredentialUsername = loo_JResp.StringOf("value[i].CredentialUsername")
    ls_CredentialPassword = loo_JResp.StringOf("value[i].CredentialPassword")
    ls_ExternalName = loo_JResp.StringOf("value[i].ExternalName")
    ls_CredentialStoreId = loo_JResp.StringOf("value[i].CredentialStoreId")
    li_HasDefaultValue = loo_JResp.BoolOf("value[i].HasDefaultValue")
    ls_Description = loo_JResp.StringOf("value[i].Description")
    li_Id = loo_JResp.IntOf("value[i].Id")
    j = 0
    li_Count_j = loo_JResp.SizeOfArray("value[i].KeyValueList")
    do while j < li_Count_j
        loo_JResp.J = j
        j = j + 1
    loop
    i = i + 1
loop


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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