UiPath Documentation
orchestrator
2023.10
false
Importante :
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.
UiPath logo, featuring letters U and I in white

Guia da API do Orchestrator

Última atualização 24 de mar de 2026

Permissões por endpoint

Tarefas Genéricas

AçãoPermissões
GET - /tasks/GenericTasks/GetTaskDataByIdTasks.View
POST - /tasks/GenericTasks/CreateTaskTasks.Create
POST - /tasks/GenericTasks/CompleteTaskTasks.Edit

Formulários de tarefas

AçãoPermissões
POST - /forms/TaskForms/CreateFormTaskTasks.Create
GET - /forms/TaskForms/GetTaskFormByIdTasks.View
GET - /forms/TaskForms/GetTaskDataByIdTasks.View
POST - /forms/TaskForms/CompleteTaskTasks.Edit

Catálogos de Tarefas

AçãoPermissões
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

Tarefas

AçãoPermissões
GET - /odata/TasksTasks.View
Obter /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

Meios de Execução

AçãoPermissões
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

Pastas

AçãoPermissões
GET - /odata/FoldersFolders.View ou Subfolders.View
POST - /odata/FoldersPastas.Criar ou Subpastas.Criar
DELETE -/odata/Folders{Id}Pastas.Excluir ou Subpastas.Excluir
GET - /odata/Folders{Id}Folders.View ou Subfolders.View
PUT - /odata/Folders{Id}Pastas.Editar ou Subpastas.Editar
POST - /odata/Folders/UiPath.Server.Configuration.OData.AssignUsersFolders.Edit ou Subfolders.Edit e Users.View e Roles.View
GET - /odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={key},includeInherited={includeInherited})Folders.View ou Subfolders.View e Users.View
POST - /odata/Folders{Id}/UiPath.Server.Configuration.OData.RemoveUserFromFolderFolders.Edit ou Subfolders.Edit e Users.View

Bibliotecas

AçãoPermissões
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
Observação:

O ponto de extremidade da API GetVersions opera em um único feed por solicitação. Quando o escopo do feed for definido como All (Host + Tenant), o ponto de extremidade retornará apenas versões do feed do tenant.

Alertas

AçãoPermissões
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

Ativos

AçãoPermissões
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

AçãoPermissões
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

Buckets

AçãoPermissões
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.GetReadUriStorage Buckets.View e Storage Files.View
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetWriteUriStorage Buckets.View e Storage Files.Create
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFilesStorage Buckets.View e Storage Files.View
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetDirectoriesStorage Buckets.View e Storage Files.View
GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFileStorage Buckets.View e Storage Files.View
DELETE - /odata/Buckets({key})/UiPath.Server.Configuration.OData.DeleteFileStorage Buckets.View e Storage Files.Delete

Ambientes

AçãoPermissões
GET - /odata/EnvironmentsEnvironments.View
GET - /odata/Environments({Id})Environments.View
GET - /odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key={key})Ambientes.View & Robots.View
GET - /odata/Environments/UiPath.Server.Configuration.OData.GetRobotIdsForEnvironment(key={key})Ambientes.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

Trabalhos

AçãoPermissões
GetJobsJobs.View
GetJobs(Id)Jobs.View
StartJobsJobs.Create
Parar TarefaJobs.Edit
StopJobsJobs.Edit

Logs

AçãoPermissões
SubmitLogsLogs.Create
PostLogsLogs.Create

Permissões

AçãoPermissões
GetPermissions

Processos

AçãoPermissões
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

AçãoPermissões
GetQueueDefinitionsQueues.View
GetQueueDefinitions(Id)Queues.View
RelatóriosVisualização de Filas e Visualização de Transações
PutQueueDefinitions(Id)Queues.Edit
PostQueueDefinitionsQueues.Create
DeleteQueueDefinitions(Id)Queues.Delete

QueueItemComments

AçãoPermissões
GetQueueItemCommentsVisualização de Filas e Visualização de Transações
GetQueueItemCommentsHistoryVisualização de Filas e Visualização de Transações
GetQueueItemComments(Id)Visualização de Filas e Visualização de Transações
PostQueueItemCommentsFilas.Visualizar e Transações.Editar
PutQueueItemComments(Id)Filas.Visualizar e Transações.Editar
DeleteQueueItemComments(Id)Filas.Visualizar e Transações.Editar

LicensesNamedUser

AçãoPermissões
GET - /odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='{robotType}')License.View

LicensesRuntime

AçãoPermissões
GET - /odata/LicensesRuntime/UiPath.Server.Configuration.OData.GetLicensesRuntime(robotType='robotType')License.View
POST - /odata/LicensesRuntime('{Key}')/UiPath.Server.Configuration.OData.ToggleEnabledMachines.Edit

