unicodeCpp / Orchestrator / Environments - Get all
Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
CkJsonObjectW queryParams;
queryParams.UpdateString(L"$expand",L"Robots");
http.SetRequestHeader(L"Content-Type",L"application/json");
// Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken(L"<access_token>");
http.SetRequestHeader(L"X-UIPATH-OrganizationUnitId",L"{{folderId}}");
http.SetRequestHeader(L"X-UIPATH-TenantName",L"{{tenantName}}");
CkHttpResponseW *resp = http.QuickRequestParams(L"GET",L"https://domain.com/odata/Environments",queryParams);
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = resp->get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp->header());
wprintf(L"Failed.\n");
delete resp;
return;
}
delete resp;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "@odata.context": "https://platform.uipath.com/odata/$metadata#Environments",
// "@odata.count": 1,
// "value": [
// {
// "Name": "playground",
// "Description": "Test environment for postman",
// "Type": "Dev",
// "Id": 23282,
// "Robots": [
// {
// "LicenseKey": null,
// "MachineName": "AnotherFakeOne",
// "MachineId": 20967,
// "Name": "Cassius",
// "Username": "cassius",
// "Description": "A dev bot for testing",
// "Version": null,
// "Type": "Development",
// "HostingType": "Standard",
// "Password": null,
// "CredentialType": null,
// "RobotEnvironments": "",
// "Id": 33420,
// "ExecutionSettings": null
// }
// ]
// }
// ]
// }
// 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.
const wchar_t *Name = 0;
const wchar_t *Description = 0;
const wchar_t *v_Type = 0;
int Id;
int j;
int count_j;
const wchar_t *LicenseKey = 0;
const wchar_t *MachineName = 0;
int MachineId;
const wchar_t *Username = 0;
const wchar_t *Version = 0;
const wchar_t *HostingType = 0;
const wchar_t *Password = 0;
const wchar_t *CredentialType = 0;
const wchar_t *RobotEnvironments = 0;
const wchar_t *ExecutionSettings = 0;
const wchar_t *odata_context = jResp.stringOf(L"\"@odata.context\"");
int odata_count = jResp.IntOf(L"\"@odata.count\"");
int i = 0;
int count_i = jResp.SizeOfArray(L"value");
while (i < count_i) {
jResp.put_I(i);
Name = jResp.stringOf(L"value[i].Name");
Description = jResp.stringOf(L"value[i].Description");
v_Type = jResp.stringOf(L"value[i].Type");
Id = jResp.IntOf(L"value[i].Id");
j = 0;
count_j = jResp.SizeOfArray(L"value[i].Robots");
while (j < count_j) {
jResp.put_J(j);
LicenseKey = jResp.stringOf(L"value[i].Robots[j].LicenseKey");
MachineName = jResp.stringOf(L"value[i].Robots[j].MachineName");
MachineId = jResp.IntOf(L"value[i].Robots[j].MachineId");
Name = jResp.stringOf(L"value[i].Robots[j].Name");
Username = jResp.stringOf(L"value[i].Robots[j].Username");
Description = jResp.stringOf(L"value[i].Robots[j].Description");
Version = jResp.stringOf(L"value[i].Robots[j].Version");
v_Type = jResp.stringOf(L"value[i].Robots[j].Type");
HostingType = jResp.stringOf(L"value[i].Robots[j].HostingType");
Password = jResp.stringOf(L"value[i].Robots[j].Password");
CredentialType = jResp.stringOf(L"value[i].Robots[j].CredentialType");
RobotEnvironments = jResp.stringOf(L"value[i].Robots[j].RobotEnvironments");
Id = jResp.IntOf(L"value[i].Robots[j].Id");
ExecutionSettings = jResp.stringOf(L"value[i].Robots[j].ExecutionSettings");
j = j + 1;
}
i = i + 1;
}
}
Curl Command
curl -G -d "$expand=Robots"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "X-UIPATH-TenantName: {{tenantName}}"
-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Environments
Postman Collection Item JSON
{
"name": "Environments - Get all",
"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/Environments?$expand=Robots",
"host": [
"{{url}}"
],
"path": [
"odata",
"Environments"
],
"query": [
{
"key": "$expand",
"value": "Robots"
}
]
},
"description": "Get all Assets. Use query params to narrow the response group."
},
"response": [
{
"name": "Environments - Get all",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{url}}/odata/Environments?$expand=Robots",
"host": [
"{{url}}"
],
"path": [
"odata",
"Environments"
],
"query": [
{
"key": "$expand",
"value": "Robots"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Thu, 14 Feb 2019 18:01:11 GMT"
},
{
"key": "Content-Type",
"value": "application/json; odata.metadata=minimal"
},
{
"key": "Content-Length",
"value": "443"
},
{
"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": "Set-Cookie",
"value": "; SameSite=lax"
},
{
"key": "api-supported-versions",
"value": "7.0"
},
{
"key": "OData-Version",
"value": "4.0"
},
{
"key": "Request-Context",
"value": "appId=cid-v1:d00ce63d-0891-41e4-a17c-25b2c5382e49"
},
{
"key": "Access-Control-Expose-Headers",
"value": "Request-Context"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains"
},
{
"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": "4a9170480e5297d4-FRA"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Environments\",\n \"@odata.count\": 1,\n \"value\": [\n {\n \"Name\": \"playground\",\n \"Description\": \"Test environment for postman\",\n \"Type\": \"Dev\",\n \"Id\": 23282,\n \"Robots\": [\n {\n \"LicenseKey\": null,\n \"MachineName\": \"AnotherFakeOne\",\n \"MachineId\": 20967,\n \"Name\": \"Cassius\",\n \"Username\": \"cassius\",\n \"Description\": \"A dev bot for testing\",\n \"Version\": null,\n \"Type\": \"Development\",\n \"HostingType\": \"Standard\",\n \"Password\": null,\n \"CredentialType\": null,\n \"RobotEnvironments\": \"\",\n \"Id\": 33420,\n \"ExecutionSettings\": null\n }\n ]\n }\n ]\n}"
}
]
}
