phpAx / Orchestrator / 3. Robots - Get by name
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new COM("Chilkat_9_5_0.Http");
$queryParams = new COM("Chilkat_9_5_0.JsonObject");
$queryParams->UpdateString('$filter','Name eq 'joe'');
$http->SetRequestHeader('Content-Type','application/json');
// Adds the "Authorization: Bearer <access_token>" header.
$http->AuthToken = '<access_token>';
$http->SetRequestHeader('X-UIPATH-OrganizationUnitId','{{folderId}}');
$http->SetRequestHeader('X-UIPATH-TenantName','{{tenantName}}');
// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->QuickRequestParams('GET','https://domain.com/odata/Robots',$queryParams);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);
$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// 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
$odata_context = $jResp->stringOf('\'@odata.context\'');
$odata_count = $jResp->IntOf('\'@odata.count\'');
$i = 0;
$count_i = $jResp->SizeOfArray('value');
while ($i < $count_i) {
$jResp->I = $i;
$LicenseKey = $jResp->stringOf('value[i].LicenseKey');
$MachineName = $jResp->stringOf('value[i].MachineName');
$MachineId = $jResp->IntOf('value[i].MachineId');
$Name = $jResp->stringOf('value[i].Name');
$Username = $jResp->stringOf('value[i].Username');
$Description = $jResp->stringOf('value[i].Description');
$Version = $jResp->stringOf('value[i].Version');
$v_Type = $jResp->stringOf('value[i].Type');
$HostingType = $jResp->stringOf('value[i].HostingType');
$Password = $jResp->stringOf('value[i].Password');
$CredentialType = $jResp->stringOf('value[i].CredentialType');
$RobotEnvironments = $jResp->stringOf('value[i].RobotEnvironments');
$Id = $jResp->IntOf('value[i].Id');
$ExecutionSettings = $jResp->stringOf('value[i].ExecutionSettings');
$i = $i + 1;
}
?>
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}"
}
]
}
