api.v2.AlertsTrigger Schnittstellenbeschreibung

Überblick

Mindbreeze InSpire stellt das Auslösen von definierten Alerts mit einer einfachen Schnittstelle zur Verfügung. Diese Schnittstelle basiert auf HTTP und JSON.

In der Client Service Konfiguration können Alerts definiert werden.

Wenn der Notification Schedule leer ist, wird der Alert nicht automatisch ausgeführt und kann nur mittels Alerts Trigger API ausgelöst werde. Alerts, die einen Notification Schedule besitzen, können natürlich auch mittels Alerts Trigger API zu einem gewünschten Zeitpunkt ausgelöst werden.
Eine Dokumentation und Beispiele zu den Cron Expressions finden Sie hier.

Alert mittels HTTP POST auslösen

Der Alerts Trigger Request wird als HTTP POST an ein Client Service gesendet. Der Pfad für das Speichern der Exportanfrage lautet: <Client Service URL>/api/v2/alerts/trigger

Der Request hat folgende Form:

{
   "collection_path": ["emailalert", "triggered"]
}

Mit diesem Request kann der “emailalert/triggered“ ausgelöst werden und alle Benutzer die Alerts in dieser Alert Collection erzeugt haben bekommen ihre Alerts zugestellt.

Falls es notwendig ist beim Trigger die Suchanfrage zusätzlich einzuschränken kann ein constraint mittels einer mindbreeze.api.v2.QuerExpr angegeben werden.

{
   "collection_path": ["emailalert", "triggered"],
   "constraint": <QueryExpr>
}

Als Antwort wird ein Status geliefert, der darüber Auskunft gibt ob der Alerts Trigger erfolgreich war.

{
   "status": {
      "success": true,
      "description": "Success"
   }
}

Berechtigungen zum Auslösen der Alerts

Alerts können nur von priviligierten Benutzern ausgelöst werden. User Administrator Users der Persisted Resources sind per Default berechtigt Alerts auszulösen. Benutzer der Gruppe builtin_notificationtrigger haben auch die Berechtigung Alerts auszulösen.