- Erste Schritte
- Swagger-Definition
- Orchestrator-APIs
- Warnungsanforderungen
- App-Aufgabenanforderungen
- Anfragen zu Assets
- Kalenderanforderungen
- Umgebungsabfragen
- Ordneranforderungen
- Anforderungen für generische Aufgaben
- Jobanfragen
- Bibliotheksabfragen
- Lizenzabfragen
- Paketanfragen
- Berechtigungsabfragen
- Anforderungen für persönliche Arbeitsbereiche
- Prozessabfragen
- Bearbeitung von Anforderungen an die Datenaufbewahrung
- Anforderungen von Warteschlangenelementen
- Queue retention policy requests
- Roboteranfragen
- Rollenanfragen
- Zeitplanabfragen
- Anfragen zu Einstellungen
- Anforderungen für Speicher-Buckets
- Aufgabenanforderungen
- Aufgabenkataloganforderungen
- Aufgabenformularanforderungen
- Mandantenabfragen
- Transaktionsanfragen
- Benutzerabfragen
- Webhook-Abfragen
Anleitung für die Orchestrator-API
Orchestrator ist in den Benachrichtigungsdienst integriert und verwendet das Automation Cloud Alerts-Framework. Infolgedessen werden die meisten Warnungsvorgänge, wie das Auflisten von Warnungen und das Markieren als gelesen, über die Automation Cloud Alerts API und nicht über eine dedizierte Orchestrator-API angezeigt.
Weitere Informationen finden Sie im Abschnitt Warnungen im Automation Cloud-API-Handbuch.
Der Orchestrator stellt einen dedizierten Endpunkt zum Auslösen von Prozesswarnungen bereit.
Auslösen einer Prozesswarnung
Mit der folgenden Abfrage können Sie eine Prozesswarnung erstellen, die an einen bestimmten Prozess und Roboter mit einem ausgewählten Schweregrad gebunden ist.
Posten
{AutomationCloudURL}/{organizationName}/{tenantName}/orchestrator_/odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert
Erforderliche Berechtigungen
Alerts.Create
Anforderungsheader
| Schlüssel | Wert |
|---|---|
| Autorisierung | Inhaber |
| X-UIPATH-OrganizationUnitId | Ordner-ID |
| X-UIPATH-Auftragsschlüssel | Auftragsschlüssel |
Anforderungstext
{
"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"
}
}
Textparameter der Anforderung
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
processAlert.Message | String | Ja | Die Warnmeldung. Maximal 512 Zeichen. |
processAlert.Severity | ENUM | Ja | Der Schweregrad der Warnung: Info, Success, Warn, Error, Fatal. |
processAlert.RobotName | String | Ja | Der Name des Roboters, der den Prozess ausgeführt hat. Maximal 512 Zeichen. |
processAlert.ProcessName | String | Ja | Der Name des Prozesses, der die Warnung generiert hat. Maximal 512 Zeichen. |
Antwortcode
200 OK