- Introdução
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de tarefas de aplicativo
- Solicitações de ativos
- Solicitações de calendários
- Solicitações de ambientes
- Solicitações de pastas
- Solicitações de tarefas genéricas
- Solicitações de trabalhos
- Solicitações de bibliotecas
- Solicitações de licenças
- Solicitações de pacotes
- Solicitações de permissões
- Solicitações de espaços de trabalho pessoais
- Solicitações de processos
- Processar solicitações de política de retenção de dados
- Solicitações de itens de fila
- Solicitações da política de retenção de filas
- Solicitações de robôs
- Solicitações de funções
- Solicitações de agendamentos
- Solicitações de configurações
- Solicitações de bucket de armazenamento
- Solicitações de tarefas
- Solicitações de catálogos de tarefas
- Solicitações de formulários de tarefas
- Solicitações de tenants
- Solicitações de Transações
- Solicitações de usuários
- Solicitações de gravações de vídeo
- Solicitações de webhooks
Pontos de extremidade de API para recuperar tarefas em tipos de pastas, incluindo notas descontinuadas para pontos de extremidade de pastas clássicos.
Recuperar tarefas em uma pasta
Esta solicitação permite recuperar todas as tarefas nas pastas clássicas às quais o usuário tem acesso.
Esse ponto de extremidade recupera apenas ações em pastas clássicas e será descontinuado no futuro. Use os seguintes para recuperar ações, independentemente do tipo de pasta:
odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersodata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersForAdmin
Obter
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks?$top=2
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks",
"@odata.count": 21,
"value": [
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:39:30.41Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 63
},
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:40:24.88Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 64
}
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks",
"@odata.count": 21,
"value": [
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:39:30.41Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 63
},
{
"Title": "Performance Review",
"Type": "FormTask",
"Priority": "Medium",
"Status": "Completed",
"CreationTime": "2019-10-16T11:40:24.88Z",
"TaskCatalogName": "Expecto Patronum",
"OrganizationUnitId": 828,
"IsCompleted": true,
"Id": 64
}
Recuperar detalhes da tarefa
Essa solicitação permite que você recupere detalhes da tarefa de acordo com o TaskId. O TaskId deve ser incluído na solicitação. Por exemplo, {AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks(194).
Obter
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks(194)
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks/$entity",
"Title": "Verify Credentials",
"Type": "FormTask",
"Priority": "Critical",
"Status": "Unassigned",
"CreationTime": "2019-12-12T17:25:03.02Z",
"TaskCatalogName": "Auth",
"OrganizationUnitId": 828,
"IsCompleted": false,
"Id": 194
}
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Tasks/$entity",
"Title": "Verify Credentials",
"Type": "FormTask",
"Priority": "Critical",
"Status": "Unassigned",
"CreationTime": "2019-12-12T17:25:03.02Z",
"TaskCatalogName": "Auth",
"OrganizationUnitId": 828,
"IsCompleted": false,
"Id": 194
}
Atribuir uma Tarefa para o Usuário
Essa solicitação permite que você atribua uma tarefa a um usuário, de acordo com TaskId e UserId. Uma única solicitação pode lidar com a atribuição de várias tarefas a diferentes usuários.
Postar
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Corpo da Solicitação
{
"taskAssignments":
[
{
"TaskId": 194,
"UserId": 52454
}
]
}
{
"taskAssignments":
[
{
"TaskId": 194,
"UserId": 52454
}
]
}
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 195,
"UserId": 52454,
"ErrorCode": 2400,
"ErrorMessage": "Task is already assigned"
}
]
}
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 195,
"UserId": 52454,
"ErrorCode": 2400,
"ErrorMessage": "Task is already assigned"
}
]
}
Desatribuir Tarefas
Essa solicitação permite que você limpe a atribuição de uma ou várias tarefas com base no taskIds fornecido.
Postar
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Corpo da Solicitação
{
"taskIds": [
194,177
]
}
{
"taskIds": [
194,177
]
}
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 177,
"UserId": null,
"ErrorCode": 2400,
"ErrorMessage": "This task is in completed state"
}
]
}
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 177,
"UserId": null,
"ErrorCode": 2400,
"ErrorMessage": "This task is in completed state"
}
]
}
Retornar usuários com permissões de Visualização e Edição em tarefas
Essa solicitação permite que você recupere usuários com permissões de Visualizar e Editar em Tarefas. O ID da pasta deve ser incluído na solicitação.
Obter
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId=36886)
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UserLoginInfo",
"@odata.count": 13,
"value": [
{
"Name": "Harry",
"Surname": "Potter",
"UserName": "harry.potter@uipath.com",
"EmailAddress": "harry.potter@uipath.com",
"Id": 52454
},
{
"Name": "Severus",
"Surname": "Snape",
"UserName": "severus.snape@uipath",
"EmailAddress": "severus.snape@uipath.com",
"Id": 52917
}
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UserLoginInfo",
"@odata.count": 13,
"value": [
{
"Name": "Harry",
"Surname": "Potter",
"UserName": "harry.potter@uipath.com",
"EmailAddress": "harry.potter@uipath.com",
"Id": 52454
},
{
"Name": "Severus",
"Surname": "Snape",
"UserName": "severus.snape@uipath",
"EmailAddress": "severus.snape@uipath.com",
"Id": 52917
}
Excluir uma tarefa
Essa solicitação permite que você exclua uma ou mais tarefas por seus IDs.
Postar
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Tasks/UiPath.Server.Configuration.OData.DeleteTasks
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Corpo da Solicitação
{
"taskIds": [
104177
]
}
{
"taskIds": [
104177
]
}
Código de resposta
200 OK
Corpo da Resposta
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 104177,
"UserId": null,
"ErrorCode": 2427,
"ErrorMessage": "You do not have the required permissions to delete this action"
}
]
}
{
"@odata.context": "{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Collection(UiPath.Orchestrator.Tasks.Dto.TaskAssignmentErrorResponse)",
"value": [
{
"TaskId": 104177,
"UserId": null,
"ErrorCode": 2427,
"ErrorMessage": "You do not have the required permissions to delete this action"
}
]
}
- Recuperar tarefas em uma pasta
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Recuperar detalhes da tarefa
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Atribuir uma Tarefa para o Usuário
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Corpo da Resposta
- Desatribuir Tarefas
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Corpo da Resposta
- Retornar usuários com permissões de Visualização e Edição em tarefas
- Cabeçalhos de solicitação.
- Código de resposta
- Corpo da Resposta
- Excluir uma tarefa
- Cabeçalhos de solicitação.
- Corpo da Solicitação
- Código de resposta
- Corpo da Resposta