PureBasic / Orchestrator / Assets - Get all
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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
; 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}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/odata/Assets",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
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
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
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
