PureBasic / Orchestrator / Assets - Get all + Per Robot Values
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"$expand","RobotValues")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"X-UIPATH-OrganizationUnitId","{{folderId}}")
CkHttp::ckSetRequestHeader(http,"X-UIPATH-TenantName","{{tenantName}}")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/odata/Assets",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
Name.s
CanBeDeleted.i
ValueScope.s
ValueType.s
Value.s
StringValue.s
BoolValue.i
IntValue.i
CredentialUsername.s
CredentialPassword.s
ExternalName.s
CredentialStoreId.s
HasDefaultValue.i
Description.s
Id.i
j.i
count_j.i
RobotId.i
RobotName.s
KeyTrail.s
k.i
count_k.i
odata_context.s = CkJsonObject::ckStringOf(jResp,Chr(34) + "@odata.context" + Chr(34))
odata_count.i = CkJsonObject::ckIntOf(jResp,Chr(34) + "@odata.count" + Chr(34))
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"value")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Name = CkJsonObject::ckStringOf(jResp,"value[i].Name")
CanBeDeleted = CkJsonObject::ckBoolOf(jResp,"value[i].CanBeDeleted")
ValueScope = CkJsonObject::ckStringOf(jResp,"value[i].ValueScope")
ValueType = CkJsonObject::ckStringOf(jResp,"value[i].ValueType")
Value = CkJsonObject::ckStringOf(jResp,"value[i].Value")
StringValue = CkJsonObject::ckStringOf(jResp,"value[i].StringValue")
BoolValue = CkJsonObject::ckBoolOf(jResp,"value[i].BoolValue")
IntValue = CkJsonObject::ckIntOf(jResp,"value[i].IntValue")
CredentialUsername = CkJsonObject::ckStringOf(jResp,"value[i].CredentialUsername")
CredentialPassword = CkJsonObject::ckStringOf(jResp,"value[i].CredentialPassword")
ExternalName = CkJsonObject::ckStringOf(jResp,"value[i].ExternalName")
CredentialStoreId = CkJsonObject::ckStringOf(jResp,"value[i].CredentialStoreId")
HasDefaultValue = CkJsonObject::ckBoolOf(jResp,"value[i].HasDefaultValue")
Description = CkJsonObject::ckStringOf(jResp,"value[i].Description")
Id = CkJsonObject::ckIntOf(jResp,"value[i].Id")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"value[i].KeyValueList")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"value[i].RobotValues")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
RobotId = CkJsonObject::ckIntOf(jResp,"value[i].RobotValues[j].RobotId")
RobotName = CkJsonObject::ckStringOf(jResp,"value[i].RobotValues[j].RobotName")
KeyTrail = CkJsonObject::ckStringOf(jResp,"value[i].RobotValues[j].KeyTrail")
ValueType = CkJsonObject::ckStringOf(jResp,"value[i].RobotValues[j].ValueType")
StringValue = CkJsonObject::ckStringOf(jResp,"value[i].RobotValues[j].StringValue")
BoolValue = CkJsonObject::ckBoolOf(jResp,"value[i].RobotValues[j].BoolValue")
IntValue = CkJsonObject::ckIntOf(jResp,"value[i].RobotValues[j].IntValue")
Value = CkJsonObject::ckStringOf(jResp,"value[i].RobotValues[j].Value")
CredentialUsername = CkJsonObject::ckStringOf(jResp,"value[i].RobotValues[j].CredentialUsername")
CredentialPassword = CkJsonObject::ckStringOf(jResp,"value[i].RobotValues[j].CredentialPassword")
ExternalName = CkJsonObject::ckStringOf(jResp,"value[i].RobotValues[j].ExternalName")
CredentialStoreId = CkJsonObject::ckStringOf(jResp,"value[i].RobotValues[j].CredentialStoreId")
Id = CkJsonObject::ckIntOf(jResp,"value[i].RobotValues[j].Id")
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"value[i].RobotValues[j].KeyValueList")
While k < count_k
CkJsonObject::setCkK(jResp, k)
k = k + 1
Wend
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