Eventos do QueueItem

AçãoPermissões
GET - /odata/QueueItemEventsVisualização de Filas e Visualização de Transações
GET - /odata/QueueItemEvents/UiPath.Server.Configuration.OData.GetQueueItemEventsHistory(queueItemId=queueItemId)Visualização de Filas e Visualização de Transações
GET - /odata/QueueItemEvents(Id)Visualização de Filas e Visualização de Transações

QueueItems

AçãoPermissões
GetQueueItemsVisualização de Filas e Visualização de Transações
GetQueueItems(Id)Visualização de Filas e Visualização de Transações
SetTransactionProgressFilas.Visualizar e Transações.Editar
GetItemProcessingHistoryVisualização de Filas e Visualização de Transações
SetItemReviewStatusFilas.Visualizar e Transações.Editar
DeleteQueueItems(Id)Queues.View & Transactions.Delete
DeleteBulkQueues.View & Transactions.Delete
SetItemReviewerFilas.Visualizar e Transações.Editar
UnsetItemReviewerFilas.Visualizar e Transações.Editar
GetReviewersFilas.Visualizar e Transações.Editar

QueueProcessingRecords

AçãoPermissões
RetrieveLastDaysProcessingRecordsVisualização de Filas e Visualização de Transações
RetrieveQueuesProcessingStatusQueues.View

Filas

AçãoPermissões
SetTransactionResultFilas.Visualizar e Transações.Editar
AddQueueItemQueues.View & Transactions.Create
StartTransactionFilas.Visualização e Transações.Visualização e Transações.Criar e Transações.Editar
BulkAddQueueItemsQueues.View & Transactions.Create

Versões

AçãoPermissões
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

AçãoPermissões
GET - /odata/UserLoginAttempts({Id})Requer autenticação.

Logs do Robot

AçãoPermissões
GetRobotLogsLogs.View
GetTotalCountLogs.View
RelatóriosLogs.View

Robôs

AçãoPermissões
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()Robots.Create & Machines.View
GET - /odata/Robots/UiPath.Server.Configuration.OData.GetUsernames()Robots.View
GET - /odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess(processId='{processId}')Robots.View & Environments.View & Processes.View
POST - /odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloatingRobots.Edit

ProcessSchedules

AçãoPermissões
GetProcessSchedulesSchedules.View
GetProcessSchedules(Id)Schedules.View
GetRobotIdsForScheduleSchedules.View
PostProcessSchedulesSchedules.Create
PutProcessSchedules(Id)Schedules.Edit
SetEnabledSchedules.Edit
DeleteProcessSchedules(Id)Schedules.Delete

Sessões

AçãoPermissões
GetSessionsRobots.View

Funções

AçãoPermissões
GetRolesRoles.View
GetRoles(Id)Roles.View
PostRolesRoles.Create
PutRoles(Id)Roles.Edit
DeleteRoles(Id)Roles.Delete
SetUsersUsers.Edit
GetUsersForRoleRoles.View & Users.View
GetUserIdsForRoleRoles.View or Users.View

Configurações

AçãoPermissões
GetSettingsSettings.View
GetSettings(Id)Settings.View
PutSettings(Id)Settings.Edit
UpdateBulkSettings.Edit
GetWebSettingsRequer autenticação.
GetExecutionSettingsConfigurationSettings.Edit ou Robots.Create ou Robots.Edit
UploadLicenseLicense.Create or License.Edit
DeleteLicenseLicense.Deletes
GetLicenseRequer autenticação.

Stats

AçãoPermissões
GetSessionsStatsRobots.View
GetJobsStatsJobs.View

Usuários

AçãoPermissões
GetUsersUsers.View
GetUsers(Id)Users.View
PostUsersUsers.Create
PutUsersUsers.Edit
PatchUsers(Id)Users.Edit
DeleteUsers(Id)Users.Delete
GetCurrentPermissionsRequer autenticação.
ToggleRoleUsers.Edit
ImportUsersUsers.Create
SetActiveUsers.Edit
ChangeCultureRequer autenticação.

Máquinas

AçãoPermissões
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

AçãoPermissões
GetWebhooksWebhooks.View
GetWebhooks(Id)Webhooks.View
PostWebhooksWebhooks.Create
PutWebhooks(Id)Webhooks.Edit
PatchWebhooks(Id)Webhooks.Edit
DeleteWebhooksWebhooks.Delete
PingWebhooks.View
GetEventTypesWebhooks.View
TriggerCustomWebhooks.View

Automação de Teste

AçãoPermissões
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

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades