orchestrator
latest
false
  • 入门指南
    • 关于 OData 和引用
    • 枚举类型
    • 正在验证身份
    • 构建 API 请求
    • 每个端点的权限
    • 响应代码
    • 速率限制和大数据字段使用优化
  • Swagger 定义
  • Orchestrator API
UiPath logo, featuring letters U and I in white
Orchestrator API 指南
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated 2024年10月23日

每个端点的权限

通用任务

操作

权限

GET - /tasks/GenericTasks/GetTaskDataById

Tasks.View

POST - /tasks/GenericTasks/CreateTask

Tasks.Create

POST - /tasks/GenericTasks/CompleteTask

Tasks.Edit

任务表单

操作

权限

POST - /forms/TaskForms/CreateFormTask

Tasks.Create

GET - /forms/TaskForms/GetTaskFormById

Tasks.View

GET - /forms/TaskForms/GetTaskDataById

Tasks.View

POST - /forms/TaskForms/CompleteTask

Tasks.Edit

任务目录

操作

权限

GET - /odata/TaskCatalogs

TaskCatalogs.View

GET - /odata/TaskCatalogs(Id)

TaskCatalogs.View

POST - /odata/TaskCatalogs/UiPath.Server.Configuration.OData.CreateTaskCatalog

TaskCatalogs.Create

POST - /odata/TaskCatalogs(Id)/UiPath.Server.Configuration.OData.UpdateTaskCatalog

TaskCatalogs.Edit

任务

操作

权限

GET - /odata/Tasks

Tasks.View

获取/odata/Tasks(Id)

Tasks.View

POST - /odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks

Tasks.View & Tasks.Edit

POST - /odata/Tasks/UiPath.Server.Configuration.OData.ReassignTasks

Tasks.View 和 Tasks.Edit 和 TaskAssignment.Create

POST - /odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks

Tasks.View & Tasks.Edit

GET - /odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=organizationUnitId)

Tasks.View 和 Tasks.Edit 和 TaskAssignment.Create

执行介质

操作

权限

GET - /odata/ExecutionMedia

ExecutionMedia.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.DeleteMediaByJobId

ExecutionMedia.View

文件夹

操作

权限

GET - /odata/Folders

Folders.View 或 Subfolders.View

POST - /odata/Folders

Folders.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.AssignUsers

Folders.Edit 或 Subfolders.Edit Users.View 和 Roles.View

GET - /odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={key},includeInherited={includeInherited})

Folders.View 或 Subfolders.View Users.View

POST - /odata/Folders{Id}/UiPath.Server.Configuration.OData.RemoveUserFromFolder

Folders.Edit 或 Subfolders.Edit Users.View

操作

权限

GET - /odata/Libraries

Libraries.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.UploadPackage

Libraries.Create

警示

操作

权限

GET - /odata/Alerts

Alerts.View

GET - /odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount()

Alerts.View

POST - /odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead

Alerts.View

POST - /odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert

Alerts.Create

资产

操作

权限

GET - /odata/Assets

Assets.View

POST - /odata/Assets

Assets.Create

PUT - /odata/Assets({Id})

Assets.Edit

DELETE - /odata/Assets({Id})

Assets.Delete

POST - /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByNameForRobotKey

Assets.View

GET - /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId={robotId},assetName='{assetName}')

Assets.View

AuditLogs

操作

权限

GET - /odata/AuditLogs

Audit.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/Buckets

Storage Buckets.View

POST - /odata/Buckets

Storage 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

存储桶。查看 存储文件。查看

GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetWriteUri

存储 Buckets.View 存储 Files.Create

GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFiles

存储桶。查看 存储文件。查看

GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetDirectories

存储桶。查看 存储文件。查看

GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFile

存储桶。查看 存储文件。查看

DELETE - /odata/Buckets({key})/UiPath.Server.Configuration.OData.DeleteFile

Storage Buckets.View Storage Files.Delete

环境

操作

权限

GET - /odata/Environments

Environments.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/Environments

Environments.Create

PUT - /odata/Environments({Id})

