orchestrator
2022.4
false
- 入门指南
- 关于 OData 和引用
- 枚举类型
- 正在验证身份
- 构建 API 请求
- 每个端点的权限
- 响应代码
- 运行状况检查端点
- 身份验证
- 身份验证方法
- 外部应用程序 (OAuth)
- ROPC（不推荐）
- Swagger 定义
- 读取我
- 在 Swagger 中授权 API 调用
- 管理逻辑资源
- Orchestrator API
- 警示请求
- 资产请求
- 日历请求
- 环境请求
- 文件夹请求
- 一般任务请求
- 作业请求
- 库请求
- 许可证请求
- 包请求
- 权限请求
- 流程请求
- 队列项目请求
- 机器人请求
- 角色请求
- 计划请求
- 设置请求
- 任务请求
- 任务目录请求
- 任务表单请求
- 租户请求
- 事务请求
- 用户请求
- Webhook 请求
- 平台管理 API
- 入门指南
- 关于本指南
- 可用资源：
- API 端点 URL 结构
- 枚举列表
- 作用域和权限
- 关于作用域和权限
- 平台管理作用域和权限
- 平台管理 API
- 审核日志
- 获取审核日志
- 下载审核日志
- 组
- 获取所有组
- 获取指定组
- 删除指定组
- 创建新的本地组
- 更新组
- 机器人帐户
- 获取所有机器人帐户
- 删除机器人帐户
- 获取特定机器人帐户
- 删除特定机器人帐户
- 创建新的机器人帐户
- 更新机器人帐户
- 用户
- 更新用户
- 删除特定用户
- 删除用户
- 设置
- 获取设置
- 更新设置
- 消息模板
- 获取消息模板
- 更新消息模板
- 按名称获取消息模板
重要 :
请注意，此内容已使用机器翻译进行了部分本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
不在支持范围内
Orchestrator API 指南
上次更新日期 2025年12月16日
以下请求使您能够显示机器人使用的所有服务设置。
注意： 请注意，发出此请求时，您需要包含机器人许可证密钥作为标头。 标头的名称必须为 X-ROBOT-LICENSE，如下面的示例所示。
获取
{OrchestratorURL}/odata/Settings/UiPath.Server.Configuration.OData.GetServicesSettings()
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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"
]
}下面的示例使您能够检索机器人运行时设置。
获取
{OrchestratorURL}/odata/Settings/UiPath.Server.Configuration.OData.GetExecutionSettingsConfiguration(scope=1)
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
响应代码
200 OK
响应正文
{
"@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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 机器人服务之后，此设置适用。如果运行的是社区版，则需要重新启动托盘才能使更改生效。
发布
{OrchestratorURL}/odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk
请求标头
|
密钥 |
值 |
|---|---|
|
授权 |
承载 |
请求正文
{
"settings": [{
"[email protected]": "#String",
"Name": "AttendedRobot.RunDisconnectedHours",
"Value": "24"
}]
}{
"settings": [{
"[email protected]": "#String",
"Name": "AttendedRobot.RunDisconnectedHours",
"Value": "24"
}]
}响应代码
200 OK