SQL Server / Orchestrator / Assets - Get all + Per Robot Values
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
DECLARE @iTmp0 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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, '$expand', 'RobotValues'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
-- 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 @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/odata/Assets', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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 @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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": 2,
-- "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": 8588,
-- "KeyValueList": [
-- ],
-- "RobotValues": [
-- ]
-- },
-- {
-- "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": 23656,
-- "KeyValueList": [
-- ],
-- "RobotValues": [
-- {
-- "RobotId": 33530,
-- "RobotName": "joe",
-- "KeyTrail": "***4ef589a",
-- "ValueType": "Integer",
-- "StringValue": "",
-- "BoolValue": false,
-- "IntValue": 1,
-- "Value": "1",
-- "CredentialUsername": "",
-- "CredentialPassword": "",
-- "ExternalName": "",
-- "CredentialStoreId": null,
-- "Id": 199104,
-- "KeyValueList": [
-- ]
-- },
-- {
-- "RobotId": 42307,
-- "RobotName": "jose",
-- "KeyTrail": "***88bvb04",
-- "ValueType": "Integer",
-- "StringValue": "",
-- "BoolValue": false,
-- "IntValue": 2,
-- "Value": "2",
-- "CredentialUsername": "",
-- "CredentialPassword": "",
-- "ExternalName": "",
-- "CredentialStoreId": null,
-- "Id": 199105,
-- "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 @RobotId int
DECLARE @RobotName nvarchar(4000)
DECLARE @KeyTrail nvarchar(4000)
DECLARE @k int
DECLARE @count_k 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 @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'value[i].RobotValues'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'IntOf', @RobotId OUT, 'value[i].RobotValues[j].RobotId'
EXEC sp_OAMethod @jResp, 'StringOf', @RobotName OUT, 'value[i].RobotValues[j].RobotName'
EXEC sp_OAMethod @jResp, 'StringOf', @KeyTrail OUT, 'value[i].RobotValues[j].KeyTrail'
EXEC sp_OAMethod @jResp, 'StringOf', @ValueType OUT, 'value[i].RobotValues[j].ValueType'
EXEC sp_OAMethod @jResp, 'StringOf', @StringValue OUT, 'value[i].RobotValues[j].StringValue'
EXEC sp_OAMethod @jResp, 'BoolOf', @BoolValue OUT, 'value[i].RobotValues[j].BoolValue'
EXEC sp_OAMethod @jResp, 'IntOf', @IntValue OUT, 'value[i].RobotValues[j].IntValue'
EXEC sp_OAMethod @jResp, 'StringOf', @Value OUT, 'value[i].RobotValues[j].Value'
EXEC sp_OAMethod @jResp, 'StringOf', @CredentialUsername OUT, 'value[i].RobotValues[j].CredentialUsername'
EXEC sp_OAMethod @jResp, 'StringOf', @CredentialPassword OUT, 'value[i].RobotValues[j].CredentialPassword'
EXEC sp_OAMethod @jResp, 'StringOf', @ExternalName OUT, 'value[i].RobotValues[j].ExternalName'
EXEC sp_OAMethod @jResp, 'StringOf', @CredentialStoreId OUT, 'value[i].RobotValues[j].CredentialStoreId'
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'value[i].RobotValues[j].Id'
SELECT @k = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_k OUT, 'value[i].RobotValues[j].KeyValueList'
WHILE @k < @count_k
BEGIN
EXEC sp_OASetProperty @jResp, 'K', @k
SELECT @k = @k + 1
END
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "$expand=RobotValues"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "X-UIPATH-TenantName: {{tenantName}}"
-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Assets
Postman Collection Item JSON
{
"name": "Assets - Get all + Per Robot Values",
"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/Assets?$expand=RobotValues",
"host": [
"{{url}}"
],
"path": [
"odata",
"Assets"
],
"query": [
{
"key": "$expand",
"value": "RobotValues"
}
]
},
"description": "Get all Assets and display Per Robot values in the response. For global Assets, this call provides no extra features."
},
"response": [
{
"name": "Assets - Get all (Including Per Robot Values)",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{url}}/odata/Assets?$expand=RobotValues",
"host": [
"{{url}}"
],
"path": [
"odata",
"Assets"
],
"query": [
{
"key": "$expand",
"value": "RobotValues"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "CF-RAY",
"value": "443012f809dd91fa-EWR",
"name": "CF-RAY",
"description": "Custom header"
},
{
"key": "Cache-Control",
"value": "no-store, must-revalidate, no-cache, max-age=0",
"name": "Cache-Control",
"description": "Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"
},
{
"key": "Connection",
"value": "keep-alive",
"name": "Connection",
"description": "Options that are desired for the connection"
},
{
"key": "Content-Encoding",
"value": "gzip",
"name": "Content-Encoding",
"description": "The type of encoding used on the data."
},
{
"key": "Content-Length",
"value": "588",
"name": "Content-Length",
"description": "The length of the response body in octets (8-bit bytes)"
},
{
"key": "Content-Type",
"value": "application/json; odata.metadata=minimal",
"name": "Content-Type",
"description": "The mime type of this content"
},
{
"key": "Date",
"value": "Tue, 31 Jul 2018 12:30:03 GMT",
"name": "Date",
"description": "The date and time that the message was sent"
},
{
"key": "Expect-CT",
"value": "max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\"",
"name": "Expect-CT",
"description": "Custom header"
},
{
"key": "OData-Version",
"value": "4.0",
"name": "OData-Version",
"description": "Custom header"
},
{
"key": "Server",
"value": "cloudflare",
"name": "Server",
"description": "A name for the server"
},
{
"key": "Set-Cookie",
"value": "; SameSite=lax",
"name": "Set-Cookie",
"description": "an HTTP cookie"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains",
"name": "Strict-Transport-Security",
"description": "A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."
},
{
"key": "Vary",
"value": "Accept-Encoding",
"name": "Vary",
"description": "Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."
},
{
"key": "X-Content-Type-Options",
"value": "nosniff",
"name": "X-Content-Type-Options",
"description": "The only defined value, \"nosniff\", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type"
},
{
"key": "X-Frame-Options",
"value": "DENY",
"name": "X-Frame-Options",
"description": "Clickjacking protection: \"deny\" - no rendering within a frame, \"sameorigin\" - no rendering if origin mismatch"
},
{
"key": "api-supported-versions",
"value": "5.0",
"name": "api-supported-versions",
"description": "Custom header"
}
],
"cookie": [
{
"expires": "Wed Dec 19 2018 11:35:02 GMT-0600 (Central Standard Time)",
"httpOnly": true,
"domain": "uipath.com",
"path": "/",
"secure": true,
"value": "d3b89a558feb68050f4b847c971f595771513704902",
"key": "__cfduid"
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/QueueProcessingRecords",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/api/RobotsService",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Processes",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Settings",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Robots",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Queues",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Assets",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/api/Account",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Users",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata/Jobs",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/api/Logs",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/Account",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/odata",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/api",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/",
"secure": false,
"value": "",
"key": ""
},
{
"expires": "Mon Jan 18 2038 21:14:07 GMT-0600 (Central Standard Time)",
"httpOnly": false,
"domain": "platform.uipath.com",
"path": "/",
"secure": false,
"value": "GC-osp2U-YDhoXTOqXnUp3DaN1cN_siVCaNVue_jljOcqJLYHQrRk5msz52KHL8XauydRYx_3JyjLtLDpItypCPdEL20jFnxlF2g-f86Qk41",
"key": "__RequestVerificationToken"
}
],
"body": "{\r\n \"@odata.context\": \"https://platform.uipath.com/deanmauro/dean/odata/$metadata#Assets\",\r\n \"@odata.count\": 2,\r\n \"value\": [\r\n {\r\n \"Name\": \"Asset 2\",\r\n \"CanBeDeleted\": true,\r\n \"ValueScope\": \"Global\",\r\n \"ValueType\": \"Text\",\r\n \"Value\": \"I would not, Cassius, yet I love him well.\",\r\n \"StringValue\": \"I would not, Cassius, yet I love him well.\",\r\n \"BoolValue\": false,\r\n \"IntValue\": 0,\r\n \"CredentialUsername\": \"\",\r\n \"CredentialPassword\": \"\",\r\n \"ExternalName\": \"\",\r\n \"CredentialStoreId\": null,\r\n \"HasDefaultValue\": true,\r\n \"Description\": null,\r\n \"Id\": 8588,\r\n \"KeyValueList\": [],\r\n \"RobotValues\": []\r\n },\r\n {\r\n \"Name\": \"blah\",\r\n \"CanBeDeleted\": true,\r\n \"ValueScope\": \"PerRobot\",\r\n \"ValueType\": \"Integer\",\r\n \"Value\": null,\r\n \"StringValue\": \"\",\r\n \"BoolValue\": false,\r\n \"IntValue\": 0,\r\n \"CredentialUsername\": \"\",\r\n \"CredentialPassword\": \"\",\r\n \"ExternalName\": \"\",\r\n \"CredentialStoreId\": null,\r\n \"HasDefaultValue\": false,\r\n \"Description\": null,\r\n \"Id\": 23656,\r\n \"KeyValueList\": [],\r\n \"RobotValues\": [\r\n {\r\n \"RobotId\": 33530,\r\n \"RobotName\": \"joe\",\r\n \"KeyTrail\": \"***4ef589a\",\r\n \"ValueType\": \"Integer\",\r\n \"StringValue\": \"\",\r\n \"BoolValue\": false,\r\n \"IntValue\": 1,\r\n \"Value\": \"1\",\r\n \"CredentialUsername\": \"\",\r\n \"CredentialPassword\": \"\",\r\n \"ExternalName\": \"\",\r\n \"CredentialStoreId\": null,\r\n \"Id\": 199104,\r\n \"KeyValueList\": []\r\n },\r\n {\r\n \"RobotId\": 42307,\r\n \"RobotName\": \"jose\",\r\n \"KeyTrail\": \"***88bvb04\",\r\n \"ValueType\": \"Integer\",\r\n \"StringValue\": \"\",\r\n \"BoolValue\": false,\r\n \"IntValue\": 2,\r\n \"Value\": \"2\",\r\n \"CredentialUsername\": \"\",\r\n \"CredentialPassword\": \"\",\r\n \"ExternalName\": \"\",\r\n \"CredentialStoreId\": null,\r\n \"Id\": 199105,\r\n \"KeyValueList\": []\r\n }\r\n ]\r\n }\r\n ]\r\n}"
}
]
}
