C / Orchestrator / 3. Robots - Get by name
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *LicenseKey;
const char *MachineName;
int MachineId;
const char *Name;
const char *Username;
const char *Description;
const char *Version;
const char *v_Type;
const char *HostingType;
const char *Password;
const char *CredentialType;
const char *RobotEnvironments;
int Id;
const char *ExecutionSettings;
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();
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"$filter","Name eq 'joe'");
CkHttp_SetRequestHeader(http,"Content-Type","application/json");
// 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}}");
resp = CkHttp_QuickRequestParams(http,"GET","https://domain.com/odata/Robots",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "@odata.context": "https://platform.uipath.com/odata/$metadata#Robots",
// "@odata.count": 1,
// "value": [
// {
// "LicenseKey": null,
// "MachineName": "SOMELAPTOP",
// "MachineId": 09876,
// "Name": "joe",
// "Username": "dean",
// "Description": null,
// "Version": "undeclared",
// "Type": "Development",
// "HostingType": "Standard",
// "Password": null,
// "CredentialType": null,
// "RobotEnvironments": "playground",
// "Id": 12345,
// "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.
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);
LicenseKey = CkJsonObject_stringOf(jResp,"value[i].LicenseKey");
MachineName = CkJsonObject_stringOf(jResp,"value[i].MachineName");
MachineId = CkJsonObject_IntOf(jResp,"value[i].MachineId");
Name = CkJsonObject_stringOf(jResp,"value[i].Name");
Username = CkJsonObject_stringOf(jResp,"value[i].Username");
Description = CkJsonObject_stringOf(jResp,"value[i].Description");
Version = CkJsonObject_stringOf(jResp,"value[i].Version");
v_Type = CkJsonObject_stringOf(jResp,"value[i].Type");
HostingType = CkJsonObject_stringOf(jResp,"value[i].HostingType");
Password = CkJsonObject_stringOf(jResp,"value[i].Password");
CredentialType = CkJsonObject_stringOf(jResp,"value[i].CredentialType");
RobotEnvironments = CkJsonObject_stringOf(jResp,"value[i].RobotEnvironments");
Id = CkJsonObject_IntOf(jResp,"value[i].Id");
ExecutionSettings = CkJsonObject_stringOf(jResp,"value[i].ExecutionSettings");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -G -d "$filter=Name%20eq%20%27joe%27"
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-H "X-UIPATH-TenantName: {{tenantName}}"
-H "X-UIPATH-OrganizationUnitId: {{folderId}}"
https://domain.com/odata/Robots
Postman Collection Item JSON
{
"name": "3. Robots - Get by name",
"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/Robots?$filter=Name eq 'joe'",
"host": [
"{{url}}"
],
"path": [
"odata",
"Robots"
],
"query": [
{
"key": "$filter",
"value": "Name eq 'joe'"
}
]
},
"description": "If you'd like the process to run on a specific **Robot**, you'll need its ID. Similarly to step 2, within the URL, replace `joe` with the name of your robot. Save the returned `Id` for step 4."
},
"response": [
{
"name": "3. Get the Robot",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"url": {
"raw": "{{url}}/odata/Robots?$filter=Name eq 'joe'",
"host": [
"{{url}}"
],
"path": [
"odata",
"Robots"
],
"query": [
{
"key": "$filter",
"value": "Name eq 'joe'"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 03 Jul 2019 22:47:45 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": "8.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": "Set-Cookie",
"value": "; SameSite=lax"
},
{
"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": "4f0c67296ee7d318-ATL"
}
],
"cookie": [
],
"body": "{\n \"@odata.context\": \"https://platform.uipath.com/odata/$metadata#Robots\",\n \"@odata.count\": 1,\n \"value\": [\n {\n \"LicenseKey\": null,\n \"MachineName\": \"SOMELAPTOP\",\n \"MachineId\": 09876,\n \"Name\": \"joe\",\n \"Username\": \"dean\",\n \"Description\": null,\n \"Version\": \"undeclared\",\n \"Type\": \"Development\",\n \"HostingType\": \"Standard\",\n \"Password\": null,\n \"CredentialType\": null,\n \"RobotEnvironments\": \"playground\",\n \"Id\": 12345,\n \"ExecutionSettings\": null\n }\n ]\n}"
}
]
}
