- Getting Started
- Swagger Definition
- Orchestrator APIs
- Alerts Requests
- Assets Requests
- Calendars Requests
- Environments Requests
- Folders Requests
- Generic Tasks Requests
- Jobs Requests
- Libraries Requests
- License Requests
- Packages Requests
- Permissions Requests
- Personal Workspaces Requests
- Processes Requests
- Queue Items Requests
- Queue Retention Policy Requests
- Robots Requests
- Roles Requests
- Schedules Requests
- Settings Requests
- Storage Bucket Requests
- Tasks Requests
- Task Catalogs Requests
- Task Forms Requests
- Tenants Requests
- Transactions Requests
- Users Requests
- Webhooks Requests
Settings Requests
The following request enables you to display all the service settings used by the Robot.
GET
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetServicesSettings()
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_String",
"Keys": [
"ConfigurationUrl",
"DeploymentUrl",
"MonitoringUrl",
"NotificationHubUrl",
"LoggingUrl",
"QueuesSvcUrl",
"NuGet.Packages.ApiKey",
"NuGetServiceApiKey",
"ActivitiesFeed"
],
"Values": [
"https://your-domain-server.com",
"https://your-domain-server.com/nuget/feed/documentation",
"https://your-domain-server.com",
"https://your-domain-server.com/signalr/hubs",
"https://your-domain-server.com",
"https://your-domain-server.com",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"https://your-domain-server.com/nuget/activities"
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#System.Collections.Generic.Dictionary_2OfString_String",
"Keys": [
"ConfigurationUrl",
"DeploymentUrl",
"MonitoringUrl",
"NotificationHubUrl",
"LoggingUrl",
"QueuesSvcUrl",
"NuGet.Packages.ApiKey",
"NuGetServiceApiKey",
"ActivitiesFeed"
],
"Values": [
"https://your-domain-server.com",
"https://your-domain-server.com/nuget/feed/documentation",
"https://your-domain-server.com",
"https://your-domain-server.com/signalr/hubs",
"https://your-domain-server.com",
"https://your-domain-server.com",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"ec5b1111-5eb9-4264-a545-d5ed85c6301a",
"https://your-domain-server.com/nuget/activities"
]
}
The example below enables you to retrieve the Robot runtime settings.
GET
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.GetExecutionSettingsConfiguration(scope=1)
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Settings.ExecutionSettingsConfiguration",
"Scope": "Global",
"Configuration": [
{
"Key": "TracingLevel",
"DisplayName": "Logging Level",
"ValueType": "MultipleChoice",
"DefaultValue": "Information",
"PossibleValues": [
"Verbose",
"Trace",
"Information",
"Warning",
"Error",
"Critical",
"Off"
]
},
{
"Key": "LoginToConsole",
"DisplayName": "Login To Console",
"ValueType": "Boolean",
"DefaultValue": "false",
"PossibleValues": []
},
{
"Key": "ResolutionWidth",
"DisplayName": "Resolution Width",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionHeight",
"DisplayName": "Resolution Height",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionDepth",
"DisplayName": "Resolution Depth",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
}
]
}
{
"@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Core.Settings.ExecutionSettingsConfiguration",
"Scope": "Global",
"Configuration": [
{
"Key": "TracingLevel",
"DisplayName": "Logging Level",
"ValueType": "MultipleChoice",
"DefaultValue": "Information",
"PossibleValues": [
"Verbose",
"Trace",
"Information",
"Warning",
"Error",
"Critical",
"Off"
]
},
{
"Key": "LoginToConsole",
"DisplayName": "Login To Console",
"ValueType": "Boolean",
"DefaultValue": "false",
"PossibleValues": []
},
{
"Key": "ResolutionWidth",
"DisplayName": "Resolution Width",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionHeight",
"DisplayName": "Resolution Height",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
},
{
"Key": "ResolutionDepth",
"DisplayName": "Resolution Depth",
"ValueType": "Integer",
"DefaultValue": "0",
"PossibleValues": []
}
]
}
The request below enables you to change the number of hours for which an Attended Robot retains its licenses in an offline environment to 24 hours.
Please note that this setting is applied when you first connect the Robot to Orchestrator, or after the UiPath Robot service is restarted. If you are running the Community version, you need to restart the tray for the change to take effect.
POST
https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk
{
"settings": [{
"Name@odata.type": "#String",
"Name": "AttendedRobot.RunDisconnectedHours",
"Value": "24"
}]
}
{
"settings": [{
"Name@odata.type": "#String",
"Name": "AttendedRobot.RunDisconnectedHours",
"Value": "24"
}]
}