DataFlex / Orchestrator / 3. Robots - Get by name
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sLicenseKey
String sMachineName
Integer iMachineId
String sName
String sUsername
String sDescription
String sVersion
String sV_Type
String sHostingType
String sPassword
String sCredentialType
String sRobotEnvironments
Integer iId
String sExecutionSettings
String sOdata_context
Integer iOdata_count
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "$filter" "Name eq 'joe'" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Send ComSetRequestHeader To hoHttp "X-UIPATH-OrganizationUnitId" "{{folderId}}"
Send ComSetRequestHeader To hoHttp "X-UIPATH-TenantName" "{{tenantName}}"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://domain.com/odata/Robots" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp '"@odata.context"' To sOdata_context
Get ComIntOf Of hoJResp '"@odata.count"' To iOdata_count
Move 0 To i
Get ComSizeOfArray Of hoJResp "value" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "value[i].LicenseKey" To sLicenseKey
Get ComStringOf Of hoJResp "value[i].MachineName" To sMachineName
Get ComIntOf Of hoJResp "value[i].MachineId" To iMachineId
Get ComStringOf Of hoJResp "value[i].Name" To sName
Get ComStringOf Of hoJResp "value[i].Username" To sUsername
Get ComStringOf Of hoJResp "value[i].Description" To sDescription
Get ComStringOf Of hoJResp "value[i].Version" To sVersion
Get ComStringOf Of hoJResp "value[i].Type" To sV_Type
Get ComStringOf Of hoJResp "value[i].HostingType" To sHostingType
Get ComStringOf Of hoJResp "value[i].Password" To sPassword
Get ComStringOf Of hoJResp "value[i].CredentialType" To sCredentialType
Get ComStringOf Of hoJResp "value[i].RobotEnvironments" To sRobotEnvironments
Get ComIntOf Of hoJResp "value[i].Id" To iId
Get ComStringOf Of hoJResp "value[i].ExecutionSettings" To sExecutionSettings
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
