UiPath Documentation
orchestrator
latest
false
  • 入门指南
    • 简介
    • 关于 OData 和引用
    • 枚举类型
    • 正在验证身份
    • 构建 API 请求
    • 每个端点的权限
    • 响应代码
    • 速率限制和大数据字段使用优化
  • Swagger 定义
  • Orchestrator API
重要 :
新发布内容的本地化可能需要 1-2 周的时间才能完成。
UiPath logo, featuring letters U and I in white

Orchestrator API 指南

上次更新日期 2026年4月16日

每个端点的权限

通用任务

操作权限
GET - /tasks/GenericTasks/GetTaskDataByIdTasks.View
POST - /tasks/GenericTasks/CreateTaskTasks.Create
POST - /tasks/GenericTasks/CompleteTaskTasks.Edit

任务表单

操作权限
POST - /forms/TaskForms/CreateFormTaskTasks.Create
GET - /forms/TaskForms/GetTaskFormByIdTasks.View
GET - /forms/TaskForms/GetTaskDataByIdTasks.View
POST - /forms/TaskForms/CompleteTaskTasks.Edit

任务目录

操作权限
GET - /odata/TaskCatalogsTaskCatalogs.View
GET - /odata/TaskCatalogs(Id)TaskCatalogs.View
POST - /odata/TaskCatalogs/UiPath.Server.Configuration.OData.CreateTaskCatalogTaskCatalogs.Create
POST - /odata/TaskCatalogs(Id)/UiPath.Server.Configuration.OData.UpdateTaskCatalogTaskCatalogs.Edit

任务

操作权限
GET - /odata/TasksTasks.View
获取 /odata/Tasks(Id)Tasks.View
POST - /odata/Tasks/UiPath.Server.Configuration.OData.AssignTasksTasks.View & Tasks.Edit
POST - /odata/Tasks/UiPath.Server.Configuration.OData.ReassignTasksTasks.View 和 Tasks.Edit 和 TaskAssignment.Create
POST - /odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasksTasks.View & Tasks.Edit
GET - /odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=organizationUnitId)Tasks.View 和 Tasks.Edit 和 TaskAssignment.Create

执行介质

操作权限
GET - /odata/ExecutionMediaExecutionMedia.View
GET - /odata/ExecutionMedia(Id)ExecutionMedia.View
GET - /odata/ExecutionMedia/UiPath.Server.Configuration.OData.DownloadMediaByJobId(jobId={jobId})}ExecutionMedia.View
POST - /odata/ExecutionMedia/UiPath.Server.Configuration.OData.DeleteMediaByJobIdExecutionMedia.View

文件夹

操作权限
GET - /odata/FoldersFolders.View 或 Subfolders.View
POST - /odata/FoldersFolders.Create 或 Subfolders.Create
DELETE -/odata/Folders{Id}Folders.Delete 或 Subfolders.Delete
GET - /odata/Folders{Id}Folders.View 或 Subfolders.View
PUT - /odata/Folders{Id}Folders.Edit 或 Subfolders.Edit
POST - /odata/Folders/UiPath.Server.Configuration.OData.AssignUsersFolders.Edit 或 Subfolders.Edit Users.View 和 Roles.View
GET - /odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={key},includeInherited={includeInherited})Folders.View 或 Subfolders.ViewUsers.View
POST - /odata/Folders{Id}/UiPath.Server.Configuration.OData.RemoveUserFromFolderFolders.Edit 或 Subfolders.Edit Users.View

操作权限
GET - /odata/LibrariesLibraries.View
GET - /odata/Libraries/UiPath.Server.Configuration.OData.GetVersions(packageId='{packageId}')Libraries.View
GET - /odata/Libraries/UiPath.Server.Configuration.OData.DownloadPackage(key='{key}')Libraries.View
DELETE - /odata/Libraries('{Id}')Libraries.Delete
POST - /odata/Libraries/UiPath.Server.Configuration.OData.UploadPackageLibraries.Create
备注:

