Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *Name;
BOOL CanBeDeleted;
const char *ValueScope;
const char *ValueType;
const char *Value;
const char *StringValue;
BOOL BoolValue;
int IntValue;
const char *CredentialUsername;
const char *CredentialPassword;
const char *ExternalName;
const char *CredentialStoreId;
BOOL HasDefaultValue;
const char *Description;
int Id;
int j;
int count_j;
const char *odata_context;
int odata_count;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
CkHttp_SetRequestHeader(http,"X-UIPATH-OrganizationUnitId","{{folderId}}");
CkHttp_SetRequestHeader(http,"X-UIPATH-TenantName","{{tenantName}}");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://domain.com/odata/Assets",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
odata_context = CkJsonObject_stringOf(jResp,"\"@odata.context\"");
odata_count = CkJsonObject_IntOf(jResp,"\"@odata.count\"");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"value");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
Name = CkJsonObject_stringOf(jResp,"value[i].Name");
CanBeDeleted = CkJsonObject_BoolOf(jResp,"value[i].CanBeDeleted");
ValueScope = CkJsonObject_stringOf(jResp,"value[i].ValueScope");
ValueType = CkJsonObject_stringOf(jResp,"value[i].ValueType");
Value = CkJsonObject_stringOf(jResp,"value[i].Value");
StringValue = CkJsonObject_stringOf(jResp,"value[i].StringValue");
BoolValue = CkJsonObject_BoolOf(jResp,"value[i].BoolValue");
IntValue = CkJsonObject_IntOf(jResp,"value[i].IntValue");
CredentialUsername = CkJsonObject_stringOf(jResp,"value[i].CredentialUsername");
CredentialPassword = CkJsonObject_stringOf(jResp,"value[i].CredentialPassword");
ExternalName = CkJsonObject_stringOf(jResp,"value[i].ExternalName");
CredentialStoreId = CkJsonObject_stringOf(jResp,"value[i].CredentialStoreId");
HasDefaultValue = CkJsonObject_BoolOf(jResp,"value[i].HasDefaultValue");
Description = CkJsonObject_stringOf(jResp,"value[i].Description");
Id = CkJsonObject_IntOf(jResp,"value[i].Id");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"value[i].KeyValueList");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
j = j + 1;
}
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
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}"
}
]
}
