All URIs are relative to https://cloud.uipath.com/jcaravaca42/jorge_pruebas/orchestrator_/
| Method | HTTP request | Description |
|---|---|---|
| robots_convert_to_floating | POST /odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloating | Convert a Standard Attended Robot to a Floating Robot. |
| robots_delete_bulk | POST /odata/Robots/UiPath.Server.Configuration.OData.DeleteBulk | Deletes multiple robots based on their keys. |
| robots_delete_by_id | DELETE /odata/Robots({key}) | Deletes a robot based on its key. |
| robots_find_all_across_folders | GET /odata/Robots/UiPath.Server.Configuration.OData.FindAllAcrossFolders | Get robots across all accessible folders. |
| robots_get | GET /odata/Robots | Gets robots. |
| robots_get_by_id | GET /odata/Robots({key}) | Gets a single robot based on its key. |
| robots_get_configured_robots | GET /odata/Robots/UiPath.Server.Configuration.OData.GetConfiguredRobots | Gets robots autoprovisioned from users |
| robots_get_folder_robots_by_folderid_and_machineid | GET /odata/Robots/UiPath.Server.Configuration.OData.GetFolderRobots(folderId={folderId},machineId={machineId}) | Get folder robots |
| robots_get_machine_name_to_license_key_mappings | GET /odata/Robots/UiPath.Server.Configuration.OData.GetMachineNameToLicenseKeyMappings | Gets machine name to license key mapping. |
| robots_get_robots_for_process_by_processid | GET /odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess(processId={processId}) | Returns a collection of all robots that can execute the process with the provided Id. |
| robots_get_robots_from_folder_by_folderid | GET /odata/Robots/UiPath.Server.Configuration.OData.GetRobotsFromFolder(folderId={folderId}) | Gets all robots from a folder |
| robots_get_usernames | GET /odata/Robots/UiPath.Server.Configuration.OData.GetUsernames | Gets usernames. |
| robots_patch_by_id | PATCH /odata/Robots({key}) | Partially updates a robot. |
| robots_post | POST /odata/Robots | Creates a new robot. |
| robots_put_by_id | PUT /odata/Robots({key}) | Edits a robot based on its key. |
| robots_toggle_enabled_status | POST /odata/Robots/UiPath.Server.Configuration.OData.ToggleEnabledStatus | Toggles the status of the robots (enabled/disabled) |
robots_convert_to_floating(body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Convert a Standard Attended Robot to a Floating Robot.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Robots.Edit.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
body = uipath_orchestrator_rest.RobotsConvertToFloatingRequest() # RobotsConvertToFloatingRequest | (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Convert a Standard Attended Robot to a Floating Robot.
api_instance.robots_convert_to_floating(body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling RobotsApi->robots_convert_to_floating: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | RobotsConvertToFloatingRequest | [optional] | |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
void (empty response body)
- Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json-patch+json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
robots_delete_bulk(body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Deletes multiple robots based on their keys.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Robots.Delete.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
body = uipath_orchestrator_rest.RobotDeleteBulkRequest() # RobotDeleteBulkRequest | (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Deletes multiple robots based on their keys.
api_instance.robots_delete_bulk(body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling RobotsApi->robots_delete_bulk: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | RobotDeleteBulkRequest | [optional] | |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
void (empty response body)
- Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json-patch+json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
robots_delete_by_id(key, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Deletes a robot based on its key.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Robots.Delete.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int |
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Deletes a robot based on its key.
api_instance.robots_delete_by_id(key, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling RobotsApi->robots_delete_by_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| key | int | ||
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ODataValueOfIEnumerableOfExtendedRobotDto robots_find_all_across_folders(expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Get robots across all accessible folders.
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: Robots.View or Users.View or Machines.Create or Machines.Edit.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
expand = 'expand_example' # str | Indicates the related entities to be represented inline. The maximum depth is 2. (optional)
filter = 'filter_example' # str | Restricts the set of items returned. The maximum number of expressions is 100. (optional)
select = 'select_example' # str | Limits the properties returned in the result. (optional)
orderby = 'orderby_example' # str | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
top = 56 # int | Limits the number of items returned from a collection. The maximum value is 1000. (optional)
skip = 56 # int | Excludes the specified number of items of the queried collection from the result. (optional)
count = true # bool | Indicates whether the total count of items within a collection are returned in the result. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Get robots across all accessible folders.
api_response = api_instance.robots_find_all_across_folders(expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RobotsApi->robots_find_all_across_folders: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| expand | str | Indicates the related entities to be represented inline. The maximum depth is 2. | [optional] |
| filter | str | Restricts the set of items returned. The maximum number of expressions is 100. | [optional] |
| select | str | Limits the properties returned in the result. | [optional] |
| orderby | str | Specifies the order in which items are returned. The maximum number of expressions is 5. | [optional] |
| top | int | Limits the number of items returned from a collection. The maximum value is 1000. | [optional] |
| skip | int | Excludes the specified number of items of the queried collection from the result. | [optional] |
| count | bool | Indicates whether the total count of items within a collection are returned in the result. | [optional] |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
ODataValueOfIEnumerableOfExtendedRobotDto
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ODataValueOfIEnumerableOfRobotDto robots_get(expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Gets robots.
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: Robots.View.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
expand = 'expand_example' # str | Indicates the related entities to be represented inline. The maximum depth is 2. (optional)
filter = 'filter_example' # str | Restricts the set of items returned. The maximum number of expressions is 100. (optional)
select = 'select_example' # str | Limits the properties returned in the result. (optional)
orderby = 'orderby_example' # str | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
top = 56 # int | Limits the number of items returned from a collection. The maximum value is 1000. (optional)
skip = 56 # int | Excludes the specified number of items of the queried collection from the result. (optional)
count = true # bool | Indicates whether the total count of items within a collection are returned in the result. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Gets robots.
api_response = api_instance.robots_get(expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RobotsApi->robots_get: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| expand | str | Indicates the related entities to be represented inline. The maximum depth is 2. | [optional] |
| filter | str | Restricts the set of items returned. The maximum number of expressions is 100. | [optional] |
| select | str | Limits the properties returned in the result. | [optional] |
| orderby | str | Specifies the order in which items are returned. The maximum number of expressions is 5. | [optional] |
| top | int | Limits the number of items returned from a collection. The maximum value is 1000. | [optional] |
| skip | int | Excludes the specified number of items of the queried collection from the result. | [optional] |
| count | bool | Indicates whether the total count of items within a collection are returned in the result. | [optional] |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
ODataValueOfIEnumerableOfRobotDto
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RobotDto robots_get_by_id(key, expand=expand, select=select, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Gets a single robot based on its key.
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: Robots.View.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int |
expand = 'expand_example' # str | Indicates the related entities to be represented inline. The maximum depth is 2. (optional)
select = 'select_example' # str | Limits the properties returned in the result. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Gets a single robot based on its key.
api_response = api_instance.robots_get_by_id(key, expand=expand, select=select, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RobotsApi->robots_get_by_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| key | int | ||
| expand | str | Indicates the related entities to be represented inline. The maximum depth is 2. | [optional] |
| select | str | Limits the properties returned in the result. | [optional] |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ODataValueOfIEnumerableOfExtendedRobotDto robots_get_configured_robots(expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Gets robots autoprovisioned from users
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: (Users.View - Required only when the robot's user is expanded) and (Robots.View).
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
expand = 'expand_example' # str | Indicates the related entities to be represented inline. The maximum depth is 2. (optional)
filter = 'filter_example' # str | Restricts the set of items returned. The maximum number of expressions is 100. (optional)
select = 'select_example' # str | Limits the properties returned in the result. (optional)
orderby = 'orderby_example' # str | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
top = 56 # int | Limits the number of items returned from a collection. The maximum value is 1000. (optional)
skip = 56 # int | Excludes the specified number of items of the queried collection from the result. (optional)
count = true # bool | Indicates whether the total count of items within a collection are returned in the result. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Gets robots autoprovisioned from users
api_response = api_instance.robots_get_configured_robots(expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RobotsApi->robots_get_configured_robots: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| expand | str | Indicates the related entities to be represented inline. The maximum depth is 2. | [optional] |
| filter | str | Restricts the set of items returned. The maximum number of expressions is 100. | [optional] |
| select | str | Limits the properties returned in the result. | [optional] |
| orderby | str | Specifies the order in which items are returned. The maximum number of expressions is 5. | [optional] |
| top | int | Limits the number of items returned from a collection. The maximum value is 1000. | [optional] |
| skip | int | Excludes the specified number of items of the queried collection from the result. | [optional] |
| count | bool | Indicates whether the total count of items within a collection are returned in the result. | [optional] |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
ODataValueOfIEnumerableOfExtendedRobotDto
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ODataValueOfIEnumerableOfExtendedRobotDto robots_get_folder_robots_by_folderid_and_machineid(folder_id, machine_id, expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Get folder robots
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: (SubFolders.View or Units.View or Jobs.Create).
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
folder_id = 789 # int |
machine_id = 789 # int |
expand = 'expand_example' # str | Indicates the related entities to be represented inline. The maximum depth is 2. (optional)
filter = 'filter_example' # str | Restricts the set of items returned. The maximum number of expressions is 100. (optional)
select = 'select_example' # str | Limits the properties returned in the result. (optional)
orderby = 'orderby_example' # str | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
top = 56 # int | Limits the number of items returned from a collection. The maximum value is 1000. (optional)
skip = 56 # int | Excludes the specified number of items of the queried collection from the result. (optional)
count = true # bool | Indicates whether the total count of items within a collection are returned in the result. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Get folder robots
api_response = api_instance.robots_get_folder_robots_by_folderid_and_machineid(folder_id, machine_id, expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RobotsApi->robots_get_folder_robots_by_folderid_and_machineid: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| folder_id | int | ||
| machine_id | int | ||
| expand | str | Indicates the related entities to be represented inline. The maximum depth is 2. | [optional] |
| filter | str | Restricts the set of items returned. The maximum number of expressions is 100. | [optional] |
| select | str | Limits the properties returned in the result. | [optional] |
| orderby | str | Specifies the order in which items are returned. The maximum number of expressions is 5. | [optional] |
| top | int | Limits the number of items returned from a collection. The maximum value is 1000. | [optional] |
| skip | int | Excludes the specified number of items of the queried collection from the result. | [optional] |
| count | bool | Indicates whether the total count of items within a collection are returned in the result. | [optional] |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
ODataValueOfIEnumerableOfExtendedRobotDto
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ODataValueOfIEnumerableOfKeyValuePairOfStringString robots_get_machine_name_to_license_key_mappings(expand=expand, filter=filter, select=select, orderby=orderby, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Gets machine name to license key mapping.
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: Robots.Create and Machines.View.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
expand = 'expand_example' # str | Indicates the related entities to be represented inline. The maximum depth is 2. (optional)
filter = 'filter_example' # str | Restricts the set of items returned. The maximum number of expressions is 100. (optional)
select = 'select_example' # str | Limits the properties returned in the result. (optional)
orderby = 'orderby_example' # str | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
count = true # bool | Indicates whether the total count of items within a collection are returned in the result. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Gets machine name to license key mapping.
api_response = api_instance.robots_get_machine_name_to_license_key_mappings(expand=expand, filter=filter, select=select, orderby=orderby, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RobotsApi->robots_get_machine_name_to_license_key_mappings: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| expand | str | Indicates the related entities to be represented inline. The maximum depth is 2. | [optional] |
| filter | str | Restricts the set of items returned. The maximum number of expressions is 100. | [optional] |
| select | str | Limits the properties returned in the result. | [optional] |
| orderby | str | Specifies the order in which items are returned. The maximum number of expressions is 5. | [optional] |
| count | bool | Indicates whether the total count of items within a collection are returned in the result. | [optional] |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
ODataValueOfIEnumerableOfKeyValuePairOfStringString
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ODataValueOfIEnumerableOfRobotDto robots_get_robots_for_process_by_processid(process_id, expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Returns a collection of all robots that can execute the process with the provided Id.
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: Robots.View and Environments.View and Processes.View.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
process_id = 'process_id_example' # str | The Id of the process for which the robots are fetched.
expand = 'expand_example' # str | Indicates the related entities to be represented inline. The maximum depth is 2. (optional)
filter = 'filter_example' # str | Restricts the set of items returned. The maximum number of expressions is 100. (optional)
select = 'select_example' # str | Limits the properties returned in the result. (optional)
orderby = 'orderby_example' # str | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
top = 56 # int | Limits the number of items returned from a collection. The maximum value is 1000. (optional)
skip = 56 # int | Excludes the specified number of items of the queried collection from the result. (optional)
count = true # bool | Indicates whether the total count of items within a collection are returned in the result. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Returns a collection of all robots that can execute the process with the provided Id.
api_response = api_instance.robots_get_robots_for_process_by_processid(process_id, expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RobotsApi->robots_get_robots_for_process_by_processid: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| process_id | str | The Id of the process for which the robots are fetched. | |
| expand | str | Indicates the related entities to be represented inline. The maximum depth is 2. | [optional] |
| filter | str | Restricts the set of items returned. The maximum number of expressions is 100. | [optional] |
| select | str | Limits the properties returned in the result. | [optional] |
| orderby | str | Specifies the order in which items are returned. The maximum number of expressions is 5. | [optional] |
| top | int | Limits the number of items returned from a collection. The maximum value is 1000. | [optional] |
| skip | int | Excludes the specified number of items of the queried collection from the result. | [optional] |
| count | bool | Indicates whether the total count of items within a collection are returned in the result. | [optional] |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
ODataValueOfIEnumerableOfRobotDto
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ODataValueOfIEnumerableOfRobotsFromFolderModel robots_get_robots_from_folder_by_folderid(folder_id, machine_id=machine_id, expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Gets all robots from a folder
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: (SubFolders.View or Units.View or Jobs.Create or Users.View).
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
folder_id = 789 # int |
machine_id = 789 # int | (optional)
expand = 'expand_example' # str | Indicates the related entities to be represented inline. The maximum depth is 2. (optional)
filter = 'filter_example' # str | Restricts the set of items returned. The maximum number of expressions is 100. (optional)
select = 'select_example' # str | Limits the properties returned in the result. (optional)
orderby = 'orderby_example' # str | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
top = 56 # int | Limits the number of items returned from a collection. The maximum value is 1000. (optional)
skip = 56 # int | Excludes the specified number of items of the queried collection from the result. (optional)
count = true # bool | Indicates whether the total count of items within a collection are returned in the result. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Gets all robots from a folder
api_response = api_instance.robots_get_robots_from_folder_by_folderid(folder_id, machine_id=machine_id, expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RobotsApi->robots_get_robots_from_folder_by_folderid: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| folder_id | int | ||
| machine_id | int | [optional] | |
| expand | str | Indicates the related entities to be represented inline. The maximum depth is 2. | [optional] |
| filter | str | Restricts the set of items returned. The maximum number of expressions is 100. | [optional] |
| select | str | Limits the properties returned in the result. | [optional] |
| orderby | str | Specifies the order in which items are returned. The maximum number of expressions is 5. | [optional] |
| top | int | Limits the number of items returned from a collection. The maximum value is 1000. | [optional] |
| skip | int | Excludes the specified number of items of the queried collection from the result. | [optional] |
| count | bool | Indicates whether the total count of items within a collection are returned in the result. | [optional] |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
ODataValueOfIEnumerableOfRobotsFromFolderModel
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ODataValueOfIEnumerableOfString robots_get_usernames(expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Gets usernames.
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: Robots.View.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
expand = 'expand_example' # str | Indicates the related entities to be represented inline. The maximum depth is 2. (optional)
filter = 'filter_example' # str | Restricts the set of items returned. The maximum number of expressions is 100. (optional)
select = 'select_example' # str | Limits the properties returned in the result. (optional)
orderby = 'orderby_example' # str | Specifies the order in which items are returned. The maximum number of expressions is 5. (optional)
top = 56 # int | Limits the number of items returned from a collection. The maximum value is 1000. (optional)
skip = 56 # int | Excludes the specified number of items of the queried collection from the result. (optional)
count = true # bool | Indicates whether the total count of items within a collection are returned in the result. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Gets usernames.
api_response = api_instance.robots_get_usernames(expand=expand, filter=filter, select=select, orderby=orderby, top=top, skip=skip, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RobotsApi->robots_get_usernames: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| expand | str | Indicates the related entities to be represented inline. The maximum depth is 2. | [optional] |
| filter | str | Restricts the set of items returned. The maximum number of expressions is 100. | [optional] |
| select | str | Limits the properties returned in the result. | [optional] |
| orderby | str | Specifies the order in which items are returned. The maximum number of expressions is 5. | [optional] |
| top | int | Limits the number of items returned from a collection. The maximum value is 1000. | [optional] |
| skip | int | Excludes the specified number of items of the queried collection from the result. | [optional] |
| count | bool | Indicates whether the total count of items within a collection are returned in the result. | [optional] |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
ODataValueOfIEnumerableOfString
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
robots_patch_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Partially updates a robot.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Robots.Edit.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int |
body = uipath_orchestrator_rest.RobotDto() # RobotDto | (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Partially updates a robot.
api_instance.robots_patch_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling RobotsApi->robots_patch_by_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| key | int | ||
| body | RobotDto | [optional] | |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
void (empty response body)
- Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json-patch+json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RobotDto robots_post(body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Creates a new robot.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: (Robots.Create - Floating Robot) and (Robots.Create and Machines.View - Standard Robot).
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
body = uipath_orchestrator_rest.RobotDto() # RobotDto | (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Creates a new robot.
api_response = api_instance.robots_post(body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling RobotsApi->robots_post: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | RobotDto | [optional] | |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
- Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json-patch+json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
robots_put_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Edits a robot based on its key.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Robots.Edit.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int |
body = uipath_orchestrator_rest.RobotDto() # RobotDto | (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Edits a robot based on its key.
api_instance.robots_put_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling RobotsApi->robots_put_by_id: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| key | int | ||
| body | RobotDto | [optional] | |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
void (empty response body)
- Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json-patch+json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
robots_toggle_enabled_status(body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Toggles the status of the robots (enabled/disabled)
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Robots.Edit.
from __future__ import print_function
import time
import uipath_orchestrator_rest
from uipath_orchestrator_rest.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: OAuth2
configuration = uipath_orchestrator_rest.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'
# create an instance of the API class
api_instance = uipath_orchestrator_rest.RobotsApi(uipath_orchestrator_rest.ApiClient(configuration))
body = uipath_orchestrator_rest.RobotsToggleEnabledStatusRequest() # RobotsToggleEnabledStatusRequest | <para /> disabled - If true the robots will be enabled, if false the robots will be disabled. <para /> robotIds - The collection of ids of the affected robots. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Toggles the status of the robots (enabled/disabled)
api_instance.robots_toggle_enabled_status(body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling RobotsApi->robots_toggle_enabled_status: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| body | RobotsToggleEnabledStatusRequest | <para /> disabled - If true the robots will be enabled, if false the robots will be disabled. <para /> robotIds - The collection of ids of the affected robots. | [optional] |
| x_uipath_organization_unit_id | int | Folder/OrganizationUnit Id | [optional] |
void (empty response body)
- Content-Type: application/json;odata.metadata=minimal;odata.streaming=true, application/json;odata.metadata=minimal;odata.streaming=false, application/json;odata.metadata=minimal, application/json;odata.metadata=full;odata.streaming=true, application/json;odata.metadata=full;odata.streaming=false, application/json;odata.metadata=full, application/json;odata.metadata=none;odata.streaming=true, application/json;odata.metadata=none;odata.streaming=false, application/json;odata.metadata=none, application/json;odata.streaming=true, application/json;odata.streaming=false, application/json, application/json-patch+json, application/*+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]