GetVersions API 端点在每个请求上操作一个订阅源。当订阅源作用域设置为“全部(主机 + 租户)”时,端点将仅从租户订阅源返回版本。

警示

操作权限
GET - /odata/AlertsAlerts.View
GET - /odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount()Alerts.View
POST - /odata/Alerts/UiPath.Server.Configuration.OData.MarkAsReadAlerts.View
POST - /odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlertAlerts.Create

资产

操作权限
GET - /odata/AssetsAssets.View
POST - /odata/AssetsAssets.Create
PUT - /odata/Assets({Id})Assets.Edit
DELETE - /odata/Assets({Id})Assets.Delete
POST - /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByNameForRobotKeyAssets.View
GET - /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId={robotId},assetName='{assetName}')Assets.View

AuditLogs

操作权限
GET - /odata/AuditLogsAudit.View
GET - /odata/AuditLogs/UiPath.Server.Configuration.OData.Reports()Audit.View
GET - /odata/AuditLogs/UiPath.Server.Configuration.OData.GetAuditLogDetails(auditLogId={auditLogId})Audit.View

存储桶

操作权限
GET - /odata/BucketsStorage Buckets.View
POST - /odata/BucketsStorage Buckets.Create
DELETE - /odata/Buckets({Id})Storage Buckets.Delete
GET - /odata/Buckets({Id})Storage Buckets.View
PUT - /odata/Buckets({Id})Storage Buckets.Edit
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetReadUri存储 Buckets.View存储 Files.View
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetWriteUri存储 Buckets.View 存储 Files.Create
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFiles存储 Buckets.View存储 Files.View
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetDirectories存储 Buckets.View存储 Files.View
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFile存储 Buckets.View存储 Files.View
DELETE - /odata/Buckets({key})/UiPath.Server.Configuration.OData.DeleteFileStorage Buckets.View Storage Files.Delete

环境

操作权限
GET - /odata/EnvironmentsEnvironments.View
GET - /odata/Environments({Id})Environments.View
GET - /odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key={key})Environments.View 和 Robots.View
GET - /odata/Environments/UiPath.Server.Configuration.OData.GetRobotIdsForEnvironment(key={key})Environments.View 和 Robots.View
POST - /odata/EnvironmentsEnvironments.Create
PUT - /odata/Environments({Id})Environments.Edit
DELETE - /odata/Environments({Id})Environments.Delete
POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.AddRobotEnvironments.Edit
POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.RemoveRobotEnvironments.Edit
POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.SetRobotsEnvironments.Edit

作业

操作权限
GetJobsJobs.View
GetJobs(Id)Jobs.View
StartJobsJobs.Create
停止作业Jobs.Edit
StopJobsJobs.Edit

日志

操作权限
SubmitLogsLogs.Create
PostLogsLogs.Create

权限

操作权限
GetPermissions

流程

操作权限
GET - /odata/ProcessesPackages.View
GET - /odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='{processId}')Packages.View
DELETE - /odata/Processes('{Id}')Packages.Delete
POST - /odata/Processes/UiPath.Server.Configuration.OData.UploadPackagePackages.Create
GET - /odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='{key}')Packages.View
GET - /odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='{key}')Packages.View
POST - /odata/Processes/UiPath.Server.Configuration.OData.SetArgumentsPackages.Edit

QueueDefinitions

操作权限
GetQueueDefinitionsQueues.View
GetQueueDefinitions(Id)Queues.View
报告队列.视图和事务.视图
PutQueueDefinitions(Id)Queues.Edit
PostQueueDefinitionsQueues.Create
DeleteQueueDefinitions(Id)Queues.Delete

QueueItemComments

操作权限
GetQueueItemComments队列.视图和事务.视图
GetQueueItemCommentsHistory队列.视图和事务.视图
GetQueueItemComments(Id)队列.视图和事务.视图
PostQueueItemCommentsQueues.View 和 Transactions.Edit
PutQueueItemComments(Id)Queues.View 和 Transactions.Edit
DeleteQueueItemComments(Id)Queues.View 和 Transactions.Edit

