DataFlex / Orchestrator / Assets - Get all + Per Robot Values
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
Boolean iCanBeDeleted
String sValueScope
String sValueType
String sValue
String sStringValue
Boolean iBoolValue
Integer iIntValue
String sCredentialUsername
String sCredentialPassword
String sExternalName
String sCredentialStoreId
Boolean iHasDefaultValue
String sDescription
Integer iId
Integer j
Integer iCount_j
Integer iRobotId
String sRobotName
String sKeyTrail
Integer k
Integer iCount_k
String sOdata_context
Integer iOdata_count
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "$expand" "RobotValues" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "X-UIPATH-OrganizationUnitId" "{{folderId}}"
Send ComSetRequestHeader To hoHttp "X-UIPATH-TenantName" "{{tenantName}}"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://domain.com/odata/Assets" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp '"@odata.context"' To sOdata_context
Get ComIntOf Of hoJResp '"@odata.count"' To iOdata_count
Move 0 To i
Get ComSizeOfArray Of hoJResp "value" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "value[i].Name" To sName
Get ComBoolOf Of hoJResp "value[i].CanBeDeleted" To iCanBeDeleted
Get ComStringOf Of hoJResp "value[i].ValueScope" To sValueScope
Get ComStringOf Of hoJResp "value[i].ValueType" To sValueType
Get ComStringOf Of hoJResp "value[i].Value" To sValue
Get ComStringOf Of hoJResp "value[i].StringValue" To sStringValue
Get ComBoolOf Of hoJResp "value[i].BoolValue" To iBoolValue
Get ComIntOf Of hoJResp "value[i].IntValue" To iIntValue
Get ComStringOf Of hoJResp "value[i].CredentialUsername" To sCredentialUsername
Get ComStringOf Of hoJResp "value[i].CredentialPassword" To sCredentialPassword
Get ComStringOf Of hoJResp "value[i].ExternalName" To sExternalName
Get ComStringOf Of hoJResp "value[i].CredentialStoreId" To sCredentialStoreId
Get ComBoolOf Of hoJResp "value[i].HasDefaultValue" To iHasDefaultValue
Get ComStringOf Of hoJResp "value[i].Description" To sDescription
Get ComIntOf Of hoJResp "value[i].Id" To iId
Move 0 To j
Get ComSizeOfArray Of hoJResp "value[i].KeyValueList" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "value[i].RobotValues" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComIntOf Of hoJResp "value[i].RobotValues[j].RobotId" To iRobotId
Get ComStringOf Of hoJResp "value[i].RobotValues[j].RobotName" To sRobotName
Get ComStringOf Of hoJResp "value[i].RobotValues[j].KeyTrail" To sKeyTrail
Get ComStringOf Of hoJResp "value[i].RobotValues[j].ValueType" To sValueType
Get ComStringOf Of hoJResp "value[i].RobotValues[j].StringValue" To sStringValue
Get ComBoolOf Of hoJResp "value[i].RobotValues[j].BoolValue" To iBoolValue
Get ComIntOf Of hoJResp "value[i].RobotValues[j].IntValue" To iIntValue
Get ComStringOf Of hoJResp "value[i].RobotValues[j].Value" To sValue
Get ComStringOf Of hoJResp "value[i].RobotValues[j].CredentialUsername" To sCredentialUsername
Get ComStringOf Of hoJResp "value[i].RobotValues[j].CredentialPassword" To sCredentialPassword
Get ComStringOf Of hoJResp "value[i].RobotValues[j].ExternalName" To sExternalName
Get ComStringOf Of hoJResp "value[i].RobotValues[j].CredentialStoreId" To sCredentialStoreId
Get ComIntOf Of hoJResp "value[i].RobotValues[j].Id" To iId
Move 0 To k
Get ComSizeOfArray Of hoJResp "value[i].RobotValues[j].KeyValueList" To iCount_k
While (k < iCount_k)
Set ComK Of hoJResp To k
Move (k + 1) To k
Loop
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
