Chilkat Online Tools

SQL Server / Orchestrator / Assets - Get all

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-UIPATH-OrganizationUnitId', '{{folderId}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-UIPATH-TenantName', '{{tenantName}}'

    DECLARE @sbResponseBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/odata/Assets', @sbResponseBody
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END

    DECLARE @jResp int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      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

    DECLARE @Name nvarchar(4000)

    DECLARE @CanBeDeleted int

    DECLARE @ValueScope nvarchar(4000)

    DECLARE @ValueType nvarchar(4000)

    DECLARE @Value nvarchar(4000)

    DECLARE @StringValue nvarchar(4000)

    DECLARE @BoolValue int

    DECLARE @IntValue int

    DECLARE @CredentialUsername nvarchar(4000)

    DECLARE @CredentialPassword nvarchar(4000)

    DECLARE @ExternalName nvarchar(4000)

    DECLARE @CredentialStoreId nvarchar(4000)

    DECLARE @HasDefaultValue int

    DECLARE @Description nvarchar(4000)

    DECLARE @Id int

    DECLARE @j int

    DECLARE @count_j int

    DECLARE @odata_context nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @odata_context OUT, '"@odata.context"'
    DECLARE @odata_count int
    EXEC sp_OAMethod @jResp, 'IntOf', @odata_count OUT, '"@odata.count"'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'value'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'value[i].Name'
        EXEC sp_OAMethod @jResp, 'BoolOf', @CanBeDeleted OUT, 'value[i].CanBeDeleted'
        EXEC sp_OAMethod @jResp, 'StringOf', @ValueScope OUT, 'value[i].ValueScope'
        EXEC sp_OAMethod @jResp, 'StringOf', @ValueType OUT, 'value[i].ValueType'
        EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'value[i].Value'
        EXEC sp_OAMethod @jResp, 'StringOf', @StringValue OUT, 'value[i].StringValue'
        EXEC sp_OAMethod @jResp, 'BoolOf', @BoolValue OUT, 'value[i].BoolValue'
        EXEC sp_OAMethod @jResp, 'IntOf', @IntValue OUT, 'value[i].IntValue'
        EXEC sp_OAMethod @jResp, 'StringOf', @CredentialUsername OUT, 'value[i].CredentialUsername'
        EXEC sp_OAMethod @jResp, 'StringOf', @CredentialPassword OUT, 'value[i].CredentialPassword'
        EXEC sp_OAMethod @jResp, 'StringOf', @ExternalName OUT, 'value[i].ExternalName'
        EXEC sp_OAMethod @jResp, 'StringOf', @CredentialStoreId OUT, 'value[i].CredentialStoreId'
        EXEC sp_OAMethod @jResp, 'BoolOf', @HasDefaultValue OUT, 'value[i].HasDefaultValue'
        EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'value[i].Description'
        EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'value[i].Id'
        SELECT @j = 0
        EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'value[i].KeyValueList'
        WHILE @j < @count_j
          BEGIN
            EXEC sp_OASetProperty @jResp, 'J', @j
            SELECT @j = @j + 1
          END
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

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