- Primeros pasos
- Definición de Swagger
- API de Orchestrator
- Solicitudes de alertas
- Solicitudes de tareas de aplicaciones
- Solicitudes de activos
- Solicitudes de calendario
- Solicitudes de entornos
- Solicitudes de carpetas
- Solicitudes de tareas genéricas
- Solicitudes de trabajos
- Solicitudes de bibliotecas
- Solicitudes de licencia
- Solicitudes de paquetes
- Solicitudes de permisos
- Solicitudes de espacios de trabajo personales
- Solicitudes de procesos
- Procesar solicitudes de política de retención de datos
- Solicitudes de elementos en cola
- Solicitudes de política de retención de cola
- Solicitudes de robots
- Solicitudes de roles
- Solicitudes de horarios
- Solicitudes de configuración
- Solicitudes de cubos de almacenamiento
- Solicitudes de tareas
- Solicitudes de catálogos de tareas
- Solicitudes de formularios de tareas
- Solicitudes de tenants
- Solicitudes de transacciones
- Solicitudes de usuario
- Solicitudes de Webhooks
Guía de la API de Orchestrator
Orchestrator se integra con el servicio de notificaciones y utiliza el marco de alertas de Automation Cloud. Como resultado, la mayoría de las operaciones de alerta, como enumerar alertas y marcarlas como leídas, se exponen a través de la API de alertas de Automation Cloud en lugar de una API de Orchestrator dedicada.
Para obtener más detalles, consulta la sección Alertas en la guía de la API de Automation Cloud.
Orchestrator expone un punto final dedicado para generar alertas de proceso.
Generar una alerta de proceso
La siguiente solicitud te permite crear una alerta de proceso vinculada a un proceso y robot específicos, con una gravedad elegida.
Publicar
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert
Permisos necesarios
Alerts.Create
Solicitar encabezados.
| Clave | Valor |
|---|---|
| Autorización | Portador |
| X-UIPATH-OrganizationUnitId | ID de carpeta |
| X-UIPATH-ClaveDeTrabajo | Clave del trabajo |
Solicitar cuerpo
{
"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 del cuerpo de la solicitud
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
processAlert.Message | Cadena | Sí | El mensaje de alerta. Máximo 512 caracteres. |
processAlert.Severity | ENUM | Sí | El nivel de gravedad de la alerta: Info, Success, Warn, Error, Fatal. |
processAlert.RobotName | Cadena | Sí | El nombre del robot que ejecutó el proceso. Máximo 512 caracteres. |
processAlert.ProcessName | Cadena | Sí | El nombre del proceso que generó la alerta. Máximo 512 caracteres. |
Código de respuesta
200 OK