Swift3 / Orchestrator / 3. Robots - Get by name
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
let queryParams = CkoJsonObject()!
queryParams.update("$filter", value: "Name eq 'joe'")
http.setRequestHeader("Content-Type", value: "application/json")
// Adds the "Authorization: Bearer <access_token>" header.
http.authToken = "<access_token>"
http.setRequestHeader("X-UIPATH-OrganizationUnitId", value: "{{folderId}}")
http.setRequestHeader("X-UIPATH-TenantName", value: "{{tenantName}}")
var resp: CkoHttpResponse? = http.quickRequestParams("GET", url: "https://domain.com/odata/Robots", json: queryParams)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jResp = CkoJsonObject()!
jResp.loadSb(sbResponseBody)
jResp.emitCompact = false
print("Response Body:")
print("\(jResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var LicenseKey: String?
var MachineName: String?
var MachineId: Int
var Name: String?
var Username: String?
var Description: String?
var Version: String?
var v_Type: String?
var HostingType: String?
var Password: String?
var CredentialType: String?
var RobotEnvironments: String?
var Id: Int
var ExecutionSettings: String?
var odata_context: String? = jResp.string(of: "\"@odata.context\"")
var odata_count: Int = jResp.int(of: "\"@odata.count\"").intValue
var i: Int = 0
var count_i: Int = jResp.size(ofArray: "value").intValue
while i < count_i {
jResp.i = i
LicenseKey = jResp.string(of: "value[i].LicenseKey")
MachineName = jResp.string(of: "value[i].MachineName")
MachineId = jResp.int(of: "value[i].MachineId").intValue
Name = jResp.string(of: "value[i].Name")
Username = jResp.string(of: "value[i].Username")
Description = jResp.string(of: "value[i].Description")
Version = jResp.string(of: "value[i].Version")
v_Type = jResp.string(of: "value[i].Type")
HostingType = jResp.string(of: "value[i].HostingType")
Password = jResp.string(of: "value[i].Password")
CredentialType = jResp.string(of: "value[i].CredentialType")
RobotEnvironments = jResp.string(of: "value[i].RobotEnvironments")
Id = jResp.int(of: "value[i].Id").intValue
ExecutionSettings = jResp.string(of: "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}"
}
]
}