Environments.Edit

DELETE - /odata/Environments({Id})

Environments.Delete

POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.AddRobot

Environments.Edit

POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.RemoveRobot

Environments.Edit

POST - /odata/Environments({Id})/UiPath.Server.Configuration.OData.SetRobots

Environments.Edit

作业

操作

权限

GetJobs

Jobs.View

GetJobs(Id)

Jobs.View

StartJobs

Jobs.Create

停止作业

Jobs.Edit

StopJobs

Jobs.Edit

日志

操作

权限

SubmitLogs

Logs.Create

PostLogs

Logs.Create

权限

操作

权限

GetPermissions

 

流程

操作

权限

GET - /odata/Processes

Packages.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.UploadPackage

Packages.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.SetArguments

Packages.Edit

QueueDefinitions

操作

权限

GetQueueDefinitions

Queues.View

GetQueueDefinitions(Id)

Queues.View

报告

队列.视图和事务.视图

PutQueueDefinitions(Id)

Queues.Edit

PostQueueDefinitions

Queues.Create

DeleteQueueDefinitions(Id)

Queues.Delete

QueueItemComments

操作

权限

GetQueueItemComments

队列.视图和事务.视图

GetQueueItemCommentsHistory

队列.视图和事务.视图

GetQueueItemComments(Id)

队列.视图和事务.视图

PostQueueItemComments

Queues.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.ToggleEnabled

Machines.Edit

队列项目事件

操作

权限

GET - /odata/QueueItemEvents

队列.视图和事务.视图

GET - /odata/QueueItemEvents/UiPath.Server.Configuration.OData.GetQueueItemEventsHistory(queueItemId=queueItemId)

队列.视图和事务.视图

GET - /odata/QueueItemEvents(Id)

队列.视图和事务.视图

队列项目

操作

权限

GetQueueItems

队列.视图和事务.视图

GetQueueItems(Id)

队列.视图和事务.视图

SetTransactionProgress

Queues.View 和 Transactions.Edit

GetItemProcessingHistory

队列.视图和事务.视图

SetItemReviewStatus

Queues.View 和 Transactions.Edit

DeleteQueueItems(Id)

Queues.View 和 Transactions.Delete

DeleteBulk

Queues.View 和 Transactions.Delete

SetItemReviewer

Queues.View 和 Transactions.Edit

UnsetItemReviewer

Queues.View 和 Transactions.Edit

GetReviewers

Queues.View 和 Transactions.Edit

QueueProcessingRecords

操作

权限

RetrieveLastDaysProcessingRecords

队列.视图和事务.视图

RetrieveQueuesProcessingStatus

Queues.View

队列

操作

权限

SetTransactionResult

Queues.View 和 Transactions.Edit

AddQueueItem

Queues.View 和 Transactions.Create

StartTransaction

队列。查看和事务。查看和事务。创建和事务。编辑

BulkAddQueueItems

Queues.View 和 Transactions.Create

发布

操作

权限

GET - /odata/Releases({Id})

Processes.View

GET - /odata/Releases

Processes.View

POST - /odata/Releases

Processes.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.UpdateToSpecificPackageVersion

Processes.Edit

POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersion

Processes.Edit

POST - /odata/Releases/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersionBulk

Processes.Edit

POST - /odata/Releases({Id})/UiPath.Server.Configuration.OData.RollbackToPreviousReleaseVersion

Processes.Edit

UserLoginAttempts

操作

权限

GET - /odata/UserLoginAttempts({Id})

需要身份验证

机器人日志

操作

权限

GetRobotLogs

Logs.View

GetTotalCount

Logs.View

报告

Logs.View

机器人

操作

权限

GET - /odata/Robots

Robots.View

GET - /odata/Robots({Id})

Robots.View

POST - /odata/Robots

Robots.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.DeleteBulk

Robots.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.ConvertToFloating

Robots.Edit

ProcessSchedules

操作

权限

GetProcessSchedules

Schedules.View

GetProcessSchedules(Id)

Schedules.View

GetRobotIdsForSchedule