LicensesNamedUser

操作权限
GET - /odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='{robotType}')License.View

LicensesRuntime

操作权限
GET - /odata/LicensesRuntime/UiPath.Server.Configuration.OData.GetLicensesRuntime(robotType='robotType')License.View
POST - /odata/LicensesRuntime('{Key}')/UiPath.Server.Configuration.OData.ToggleEnabledMachines.Edit

队列项目事件

操作权限
GET - /odata/QueueItemEvents队列.视图和事务.视图
GET - /odata/QueueItemEvents/UiPath.Server.Configuration.OData.GetQueueItemEventsHistory(queueItemId=queueItemId)队列.视图和事务.视图
GET - /odata/QueueItemEvents(Id)队列.视图和事务.视图

队列项目

操作权限
GetQueueItems队列.视图和事务.视图
GetQueueItems(Id)队列.视图和事务.视图
SetTransactionProgressQueues.View 和 Transactions.Edit
GetItemProcessingHistory队列.视图和事务.视图
SetItemReviewStatusQueues.View 和 Transactions.Edit
DeleteQueueItems(Id)Queues.View 和 Transactions.Delete
DeleteBulkQueues.View 和 Transactions.Delete
SetItemReviewerQueues.View 和 Transactions.Edit
UnsetItemReviewerQueues.View 和 Transactions.Edit
GetReviewersQueues.View 和 Transactions.Edit

QueueProcessingRecords

操作权限
RetrieveLastDaysProcessingRecords队列.视图和事务.视图
RetrieveQueuesProcessingStatusQueues.View

队列

操作权限
SetTransactionResultQueues.View 和 Transactions.Edit
AddQueueItemQueues.View 和 Transactions.Create
StartTransaction队列。查看和事务。查看和事务。创建和事务。编辑
BulkAddQueueItemsQueues.View 和 Transactions.Create

发布

操作权限
GET - /odata/Releases({Id})Processes.View
GET - /odata/ReleasesProcesses.View
POST - /odata/ReleasesProcesses.Create
DELETE - /odata/Releases({Id})Processes.Delete
PATCH - /odata/Releases({Id})Processes.Edit
PUT - /odata/Releases({Id})Processes.Edit
POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.UpdateToSpecificPackageVersionProcesses.Edit
POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersionProcesses.Edit
POST - /odata/Releases/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersionBulkProcesses.Edit
POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.RollbackToPreviousReleaseVersionProcesses.Edit

UserLoginAttempts

操作权限
GET - /odata/UserLoginAttempts({Id})需要身份验证

机器人日志

操作权限
GetRobotLogsLogs.View
GetTotalCountLogs.View
报告Logs.View

机器人

操作权限
GET - /odata/RobotsRobots.View
GET - /odata/Robots({Id})Robots.View
POST - /odata/RobotsRobots.Create
PUT - /odata/Robots({Id})Robots.Edit
PATCH - /odata/Robots({Id})Robots.Edit
DELETE - /odata/Robots({Id})Robots.Delete
POST - /odata/Robots/UiPath.Server.Configuration.OData.DeleteBulkRobots.Delete
GET - /odata/Robots/UiPath.Server.Configuration.OData.GetMachineNameToLicenseKeyMappings()机器人。创建和计算机。查看
GET - /odata/Robots/UiPath.Server.Configuration.OData.GetUsernames()Robots.View
GET - /odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess(processId='{processId}')机器人.视图和环境.视图和流程.视图
POST - /odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloatingRobots.Edit

ProcessSchedules

操作权限
GetProcessSchedulesSchedules.View
GetProcessSchedules(Id)Schedules.View
GetRobotIdsForScheduleSchedules.View
PostProcessSchedulesSchedules.Create
PutProcessSchedules(Id)Schedules.Edit
SetEnabledSchedules.Edit
DeleteProcessSchedules(Id)Schedules.Delete

