Swift / Orchestrator / Environments - Get all
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.UpdateString("$expand", value: "Robots")
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/Environments", 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#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
var Name: String?
var Description: String?
var v_Type: String?
var Id: Int
var j: Int
var count_j: Int
var LicenseKey: String?
var MachineName: String?
var MachineId: Int
var Username: String?
var Version: String?
var HostingType: String?
var Password: String?
var CredentialType: String?
var RobotEnvironments: String?
var ExecutionSettings: String?
var odata_context: String? = jResp.StringOf("\"@odata.context\"")
var odata_count: Int = jResp.IntOf("\"@odata.count\"").intValue
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("value").intValue
while i < count_i {
jResp.I = i
Name = jResp.StringOf("value[i].Name")
Description = jResp.StringOf("value[i].Description")
v_Type = jResp.StringOf("value[i].Type")
Id = jResp.IntOf("value[i].Id").intValue
j = 0
count_j = jResp.SizeOfArray("value[i].Robots").intValue
while j < count_j {
jResp.J = j
LicenseKey = jResp.StringOf("value[i].Robots[j].LicenseKey")
MachineName = jResp.StringOf("value[i].Robots[j].MachineName")
MachineId = jResp.IntOf("value[i].Robots[j].MachineId").intValue
Name = jResp.StringOf("value[i].Robots[j].Name")
Username = jResp.StringOf("value[i].Robots[j].Username")
Description = jResp.StringOf("value[i].Robots[j].Description")
Version = jResp.StringOf("value[i].Robots[j].Version")
v_Type = jResp.StringOf("value[i].Robots[j].Type")
HostingType = jResp.StringOf("value[i].Robots[j].HostingType")
Password = jResp.StringOf("value[i].Robots[j].Password")
CredentialType = jResp.StringOf("value[i].Robots[j].CredentialType")
RobotEnvironments = jResp.StringOf("value[i].Robots[j].RobotEnvironments")
Id = jResp.IntOf("value[i].Robots[j].Id").intValue
ExecutionSettings = jResp.StringOf("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}"
}
]
}
