orchestrator
latest
false
Guia da API do Orchestrator
Guia da API do Orchestrator Automation Cloud · latest
- Recolher
Open Dropdown to choose product Permissões por endpoint
Importante :
A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.
Permissões por endpoint link
Ação Permissões GET - /tasks/GenericTasks/GetTaskDataById Tasks.View POST - /tasks/GenericTasks/CreateTask Tasks.Create POST - /tasks/GenericTasks/CompleteTask Tasks.Edit
Ação Permissões POST - /forms/TaskForms/CreateFormTask Tasks.Create GET - /forms/TaskForms/GetTaskFormById Tasks.View GET - /forms/TaskForms/GetTaskDataById Tasks.View POST - /forms/TaskForms/CompleteTask Tasks.Edit
Catálogos de Tarefas link
Ação Permissões 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
Ação Permissões GET - /odata/Tasks Tasks.View Obter /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
Ação Permissões 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
Ação Permissões GET - /odata/Folders Folders.View ou Subfolders.View POST - /odata/Folders Pastas.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.AssignUsers Folders.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.RemoveUserFromFolder Folders.Edit ou Subfolders.Edit e Users.View
Ação Permissões 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
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.
Ação Permissões 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
Ação Permissões 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
Ação Permissões 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
Ação Permissões 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 Storage Buckets.View e Storage Files.View GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetWriteUri Storage Buckets.View e Storage Files.Create GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFiles Storage Buckets.View e Storage Files.View GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetDirectories Storage Buckets.View e Storage Files.View GET - /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFile Storage Buckets.View e Storage Files.View DELETE - /odata/Buckets({key})/UiPath.Server.Configuration.OData.DeleteFile Storage Buckets.View e Storage Files.Delete
Ação Permissões GET - /odata/Environments Environments.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/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
Ação Permissões GetJobs Jobs.View GetJobs(Id) Jobs.View StartJobs Jobs.Create Parar Tarefa Jobs.Edit StopJobs Jobs.Edit
Ação Permissões SubmitLogs Logs.Create PostLogs Logs.Create
Ação Permissões GetPermissions
Ação Permissões 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
Ação Permissões GetQueueDefinitions Queues.View GetQueueDefinitions(Id) Queues.View Relatórios Visualização de Filas e Visualização de Transações PutQueueDefinitions(Id) Queues.Edit PostQueueDefinitions Queues.Create DeleteQueueDefinitions(Id) Queues.Delete
Ação Permissões GetQueueItemComments Visualização de Filas e Visualização de Transações GetQueueItemCommentsHistory Visualização de Filas e Visualização de Transações GetQueueItemComments(Id) Visualização de Filas e Visualização de Transações PostQueueItemComments Filas.Visualizar e Transações.Editar PutQueueItemComments(Id) Filas.Visualizar e Transações.Editar DeleteQueueItemComments(Id) Filas.Visualizar e Transações.Editar
Ação Permissões GET - /odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='{robotType}') License.View
Ação Permissões GET - /odata/LicensesRuntime/UiPath.Server.Configuration.OData.GetLicensesRuntime(robotType='robotType') License.View POST - /odata/LicensesRuntime('{Key}')/UiPath.Server.Configuration.OData.ToggleEnabled Machines.Edit
Eventos do QueueItem link
Ação Permissões GET - /odata/QueueItemEvents Visualizaçã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
Ação Permissões GetQueueItems Visualização de Filas e Visualização de Transações GetQueueItems(Id) Visualização de Filas e Visualização de Transações SetTransactionProgress Filas.Visualizar e Transações.Editar GetItemProcessingHistory Visualização de Filas e Visualização de Transações SetItemReviewStatus Filas.Visualizar e Transações.Editar DeleteQueueItems(Id) Queues.View & Transactions.Delete DeleteBulk Queues.View & Transactions.Delete SetItemReviewer Filas.Visualizar e Transações.Editar UnsetItemReviewer Filas.Visualizar e Transações.Editar GetReviewers Filas.Visualizar e Transações.Editar
QueueProcessingRecords link
Ação Permissões RetrieveLastDaysProcessingRecords Visualização de Filas e Visualização de Transações RetrieveQueuesProcessingStatus Queues.View
Ação Permissões SetTransactionResult Filas.Visualizar e Transações.Editar AddQueueItem Queues.View & Transactions.Create StartTransaction Filas.Visualização e Transações.Visualização e Transações.Criar e Transações.Editar BulkAddQueueItems Queues.View & Transactions.Create
Ação Permissões 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
Ação Permissões GET - /odata/UserLoginAttempts({Id}) Requer autenticação.
Ação Permissões GetRobotLogs Logs.View GetTotalCount Logs.View Relatórios Logs.View
Ação Permissões 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() 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.ConvertToFloating Robots.Edit
Ação Permissões GetProcessSchedules Schedules.View GetProcessSchedules(Id) Schedules.View GetRobotIdsForSchedule Schedules.View PostProcessSchedules Schedules.Create PutProcessSchedules(Id) Schedules.Edit SetEnabled Schedules.Edit DeleteProcessSchedules(Id) Schedules.Delete
Ação Permissões GetSessions Robots.View
Ação Permissões GetRoles Roles.View GetRoles(Id) Roles.View PostRoles Roles.Create PutRoles(Id) Roles.Edit DeleteRoles(Id) Roles.Delete SetUsers Users.Edit GetUsersForRole Roles.View & Users.View GetUserIdsForRole Roles.View or Users.View
Ação Permissões GetSettings Settings.View GetSettings(Id) Settings.View PutSettings(Id) Settings.Edit UpdateBulk Settings.Edit GetWebSettings Requer autenticação. GetExecutionSettingsConfiguration Settings.Edit ou Robots.Create ou Robots.Edit UploadLicense License.Create or License.Edit DeleteLicense License.Deletes GetLicense Requer autenticação.
Ação Permissões GetSessionsStats Robots.View GetJobsStats Jobs.View
Ação Permissões GetUsers Users.View GetUsers(Id) Users.View PostUsers Users.Create PutUsers Users.Edit PatchUsers(Id) Users.Edit DeleteUsers(Id) Users.Delete GetCurrentPermissions Requer autenticação. ToggleRole Users.Edit ImportUsers Users.Create SetActive Users.Edit ChangeCulture Requer autenticação.
Ação Permissões 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
Ação Permissões 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
Ação Permissões 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
Esta página foi útil? thumb_up Simthumb_down Não
Anterior Criação de solicitações de API
Avançar Códigos de resposta