orchestrator
2025.10
false
- 入门指南
- 身份验证
- Swagger 定义
- Orchestrator API
- 平台管理 API

Orchestrator API 指南
上次更新日期 2025年10月27日
以下请求使您能够显示机器人使用的所有服务设置。
注意: 请注意,发出此请求时,您需要包含机器人许可证密钥作为标头。 标头的名称必须为 X-ROBOT-LICENSE,如下面的示例所示。
               
               
               获取
https://{yourDomain}/odata/Settings/UiPath.Server.Configuration.OData.GetServicesSettings()
请求标头
| 密钥 | 值 | 
|---|---|
| 授权 | 承载 | 
响应代码
200 OK
响应正文
{
    "@odata.context": "https://{yourDomain}/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}/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"
    ]
}下面的示例使您能够检索机器人运行时设置。
获取
https://{yourDomain}/odata/Settings/UiPath.Server.Configuration.OData.GetExecutionSettingsConfiguration(scope=1)
请求标头
| 密钥 | 值 | 
|---|---|
| 授权 | 承载 | 
响应代码
200 OK
响应正文
{
  "@odata.context": "https://{yourDomain}/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}/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": []
    }
  ]
}通过以下请求,您可以将有人值守的机器人在离线环境中保留其许可证的小时数更改为 24 小时。
请注意,首次将机器人连接到 Orchestrator 时或重新启动 UiPath 机器人服务之后,此设置适用。如果运行的是社区版,则需要重新启动托盘才能使更改生效。
发布
https://{yourDomain}/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"
    }]
}响应代码
200 OK