All URIs are relative to https://cloud.uipath.com/jcaravaca42/jorge_pruebas/orchestrator_/
Method | HTTP request | Description |
---|---|---|
environments_add_robot_by_id | POST /odata/Environments({key})/UiPath.Server.Configuration.OData.AddRobot | Associates a robot with the given environment. |
environments_delete_by_id | DELETE /odata/Environments({key}) | Deletes an environment. |
environments_get | GET /odata/Environments | Gets Environments. |
environments_get_by_id | GET /odata/Environments({key}) | Gets a single environment. |
environments_get_robot_ids_for_environment_by_key | GET /odata/Environments/UiPath.Server.Configuration.OData.GetRobotIdsForEnvironment(key={key}) | Returns a collection of all the ids of the robots associated to an environment based on environment Id. |
environments_get_robots_for_environment_by_key | GET /odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key={key}) | Returns a collection of all robots and, if no other sorting is provided, will place first those belonging to the environment. Allows odata query options. |
environments_post | POST /odata/Environments | Post new environment |
environments_put_by_id | PUT /odata/Environments({key}) | Updates an environment. |
environments_remove_robot_by_id | POST /odata/Environments({key})/UiPath.Server.Configuration.OData.RemoveRobot | Dissociates a robot from the given environment. |
environments_set_robots_by_id | POST /odata/Environments({key})/UiPath.Server.Configuration.OData.SetRobots | Associates a group of robots with and dissociates another group of robots from the given environment. |
environments_add_robot_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Associates a robot with the given environment.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Environments.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.EnvironmentsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int | The associated Environment Id.
body = uipath_orchestrator_rest.EnvironmentRobotRequest() # EnvironmentRobotRequest | RobotId - The associated robot Id. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Associates a robot with the given environment.
api_instance.environments_add_robot_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling EnvironmentsApi->environments_add_robot_by_id: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
key | int | The associated Environment Id. | |
body | EnvironmentRobotRequest | RobotId - The associated robot Id. | [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]
environments_delete_by_id(key, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Deletes an environment.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Environments.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.EnvironmentsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int |
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Deletes an environment.
api_instance.environments_delete_by_id(key, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling EnvironmentsApi->environments_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]
ODataValueOfIEnumerableOfEnvironmentDto environments_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 Environments.
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: Environments.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.EnvironmentsApi(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 Environments.
api_response = api_instance.environments_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 EnvironmentsApi->environments_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] |
ODataValueOfIEnumerableOfEnvironmentDto
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EnvironmentDto environments_get_by_id(key, expand=expand, select=select, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Gets a single environment.
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: Environments.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.EnvironmentsApi(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 environment.
api_response = api_instance.environments_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 EnvironmentsApi->environments_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]
ODataValueOfIEnumerableOfInt64 environments_get_robot_ids_for_environment_by_key(key, expand=expand, filter=filter, select=select, orderby=orderby, count=count, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Returns a collection of all the ids of the robots associated to an environment based on environment Id.
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: Environments.View 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.EnvironmentsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int | The Id of the environment for which the robot ids 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)
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 the ids of the robots associated to an environment based on environment Id.
api_response = api_instance.environments_get_robot_ids_for_environment_by_key(key, 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 EnvironmentsApi->environments_get_robot_ids_for_environment_by_key: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
key | int | The Id of the environment for which the robot ids 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] |
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] |
ODataValueOfIEnumerableOfInt64
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ODataValueOfIEnumerableOfRobotDto environments_get_robots_for_environment_by_key(key, 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 and, if no other sorting is provided, will place first those belonging to the environment. Allows odata query options.
OAuth required scopes: OR.Robots or OR.Robots.Read. Required permissions: Environments.View 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.EnvironmentsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int | The Id of the environment for which the associated robots are placed first.
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 and, if no other sorting is provided, will place first those belonging to the environment. Allows odata query options.
api_response = api_instance.environments_get_robots_for_environment_by_key(key, 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 EnvironmentsApi->environments_get_robots_for_environment_by_key: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
key | int | The Id of the environment for which the associated robots are placed first. | |
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]
EnvironmentDto environments_post(body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Post new environment
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Environments.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.EnvironmentsApi(uipath_orchestrator_rest.ApiClient(configuration))
body = uipath_orchestrator_rest.EnvironmentDto() # EnvironmentDto | (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Post new environment
api_response = api_instance.environments_post(body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling EnvironmentsApi->environments_post: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
body | EnvironmentDto | [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]
environments_put_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Updates an environment.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Environments.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.EnvironmentsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int |
body = uipath_orchestrator_rest.EnvironmentDto() # EnvironmentDto | (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Updates an environment.
api_instance.environments_put_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling EnvironmentsApi->environments_put_by_id: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
key | int | ||
body | EnvironmentDto | [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]
environments_remove_robot_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Dissociates a robot from the given environment.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Environments.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.EnvironmentsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int | Given environment's Id.
body = uipath_orchestrator_rest.EnvironmentRobotRequest() # EnvironmentRobotRequest | RobotId - The dissociated robot Id. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Dissociates a robot from the given environment.
api_instance.environments_remove_robot_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling EnvironmentsApi->environments_remove_robot_by_id: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
key | int | Given environment's Id. | |
body | EnvironmentRobotRequest | RobotId - The dissociated robot Id. | [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]
environments_set_robots_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
Associates a group of robots with and dissociates another group of robots from the given environment.
OAuth required scopes: OR.Robots or OR.Robots.Write. Required permissions: Environments.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.EnvironmentsApi(uipath_orchestrator_rest.ApiClient(configuration))
key = 789 # int | The environment id.
body = uipath_orchestrator_rest.EnvironmentsSetRobotsRequest() # EnvironmentsSetRobotsRequest | <para />addedRobotIds - The id of the robots to be associated with the environment. <para />removedRobotIds - The id of the robots to be dissociated from the environment. (optional)
x_uipath_organization_unit_id = 789 # int | Folder/OrganizationUnit Id (optional)
try:
# Associates a group of robots with and dissociates another group of robots from the given environment.
api_instance.environments_set_robots_by_id(key, body=body, x_uipath_organization_unit_id=x_uipath_organization_unit_id)
except ApiException as e:
print("Exception when calling EnvironmentsApi->environments_set_robots_by_id: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
key | int | The environment id. | |
body | EnvironmentsSetRobotsRequest | <para />addedRobotIds - The id of the robots to be associated with the environment. <para />removedRobotIds - The id of the robots to be dissociated from the environment. | [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]