- Introdução
- Definição do Swagger
- APIs do Orchestrator
- Solicitações de alertas
- Solicitações de tarefas do 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 webhooks

Guia da API do Orchestrator
Use os endpoints a seguir para recuperar metadados e informações de status da tarefa do aplicativo.
Você pode solicitar tarefas do aplicativo usando o ID ou a chave retornada ao criar ou listar tarefas.
De acordo com o ID de tarefa do aplicativo
Recupere uma tarefa do aplicativo usando o ID dela.
Obter
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/AppTasks/GetAppTaskById
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Código de resposta
200 Sucesso
Corpo da Resposta
{
"id": 58293,
"key": "7b847a63-b4db-4c0a-a256-afd3b70f729f",
"title": "Approve Purchase Request",
"status": "Pending",
"priority": "Normal",
"type": "AppTask",
"appTasksMetadata": {
"appId": "myapp-12345",
"appVersion": 3,
"creationTime": "2024-01-11T10:20:30Z",
"id": 58293
}
}
{
"id": 58293,
"key": "7b847a63-b4db-4c0a-a256-afd3b70f729f",
"title": "Approve Purchase Request",
"status": "Pending",
"priority": "Normal",
"type": "AppTask",
"appTasksMetadata": {
"appId": "myapp-12345",
"appVersion": 3,
"creationTime": "2024-01-11T10:20:30Z",
"id": 58293
}
}
De acordo com a chave de tarefa do aplicativo
Recupere uma tarefa do aplicativo usando sua chave exclusiva.
Obter
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/AppTasks/GetAppTaskByKey
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Código de resposta
200 Sucesso
Corpo da Resposta
{
"id": 58293,
"key": "7b847a63-b4db-4c0a-a256-afd3b70f729f",
"title": "Approve Purchase Request",
"status": "Pending",
"priority": "Normal",
"type": "AppTask",
"appTasksMetadata": {
"appId": "myapp-12345",
"appVersion": 3,
"creationTime": "2024-01-11T10:20:30Z",
"id": 58293
}
}
{
"id": 58293,
"key": "7b847a63-b4db-4c0a-a256-afd3b70f729f",
"title": "Approve Purchase Request",
"status": "Pending",
"priority": "Normal",
"type": "AppTask",
"appTasksMetadata": {
"appId": "myapp-12345",
"appVersion": 3,
"creationTime": "2024-01-11T10:20:30Z",
"id": 58293
}
}
Use esse ponto de extremidade para criar uma nova tarefa do aplicativo com base em uma definição de aplicativo e tarefa implantada anteriormente.
Obter
https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/tasks/AppTasks/CreateAppTask
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
Código de resposta
201 criado
Corpo da Solicitação
{
"appId": "myapp-12345",
"appVersion": 3,
"folderKey": "folder-12345-678910",
"fpsContext": (),
"runtime": "Serverless",
"appType": "Custom",
"appProcessKey": "key123-4567-8910",
"isActionableMessageEnabled": false,
"title": "Approve Purchase Request",
"type": "AppTask",
"title": "string",
"priority": "Normal",
"data": {
"Amount": 2450,
"Requester": "John Doe"
}
}
{
"appId": "myapp-12345",
"appVersion": 3,
"folderKey": "folder-12345-678910",
"fpsContext": (),
"runtime": "Serverless",
"appType": "Custom",
"appProcessKey": "key123-4567-8910",
"isActionableMessageEnabled": false,
"title": "Approve Purchase Request",
"type": "AppTask",
"title": "string",
"priority": "Normal",
"data": {
"Amount": 2450,
"Requester": "John Doe"
}
}
Corpo da Resposta
{
"taskDefinitionPropertiesId": null,
"appTasksMetadata": null,
"actionLabel": null,
"status": 0,
"data": null,
"action": null,
"waitJobState": null,
"organizationUnitFullyQualifiedName": null,
"tags": [],
"assignedToUser": null,
"taskSlaDetails": null,
"completedByUser": null,
"taskAssignmentCriteria": "SingleUser",
"taskAssignees": null,
"isCurrentUserInAllUserAssignedGroup": null,
"taskSource": null,
"processingTime": null,
"title": "string",
"type": "AppTask",
"priority": "Low",
"assignedToUserId": null,
"assignedToUserKey": null,
"organizationUnitId": 1,
"organizationUnitKey": "key-12345",
"externalTag": null,
"creatorJobKey": "00000000-0000-0000-0000-000000000000",
"waitJobKey": null,
"lastAssignedTime": null,
"completionTime": null,
"parentOperationId": null,
"key": "f1ac-12345",
"isDeleted": false,
"deleterUserId": null,
"deletionTime": null,
"lastModificationTime": null,
"lastModifierUserId": null,
"creationTime": "2025-12-11T09:23:05.9915069Z",
"creatorUserId": "user-12345",
"id": 12345
}{
"taskDefinitionPropertiesId": null,
"appTasksMetadata": null,
"actionLabel": null,
"status": 0,
"data": null,
"action": null,
"waitJobState": null,
"organizationUnitFullyQualifiedName": null,
"tags": [],
"assignedToUser": null,
"taskSlaDetails": null,
"completedByUser": null,
"taskAssignmentCriteria": "SingleUser",
"taskAssignees": null,
"isCurrentUserInAllUserAssignedGroup": null,
"taskSource": null,
"processingTime": null,
"title": "string",
"type": "AppTask",
"priority": "Low",
"assignedToUserId": null,
"assignedToUserKey": null,
"organizationUnitId": 1,
"organizationUnitKey": "key-12345",
"externalTag": null,
"creatorJobKey": "00000000-0000-0000-0000-000000000000",
"waitJobKey": null,
"lastAssignedTime": null,
"completionTime": null,
"parentOperationId": null,
"key": "f1ac-12345",
"isDeleted": false,
"deleterUserId": null,
"deletionTime": null,
"lastModificationTime": null,
"lastModifierUserId": null,
"creationTime": "2025-12-11T09:23:05.9915069Z",
"creatorUserId": "user-12345",
"id": 12345
}