VB6 / Orchestrator / Environments - Get all
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("$expand","Robots")
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}}"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://domain.com/odata/Environments",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim Name As String
Dim Description As String
Dim v_Type As String
Dim Id As Long
Dim j As Long
Dim count_j As Long
Dim LicenseKey As String
Dim MachineName As String
Dim MachineId As Long
Dim Username As String
Dim Version As String
Dim HostingType As String
Dim Password As String
Dim CredentialType As String
Dim RobotEnvironments As String
Dim ExecutionSettings As String
Dim odata_context As String
odata_context = jResp.StringOf("""@odata.context""")
Dim odata_count As Long
odata_count = jResp.IntOf("""@odata.count""")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("value")
Do 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")
j = 0
count_j = jResp.SizeOfArray("value[i].Robots")
Do 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")
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")
ExecutionSettings = jResp.StringOf("value[i].Robots[j].ExecutionSettings")
j = j + 1
Loop
i = i + 1
Loop
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}"
}
]
}
