- Démarrage
- Définition Swagger
- API Orchestrator
- Demandes d'alertes
- Demandes de tâches d'application
- Requêtes relatives aux actifs
- Requêtes de calendriers
- Requêtes relatives aux environnements
- Requêtes de dossiers
- Requêtes de tâches globales
- Requêtes relatives aux tâches
- Requêtes relatives aux bibliothèques
- Requêtes relatives aux licences
- Requêtes relatives aux paquets (Packages Requests)
- Requêtes relatives aux autorisations
- Demandes relatives aux espaces de travail personnels
- Requêtes relatives aux processus
- Traiter les requêtes liées à la stratégie de conservation des données
- Demandes d'éléments de la file d'attente
- Queue retention policy requests
- Requêtes relatives aux Robots
- Requêtes relatives aux rôles (Roles Requests)
- Requêtes relatives aux planifications
- Requêtes relatives aux paramètres
- Requêtes de compartiments de stockage
- Requêtes de tâches
- Demandes de catalogues de tâches
- Demandes de formulaires de tâches
- Requêtes relatives aux locataires
- Requêtes relatives aux transactions
- Requêtes relatives aux utilisateurs
- Requêtes relatives aux Webhooks
Guide de l'API Orchestrator
Orchestrator s'intègre au service de notification et utilise le cadre Automation Cloud Alerts. Par conséquent, la plupart des opérations d'alerte, telles que la liste des alertes et leur marquage comme lues, sont exposées via l'API Automation Cloud Alerts plutôt que d'une API Orchestrator dédiée.
Pour des détails, consultez la section Alertes dans le guide de l'API Automation Cloud.
Orchestrator expose un point de terminaison dédié pour déclencher des alertes de processus.
Générer une alerte de processus
La requête suivante permet de créer une alerte de processus liée à un processus et à un robot spécifiques, avec une gravité choisie.
Publier
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert
Autorisations requises
Alerts.Create
En-têtes de requête.
| Clé (Key) | Valeur (Value) |
|---|---|
| Autorisation | Porteur |
| X-UIPATH-OrganizationUnitId | ID de dossier |
| X-UIPATH-JobKey | Clé de la tâche |
Corps de la requête
{
"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"
}
}
Paramètres du corps de la requête
| Paramètre | Saisie de texte | Requis | Description |
|---|---|---|---|
processAlert.Message | Chaîne de caractères (string) | Oui (Yes) | Le message d'alerte. 512 caractères maximum. |
processAlert.Severity | ENUM | Oui (Yes) | Le niveau de gravité de l'alerte: Info, Success, Warn, Error, Fatal. |
processAlert.RobotName | Chaîne de caractères (string) | Oui (Yes) | Le nom du Robot qui a exécuté le processus. 512 caractères maximum. |
processAlert.ProcessName | Chaîne de caractères (string) | Oui (Yes) | Le nom du processus qui a généré l'alerte. 512 caractères maximum. |
Codes de réponse
200 OK