api.v2.AlertsTrigger Schnittstellenbeschreibung

Copyright ©

Mindbreeze GmbH, A-4020 Linz, 24.08.2018.

Alle Rechte vorbehalten. Alle verwendeten Hard- und Softwarenamen sind Handelsnamen und/oder Marken der jeweiligen Hersteller.

Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet.

Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.

Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.

ÜberblickPermanenter Link zu dieser Überschrift

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 die Crontab Expression leer ist wird der Alert nicht automatisch ausgeführt und kann nur mittels Alerts Trigger API ausgelöst werde. Alerts die eine Crontab Expression besitzen können natürlich auch mittels Alerts Trigger API zu einem gewünschten Zeitpunkt ausgelöst werden.

Alert mittels HTTP POST auslösen Permanenter Link zu dieser Überschrift

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 AlertsPermanenter Link zu dieser Überschrift

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.