- 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 webhooks
Guia da API do Orchestrator
O Orchestrator integra-se ao Serviço de Notificação e usa a estrutura de Alertas do Automation Cloud. Como resultado, a maioria das operações de alerta, como listar alertas e marcá-los como lidos, é exposta por meio da API de Alertas do Automation Cloud em vez de uma API do Orchestrator dedicada.
Para obter detalhes, consulte a seção Alertas no guia da API do Automation Cloud.
O Orchestrator expõe um ponto de extremidade dedicado para gerar alertas de processo.
Gerando um alerta de processo
A solicitação a seguir permite que você crie um alerta de processo vinculado a um processo e robô específicos, com uma gravidade escolhida.
Postar
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert
Permissões necessárias
Alerts.Create
Cabeçalhos de solicitação.
| Chave | Valor |
|---|---|
| Autorização | O portador |
| X-UIPATH-OrganizationUnitId | ID da Pasta |
| Chave do Trabalho X-UIPATH | Chave do Trabalho |
Corpo da Solicitação
{
"processAlert": {
"Message": "The invoice processing job stopped unexpectedly.",
"Severity": "Error",
"ProcessName": "InvoiceProcessing",
"RobotName": "FinanceBot01"
}
}
{
"processAlert": {
"Message": "The invoice processing job stopped unexpectedly.",
"Severity": "Error",
"ProcessName": "InvoiceProcessing",
"RobotName": "FinanceBot01"
}
}
Parâmetros do corpo da solicitação
| Parâmetro | Tipo | Required | Description |
|---|---|---|---|
processAlert.Message | String | Sim | A mensagem de alerta. Máximo de 512 caracteres. |
processAlert.Severity | ENUM | Sim | O nível de gravidade do alerta: Info, Success, Warn, Error, Fatal. |
processAlert.RobotName | String | Sim | O nome do Robô que executou o processo. Máximo de 512 caracteres. |
processAlert.ProcessName | String | Sim | O nome do processo que gerou o alerta. Máximo de 512 caracteres. |
Código de resposta
200 OK