autoit / 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.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("$expand","Robots")
$oHttp.SetRequestHeader "Content-Type","application/json"
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "X-UIPATH-OrganizationUnitId","{{folderId}}"
$oHttp.SetRequestHeader "X-UIPATH-TenantName","{{tenantName}}"
Local $oResp = $oHttp.QuickRequestParams("GET","https://domain.com/odata/Environments",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sName
Local $sDescription
Local $sV_Type
Local $iId
Local $iJ
Local $iCount_j
Local $sLicenseKey
Local $sMachineName
Local $iMachineId
Local $sUsername
Local $sVersion
Local $sHostingType
Local $sPassword
Local $sCredentialType
Local $sRobotEnvironments
Local $sExecutionSettings
Local $sOdata_context = $oJResp.StringOf("""@odata.context""")
Local $iOdata_count = $oJResp.IntOf("""@odata.count""")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("value")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("value[i].Name")
$sDescription = $oJResp.StringOf("value[i].Description")
$sV_Type = $oJResp.StringOf("value[i].Type")
$iId = $oJResp.IntOf("value[i].Id")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("value[i].Robots")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sLicenseKey = $oJResp.StringOf("value[i].Robots[j].LicenseKey")
$sMachineName = $oJResp.StringOf("value[i].Robots[j].MachineName")
$iMachineId = $oJResp.IntOf("value[i].Robots[j].MachineId")
$sName = $oJResp.StringOf("value[i].Robots[j].Name")
$sUsername = $oJResp.StringOf("value[i].Robots[j].Username")
$sDescription = $oJResp.StringOf("value[i].Robots[j].Description")
$sVersion = $oJResp.StringOf("value[i].Robots[j].Version")
$sV_Type = $oJResp.StringOf("value[i].Robots[j].Type")
$sHostingType = $oJResp.StringOf("value[i].Robots[j].HostingType")
$sPassword = $oJResp.StringOf("value[i].Robots[j].Password")
$sCredentialType = $oJResp.StringOf("value[i].Robots[j].CredentialType")
$sRobotEnvironments = $oJResp.StringOf("value[i].Robots[j].RobotEnvironments")
$iId = $oJResp.IntOf("value[i].Robots[j].Id")
$sExecutionSettings = $oJResp.StringOf("value[i].Robots[j].ExecutionSettings")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