会话

操作权限
GetSessionsRobots.View

角色

操作权限
GetRolesRoles.View
GetRoles(Id)Roles.View
PostRolesRoles.Create
PutRoles(Id)Roles.Edit
DeleteRoles(Id)Roles.Delete
SetUsersUsers.Edit
GetUsersForRole“角色.视图”和“用户.视图”
GetUserIdsForRoleRoles.View or Users.View

设置

操作权限
GetSettingsSettings.View
GetSettings(Id)Settings.View
PutSettings(Id)Settings.Edit
UpdateBulkSettings.Edit
GetWebSettings需要身份验证
GetExecutionSettingsConfigurationSettings.Edit 或 Robots.Create 或 Robots.Edit
UploadLicenseLicense.Create or License.Edit
DeleteLicenseLicense.Deletes
GetLicense需要身份验证

Stats

操作权限
GetSessionsStatsRobots.View
GetJobsStatsJobs.View

用户

操作权限
GetUsersUsers.View
GetUsers(Id)Users.View
PostUsersUsers.Create
PutUsersUsers.Edit
PatchUsers(Id)Users.Edit
DeleteUsers(Id)Users.Delete
GetCurrentPermissions需要身份验证
ToggleRoleUsers.Edit
ImportUsersUsers.Create
SetActiveUsers.Edit
ChangeCulture需要身份验证

计算机

操作权限
GET - /odata/MachinesMachines.View
GET - /odata/Machines({Id})Machines.View
POST - /odata/MachinesMachines.Create
PUT - /odata/Machines({Id})Machines.Edit
DELETE - /odata/Machines({Id})Machines.Delete
POST - /odata/Machines/UiPath.Server.Configuration.OData.DeleteBulkMachines.Delete
PATCH - /odata/Machines({Id})Machines.Edit

Webhooks

操作权限
GetWebhooksWebhooks.View
GetWebhooks(Id)Webhooks.View
PostWebhooksWebhooks.Create
PutWebhooks(Id)Webhooks.Edit
PatchWebhooks(Id)Webhooks.Edit
DeleteWebhooksWebhooks.Delete
PingWebhooks.View
GetEventTypesWebhooks.View
TriggerCustomWebhooks.View

测试自动化

操作权限
POST - /api/TestAutomation/StartTestSetExecutionTestSetExecutions.Create
POST - /api/TestAutomation/CancelTestSetExecutionTestSetExecutions.Edit
POST - /api/TestAutomation/CancelTestCaseExecutionTestSetExecutions.Edit
GET - /api/TestAutomation/GetAssertionScreenshotTestSetExecutions.View
POST - /api/TestAutomation/CreateTestSetForReleaseVersionTestSets.Create
GET - /odata/TestCaseDefinitionsTestSets.View
GET - /odata/TestCaseExecutionsTestSetExecutions.View
GET - /odata/TestCaseExecutions({Id})TestSetExecutions.View
GET - /odata/TestSetExecutionsTestSetExecutions.View
GET - /odata/TestCaseExecutions({Id})TestSetExecutions.View
GET - /odata/TestSetsTestSets.View
POST - /odata/TestSetsTestSets.Create
DELETE - /odata/TestSets({Id})TestSets.Delete
GET - /odata/TestSets({Id})TestSets.View
PUT - /odata/TestSets({Id})TestSets.Edit
GET - /odata/TestSetSchedulesTestSetSchedules.View
POST - /odata/TestSetSchedulesTestSetSchedules.Create
DELETE - /odata/TestSetSchedules({Id})TestSetSchedules.Delete
GET - /odata/TestSetSchedules({Id})TestSetSchedules.View
PUT - /odata/TestSetSchedules({Id})TestSetSchedules.Edit
POST - /odata/TestSetSchedules/UiPath.Server.Configuration.OData.SetEnabledTestSetSchedules.Edit

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新