Schedules.View

PostProcessSchedules

Schedules.Create

PutProcessSchedules(Id)

Schedules.Edit

SetEnabled

Schedules.Edit

DeleteProcessSchedules(Id)

Schedules.Delete

会话

操作

权限

GetSessions

Robots.View

角色

操作

权限

GetRoles

Roles.View

GetRoles(Id)

Roles.View

PostRoles

Roles.Create

PutRoles(Id)

Roles.Edit

DeleteRoles(Id)

Roles.Delete

SetUsers

Users.Edit

GetUsersForRole

“角色.视图”和“用户.视图”

GetUserIdsForRole

Roles.View or Users.View

设置

操作

权限

GetSettings

Settings.View

GetSettings(Id)

Settings.View

PutSettings(Id)

Settings.Edit

UpdateBulk

Settings.Edit

GetWebSettings

需要身份验证

GetExecutionSettingsConfiguration

Settings.Edit 或 Robots.Create 或 Robots.Edit

UploadLicense

License.Create or License.Edit

DeleteLicense

License.Deletes

GetLicense

需要身份验证

Stats

操作

权限

GetSessionsStats

Robots.View

GetJobsStats

Jobs.View

用户

操作

权限

GetUsers

Users.View

GetUsers(Id)

Users.View

PostUsers

Users.Create

PutUsers

Users.Edit

PatchUsers(Id)

Users.Edit

DeleteUsers(Id)

Users.Delete

GetCurrentPermissions

需要身份验证

ToggleRole

Users.Edit

ImportUsers

Users.Create

SetActive

Users.Edit

ChangeCulture

需要身份验证

计算机

操作

权限

GET - /odata/Machines

Machines.View

GET - /odata/Machines({Id})

Machines.View

POST - /odata/Machines

Machines.Create

PUT - /odata/Machines({Id})

Machines.Edit

DELETE - /odata/Machines({Id})

Machines.Delete

POST - /odata/Machines/UiPath.Server.Configuration.OData.DeleteBulk

Machines.Delete

PATCH - /odata/Machines({Id})

Machines.Edit

Webhooks

操作

权限

GetWebhooks

Webhooks.View

GetWebhooks(Id)

Webhooks.View

PostWebhooks

Webhooks.Create

PutWebhooks(Id)

Webhooks.Edit

PatchWebhooks(Id)

Webhooks.Edit

DeleteWebhooks

Webhooks.Delete

Ping

Webhooks.View

GetEventTypes

Webhooks.View

TriggerCustom

Webhooks.View

测试自动化

操作

权限

POST - /api/TestAutomation/StartTestSetExecution

TestSetExecutions.Create

POST - /api/TestAutomation/CancelTestSetExecution

TestSetExecutions.Edit

POST - /api/TestAutomation/CancelTestCaseExecution

TestSetExecutions.Edit

GET - /api/TestAutomation/GetAssertionScreenshot

TestSetExecutions.View

POST - /api/TestAutomation/CreateTestSetForReleaseVersion

TestSets.Create

GET - /odata/TestCaseDefinitions

TestSets.View

GET - /odata/TestCaseExecutions

TestSetExecutions.View

GET - /odata/TestCaseExecutions({Id})

TestSetExecutions.View

GET - /odata/TestSetExecutions

TestSetExecutions.View

GET - /odata/TestCaseExecutions({Id})

TestSetExecutions.View

GET - /odata/TestSets

TestSets.View

POST - /odata/TestSets

TestSets.Create

DELETE - /odata/TestSets({Id})

TestSets.Delete

GET - /odata/TestSets({Id})

TestSets.View

PUT - /odata/TestSets({Id})

TestSets.Edit

GET - /odata/TestSetSchedules

TestSetSchedules.View

POST - /odata/TestSetSchedules

TestSetSchedules.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.SetEnabled

TestSetSchedules.Edit

此页面有帮助吗?

获取您需要的帮助
了解 RPA - 自动化课程
UiPath Community 论坛
Uipath Logo White
信任与安全
© 2005-2024 UiPath。保留所有权利。