/
NotificationService (/notifications)

NotificationService (/notifications)

Owned by Team Dodo
Last updated: Apr 01, 2025 by Technische Redaktion
11 min read

/osrest/api/notifications

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die Methode liefert eine Liste aller Benachrichtigungen (Abonnements und Wiedervorlagen).

Optionale Parameter sind:

  • showown (boolean): Gibt an, ob Benachrichtigungen an sich selbst angezeigt werden sollen (Standard: false).

  • starttime (int - Unix Timestamp): Zeitpunkt, ab welchem Benachrichtigungen angezeigt werden sollen (Standard: keine Beschränkung).

  • metadata (String): Dateiname eines alternativen Metadatenmappings

  • reload (boolean): Falls true, wird das Caching ignoriert und die Benachrichtigungen werden neu vom Server geladen. Der Cache wird aktualisiert.

  • user (String): Name eines Benutzers, für den die Benachrichtigungen angezeigt werden sollen. Setzt voraus, dass die IP des Anfragenden in der osrest.properties eingetragen ist.

  • verbose (boolean): Es wird zusätzlich ein erweitertes generische Metadatenmodell ausgegeben.

  • clienttype (String): Angeben, für welchen Client-Typ Workflow-Benachrichtigungen erhalten werden ("web", "mobile", "desktop" bzw. mit bestimmter Sprache z. B. "web_de", "web_en", "web_fr").

Um diese Funktion auch für Workflowbenachrichtigungen zu nutzen, muss die Nutzung des Workflows über die Konfiguration aktiviert werden.

/osrest/api/notifications/revisits

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die Methode liefert eine Liste aller Benachrichtigungen zu Wiedervorlagen.

Optionale Parameter sind:

  • showown (boolean): Gibt an, ob Benachrichtigungen an sich selbst angezeigt werden sollen (Standard: false).

  • starttime (int - Unix Timestamp): Zeitpunkt, ab dem Benachrichtigungen angezeigt werden sollen (Standard: keine Beschränkung).

  • metadata (String): Dateiname eines alternativen Metadatenmappings

  • verbose (boolean): Es wird zusätzlich ein erweitertes generische Metadatenmodell ausgegeben.

/osrest/api/notifications/subscriptions

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die Methode liefert eine Liste aller Benachrichtigungen zu abonnierten Objekten.

Optionale Parameter sind:

  • showown (boolean): Gibt an, ob Benachrichtigungen an sich selbst angezeigt werden sollen (Standard: false).

  • starttime (int - Unix Timestamp): Zeitpunkt, ab dem Benachrichtigungen angezeigt werden sollen (Standard: keine Beschränkung).

  • metadata (String): Dateiname eines alternativen Metadatenmappings

  • verbose (boolean): Es wird zusätzlich ein erweitertes generische Metadatenmodell ausgegeben.

/osrest/api/notifications/revisits/remove/{id}/{eventDate}

  • Unterstützte Anfragemethoden: GET

Diese Methode löscht die Benachrichtigung einer Wiedervorlage. Dazu sind sowohl die Objekt-ID {id} als auch das Datum {eventDate} (beides Felder einer Benachrichtigung) anzugeben. Die Funktion gibt bei Erfolg den Wert 0 zurück.

Erforderliche Parameter:

  • id: ID des Objekts, für welches die Benachrichtigung entfernt werden soll.

  • eventDate: Datum der Benachrichtigung

/osrest/api/notifications/revisits/remove

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Diese Methode löscht mehrere Benachrichtigungen zu Wiedervorlagen. Dazu sind jeweils sowohl die Objekt-ID {id} als auch das Datum {eventDate} anzugeben.

Sollte ein Fehler beim Löschen eintreten, gibt die Methode eine Liste mit den Benachrichtigungen zurück, die nicht gelöscht werden konnten.

Erforderliche Parameter:

  • id: ID des Objekts, für welches die Benachrichtigung entfernt werden soll.

  • eventDate: Datum der Benachrichtigung

  • senderId: Der Auslöser der Wiedervorlage (optional)

POST Beispiel

[ { "id": 4999, "eventDate": 1459760812000, "senderId": 8991 }, ... ]

/osrest/api/notifications/revisits/markread/{id}/{eventDate}

  • Unterstützte Anfragemethoden: GET

Die Methode setzt für eine Benachrichtigung von einer Wiedervorlage den Status Gelesen oder Ungelesen. Dazu sind sowohl die Objekt-ID {id} als auch das Datum {eventDate} (beides Felder einer Benachrichtigung) anzugeben. Wenn {reset} als Parameter gesetzt ist, wird die Benachrichtigung als ungelesen markiert. 

Die Funktion gibt bei Erfolg den Wert 0 zurück.

Erforderliche Parameter:

  • id: ID des Objekts

  • eventDate: Datum der Benachrichtigung

Optionale Parameter:

  • reset: Benachrichtigung als ungelesen markieren

/osrest/api/notifications/revisits/markread

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Die Methode setzt für Benachrichtigungen von Wiedervorlagen den Status Gelesen oder Ungelesen. Dazu sind jeweils sowohl die Objekt-ID {id} als auch das Datum {eventDate} (beides Felder einer Benachrichtigung) anzugeben. Wenn {reset} als Parameter gesetzt ist, werden die Benachrichtigungen als ungelesen markiert.

Sollte ein Fehler beim "Gelesen markieren" eintreten, gibt die Methode eine Liste mit den Benachrichtigungen zurück, die nicht als gelesen oder ungelesen markiert werden konnten.

Erforderliche Parameter:

  • id: ID des Objekts

  • eventDate: Datum der Benachrichtigung

  • senderId: Der Auslöser der Wiedervorlage (optional)

Optionale Parameter:

  • reset: Benachrichtigung als ungelesen markieren

POST Beispiel

[ { "id": 4999, "eventDate": 1459760812000, "senderId": 8991 }, ... ]

/osrest/api/notifications/revisits/process/{id}/{eventDate}

  • Unterstützte Anfragemethoden: GET

Die Methode setzt für eine Benachrichtigung von einer Wiedervorlage den Status Bearbeitet oder Unbearbeitet. Dazu sind sowohl die Objekt-ID {id} als auch das Datum {eventDate} (beides Felder einer Benachrichtigung) anzugeben. Wenn {open} als Parameter gesetzt ist, wird die Benachrichtigung als Unbearbeitet markiert. 

Die Funktion gibt bei Erfolg den Wert 0 zurück.

Erforderliche Parameter:

  • id: ID des Objekts

  • eventDate: Datum der Benachrichtigung

Optionale Parameter:

  • reset: Benachrichtigung als unbearbeitet markieren

  • password: Base64-Kodiertes Passwort für den eigenen Account, falls die Wiedervorlage eine Passwortvalidierung verlangt. Verlangt sie dies und wird kein Passwort übermittelt, so schlägt die Aktion fehl.

/osrest/api/notifications/revisits/process

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Die Methode setzt für Benachrichtigungen von Wiedervorlagen den Status Bearbeitet oder Unbearbeitet. Dazu sind jeweils sowohl die Objekt-ID {id} als auch das Datum {eventDate} (beides Felder einer Benachrichtigung) anzugeben. Wenn {reset} als Parameter gesetzt ist, werden die Benachrichtigungen als Unbearbeitet markiert. Sollte ein Fehler beim "Bearbeitet markieren" eintreten, gibt die Methode eine Liste mit den Benachrichtigungen zurück, die nicht als bearbeitet oder unbearbeitet markiert werden konnten.

Erforderliche Parameter:

  • id: ID des Objekts

  • eventDate: Datum der Benachrichtigung

  • senderId: Der Auslöser der Wiedervorlage (optional)

Optionale Parameter:

  • reset: Benachrichtigung als unbearbeitet markieren

POST Beispiel

[ { "id": 4999, "eventDate": 1459760812000, "senderId": 8991 }, ... ]

/osrest/api/notifications/subscriptions/remove/{id}/{eventDate}

  • Unterstützte Anfragemethoden: GET

Diese Methode löscht die Benachrichtigung eines Abonnements. Dazu sind sowohl die Objekt-ID {id} als auch das Datum {eventDate} (beides Felder einer Benachrichtigung) anzugeben. Die Funktion gibt bei Erfolg den Wert 0 zurück.

Erforderliche Parameter:

  • id: ID des Objekts, für welches die Benachrichtigung entfernt werden soll.

  • eventDate: Datum der Benachrichtigung

Optionale Parameter:

  • senderId: Der Auslöser der Wiedervorlage. Ist dieser nicht angegeben oder 0, so werden alle Benachrichtigungen des Benutzers von dem Objekt gelöscht.

/osrest/api/notifications/subscriptions/remove

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Diese Methode löscht mehrere Benachrichtigungen zu Abonnements. Dazu sind jeweils sowohl die Objekt-ID {id} als auch das Datum {eventDate} anzugeben.
Sollte ein Fehler beim Löschen eintreten, gibt die Methode eine Liste mit den Benachrichtigungen zurück, die nicht gelöscht werden konnten.

Erforderliche Parameter:

  • id: ID des Objekts, für welches die Benachrichtigung entfernt werden soll.

  • eventDate: Datum der Benachrichtigung

  • senderId: Der Auslöser der Wiedervorlage. Ist dieser nicht angegeben oder 0, so werden alle Benachrichtigungen des Benutzers von dem Objekt gelöscht.

POST Beispiel

[ { "id": 4999, "eventDate": 1459760812000, "senderId": 8991 }, ... ]

/osrest/api/notifications/subscriptions/markread/{id}/{eventDate}

  • Unterstützte Anfragemethoden: GET

Die Methode setzt für eine Benachrichtigung eines Abonnements den Status Gelesen oder Ungelesen. Dazu sind sowohl die Objekt-ID {id} als auch das Datum {eventDate} (beides Felder einer Benachrichtigung) anzugeben. Wenn {reset} als Parameter gesetzt ist, wird die Benachrichtigung als ungelesen markiert. 

Die Funktion gibt bei Erfolg den Wert 0 zurück.

Erforderliche Parameter:

  • id: ID des Objekts

  • eventDate: Datum der Benachrichtigung

Optionale Parameter:

  • reset: Benachrichtigung als ungelesen markieren

/osrest/api/notifications/subscriptions/markread

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Die Methode setzt für Benachrichtigungen von Abonnements den Status Gelesen oder Ungelesen. Dazu sind jeweils sowohl die Objekt-ID {id} als auch das Datum {eventDate} (beides Felder einer Benachrichtigung) anzugeben. Wenn {reset} als Parameter gesetzt ist, wird die Benachrichtigung als ungelesen markiert. Sollte ein Fehler beim "Gelesen markieren" eintreten, gibt die Methode eine Liste mit den Benachrichtigungen zurück, die nicht als gelesen oder ungelesen markiert werden konnten.

Erforderliche Parameter:

  • id: ID des Objekts

  • eventDate: Datum der Benachrichtigung

  • senderId: Der Auslöser der Wiedervorlage (optional)

Optionale Parameter:

  • reset: Benachrichtigung als ungelesen markieren

POST Beispiel

[ { "id": 4999, "eventDate": 1459760812000, "senderId": 8991 }, ... ]

/osrest/api/notifications/subscriptions/process/{id}/{eventDate}

  • Unterstützte Anfragemethoden: GET

Die Methode setzt für eine Benachrichtigung von einem Abonnement den Status Bearbeitet. Dazu sind sowohl die Objekt-ID {id} als auch das Datum {eventDate} (beides Felder einer Benachrichtigung) anzugeben. Die Funktion gibt bei Erfolg den Wert 0 zurück.

Erforderliche Parameter:

  • id: ID des Objekts

  • eventDate: Datum der Benachrichtigung

  • password: Base64-Kodiertes Passwort für den eigenen Account, falls das Abonnement eine Passwortvalidierung verlangt. Verlangt es dies und wird kein Passwort übermittelt, so schlägt die Aktion fehl.

  • confirmed: true|false. Verlangt das Abonnement eine Bestätigung, so muss hier true übergeben werden. Wird in einem solchen Falle false übergeben, so schlägt die Aktion fehl.

/osrest/api/notifications/subscriptions/process

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Die Methode setzt für Benachrichtigungen von Wiedervorlagen den Status Bearbeitet oder Unbearbeitet. Dazu sind jeweils sowohl die Objekt-ID {id} als auch das Datum {eventDate} (beides Felder einer Benachrichtigung) anzugeben. Sollte ein Fehler beim "Bearbeitet markieren" eintreten, gibt die Methode eine Liste mit den Benachrichtigungen zurück, die nicht als bearbeitet oder unbearbeitet markiert werden konnten.

Erforderliche Parameter:

  • id: ID des Objekts

  • eventDate: Datum der Benachrichtigung

  • senderId: Der Auslöser der Wiedervorlage (optional)

POST Beispiel

[ { "id": 4999, "eventDate": 1459760812000, "senderId": 8991 }, ... ]

/osrest/api/notifications/subscriptionQueries

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die Methode gibt alle abonnierten Anfragen des Benutzers zurück. Für eine Erläuterung der Konstanten von "confirm", "notifyType", "actions" siehe unten.

Ergebnis

[ { infoText: "Für Admin Gruppe", confirm: "NO_CONFIRMATION", aboGroup: "1263CA058C1841A5B5BD0F07C77BA901", notifyType: "INTERNAL", actions: [ "INDEXDATA_MODIFIED" ] } ... ]

/osrest/api/notifications/subscriptionObjects

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Optionale Parameter:

  • includeGroupSubscriptions (boolean): Es werden auch die abonnierten Objekte ausgegeben, die für Gruppen angelegt wurden in denen der Benutzer mitglied ist.

  • verbose (boolean): liefert zu jedem abonnierten Objekt zusätzliche Informationen zum zugehörigen ECM Objekt

Die Methode liefert eine Liste aller abonnierten Objekte des Benutzers.
Actions kann hierbei folgende Werte annehmen:

Schlüssel

Beschreibung

Schlüssel

Beschreibung

INDEXDATA_MODIFIED

Die Indexdaten wurden geändert.

DOCUMENT_MODIFIED

Ein Dokument wurde dem Objekt hinzugefügt oder es wurde geändert.

OBJECT_CREATED

Ein Objekt wurde in dem Ordner/Register hinzugefügt.

OBJECT_DELETED

Ein Objekt wurde aus dem Ordner/Register entfernt.

OBJECT_ADDED

Ein Objekt wurde aus einem anderen Schrank dem Ordner/Register hinzugefügt.

OBJECT_MOVED_FROM_TRAY

Ein Objekt aus der Benutzerablage wurde dem Ordner/Register hinzugefügt.

LOCATION_ADDED

Ein Objekt in dem Ordner/Register wurde an einen anderen Ort kopiert.

Confirm kann folgende Werte annehmen:

Schlüssel

Beschreibung

Schlüssel

Beschreibung

NO_CONFIRMATION

Keine Bestätigung erforderlich.

CONFIRMATION

Eine Bestätigung ist vor dem Löschen der Benachrichtigung notwendig.

CONFIRMATION_PASSWORD

Eine Bestätigung inkl. Profil-Passworteingabe ist vor dem Löschen der Benachrichtigung notwendig.

CONFIRMED

Eine Bestätigung ist erfolgt.

NotifyType kann folgende Werte annehmen:

Schlüssel

Beschreibung

Schlüssel

Beschreibung

INTERNAL

Die Benachrichtigung erfolgt über enaio® client.

EMAIL

Die Benachrichtigung erfolgt via E-Mail.

Ergebnis

[ { "objectId": 1235,   "infoText": "Freier Text bei Erstellung des Abonnements", "confirm": "NO_CONFIRMATION", "aboGroup": "7cf2ebaf2f7a451f8014a35d397996fe", "notifyType": "INTERNAL", "actions": [ "OBJECT_DELETED" ], "groupsToBeNotified": [ { "id": 8522, "name": "PERSONAL" }   ], "usersToBeNotified": [ { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" } ] }, ... ]

/osrest/api/notifications/subscriptionObjects/{id}

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die Methode liefert eine Liste aller für den Benutzer eingerichteten Benachrichtigungen zu einem Objekt. Für eine Erläuterung der Konstanten von "confirm", "notifyType", "actions" siehe oben.

Ergebnis

[ { "objectId": 1235,   "infoText": "Freier Text bei Erstellung des Abonnements", "confirm": "NO_CONFIRMATION", "aboGroup": "7cf2ebaf2f7a451f8014a35d397996fe", "notifyType": "EMAIL", "actions": [ "OBJECT_DELETED" ], "groupsToBeNotified": [ { "id": 8522, "name": "PERSONAL" } ], "usersToBeNotified": [ { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" } ] }, ... ]

/osrest/api/notifications/subscriptionObjects

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Über diese Methode kann ein Abonnement zu dem mit ID definierten Objekt hinzugefügt oder geändert werden. Das hinzuzufügende bzw. zu ändernde Abonnement muss als POST im JSON-Format so reingereicht werden, wie es über die gleichnamige GET-Methode erhalten wurde. Soll ein neues Abonnement erstellt werden, so muss die aboGroup leer gelassen werden. Im Änderungsfall muss dort die aboGroup des betreffenden Abonnements mitgesendet werden. Als Rückgabewert gibt die Methode im Erfolgsfall 0 zurück, ansonsten einen Fehler. Für eine Erläuterung der Konstanten von "confirm", "notifyType", "actions" siehe oben.

Beispiel POST-Body-JSON

{ "objectId": 1235,  "infoText": "", "confirm": "NO_CONFIRMATION", "aboGroup": "7cf2ebaf2f7a451f8014a35d397996fe", "notifyType": "EMAIL", "actions": [ "OBJECT_DELETED" ], "mailAddresses": [ "demo_deleted222@demo.optimal-systems.de" ], "groupsToBeNotified": [ { "id": 8522, "name": "PERSONAL" }, ... ], "usersToBeNotified": [ { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, ... ] }

/osrest/api/notifications/aboGroup/{id}

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Pflichtparameter:

  • id (String): AboGrp ID eines abonnierten Objektes oder einer abonnierten Anfrage

Diese Methode liefert spezifische Informationen zu einem abonnierten Objekt oder einer abonnierten Anfrage zurück mit der gegebenen AboGrp ID.

/osrest/api/notifications/subscriptionMultiObjects

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Über diese Methode können mehrere Abonnements zu Objekten hinzugefügt oder geändert werden. Die hinzuzufügenden bzw. zu ändernden Abonnements müssen als POST im JSON-Format so reingereicht werden, wie sie über die gleichnamige GET-Methode erhalten wurden. Da diese Methode mehrere Abonnements gleichzeitig ändern kann, ist die oberste JSON-Ebene ein Array der JSON-Abonnement-Objekte. Neue Abonnements zeichnen sich durch eine leere aboGroup aus, bei zu ändernden Abonnements ist die aboGroup ausgefüllt. In einem POST-JSON-Array können sowohl neue als auch zu ändernde Abonnements angegeben werden. Rückgabewert der Methode ist ein Array aller fehlgeschlagenen Objekte. Für eine Erläuterung der Konstanten von "confirm", "notifyType", "actions", siehe oben.

Beispiel POST-Body-JSON

[ { "objectId": 1235,   "infoText": "", "confirm": "NO_CONFIRMATION", "aboGroup": "7cf2ebaf2f7a451f8014a35d397996fe", "notifyType": "EMAIL", "actions": [ "OBJECT_DELETED" ], "mailAddresses": [ "demo_deleted222@demo.optimal-systems.de" ], "groupsToBeNotified": [ { "id": 8522, "name": "PERSONAL" }, ... ], "usersToBeNotified": [ { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, ... ] }, ... ]

/osrest/api/notifications/subscriptionObjects/delete/{id}

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Über diese Methode kann ein Abonnement gelöscht werden. Als ID muss die aboGroup des Abonnements reingereicht werden.
Im Erfolgsfall gibt die Methode 0 zurück, ansonsten einen Fehler.

/osrest/api/notifications/subscriptionObjects/delete

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Über diese Methode können mehrere Abonnements zu Objekten gelöscht werden. Das JSON im POST-Body ist ein String-Array mit den aboGroup-Elementen, die gelöscht werden sollen. Die Methode gibt alle aboGroup-Elemente zurück, deren zugehöriges Abonnement nicht gelöscht werden konnte.

Beispiel POST-Body-JSON

[ { "aboGroup": "7cf2ebaf2f7a451f8014a35d397996fd" }, ... ]

/osrest/api/notifications/revisitObjects

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die Methode liefert eine Liste aller Wiedervorlagen des Benutzers.

Ergebnis

[ {     "osid": 14008672,     "duedate": 1433847600000,     "subject": "",     "creationdate": 1433847417000, "notified": false, "confirm": false, "notifiedbymail": false, "sender": { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, "recipients": [ { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, ... ] }, ... ]

/osrest/api/notifications/revisitObjects/{id}

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die Methode liefert eine Liste aller für den Benutzer eingerichteten Wiedervorlagen zu einem Objekt.

Ergebnis

[ { "osid": 14008672, "duedate": 1433847600000, "subject": "", "creationdate": 1433847417000, "notified": false, "confirm": false, "notifiedbymail": false, "sender": { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, "recipients": [ { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, ... ] }, ... ]

/osrest/api/notifications/revisitObjects

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Über diese Methode kann eine Wiedervorlage hinzugefügt oder geändert werden. Die hinzuzufügende bzw. zu ändernde Wiedervorlage muss als POST im JSON-Format so reingereicht werden, wie es über die gleichnamige GET-Methode erhalten wurde.
Die Empfänger-Struktur im JSON muss dupliziert werden und als newRecipients hinzugefügt werden. Nur die Benutzer, die in newRecipients aufgelistet sind, werden in die neue oder geänderte Wiedervorlage aufgenommen.Soll eine neue Wiedervorlage erstellt werden, so darf kein creationdate mitgeliefert werden. Im Änderungsfall hingegen muss das creationDate der zu ändernden Wiedervorlage angegeben werden. Bei Erfolg gibt die Methode 0 zurück, ansonsten einen Fehler.

Beispiel POST-Body-JSON

{ "osid": 14008672, "duedate": 1433847600000, "subject": "", "creationdate": 1433847417000, "notified": false, "confirm": false, "notifiedbymail": false, "notificationmail": "E-Mailadress if notifiedbymail is true", "sender": { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, "recipients": [ { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, ... ], "newRecipients": [ { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, ... ] }

osrest/api/notifications/revisitMultiObjects

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Über diese Methode können mehrere Wiedervorlagen zu Objekten hinzugefügt oder geändert werden. Die hinzuzufügenden bzw. zu ändernden Wiedervorlagen müssen als POST im JSON-Format so reingereicht werden, wie sie über die gleichnamige GET-Methode erhalten wurden. Da diese Methode mehrere Wiedervorlagen gleichzeitig ändern kann, ist die oberste JSON-Ebene ein Array der JSON-Wiedervorlagen-Objekte. Neue Wiedervorlagen zeichnen sich durch einen fehlenden creationDate aus, bei zu ändernden Wiedervorlagen ist das creationDate angegeben. In einem POST-JSON-Array können sowohl neue als auch zu ändernde Wiedervorlagen angegeben werden. Rückgabewert der Methode ist ein Array aller fehlgeschlagenen Objekte.

Beispiel POST-Body-JSON

[ { "osid": 14008672, "duedate": 1433847600000, "subject": "", "creationdate": 1433847417000, "notified": false, "confirm": false, "notifiedbymail": false, "notificationmail": "E-Mailadress if notifiedbymail is true", "sender": { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, "recipients": [ { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, ... ], "newRecipients": [ { "id": 77, "name": "DEMO", "fullname": "Klaus Mustermann" }, ... ] }, ... ]

/osrest/api/notifications/revisitObjects/delete/{id}?userId=X&dueDate=Y

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Über diese Methode kann eine Wiedervorlage gelöscht werden. Als ID muss die osid des Abonnements, die userId des Benutzers sowie der duedate-Zeitstempel reingereicht werden.
Im Erfolgsfall gibt die Methode 0 zurück, ansonsten einen Fehler.

Verpflichtende Parameter sind:

  • userId (int): Definiert den Benutzer (recipient), dessen Wiedervorlage entfernt werden soll.

  • dueDate(long - Java Timestamp): dueDate-Wert der Wiedervorlage

/osrest/api/notifications/revisitObjects/delete

  • Unterstützte Anfragemethoden: POST

  • Unterstützte Ergebnisformate: JSON

Über diese Methode können mehrere Wiedervorlagen gelöscht werden. Der POST-Body ist hierbei auf oberster Ebene ein JSON-Array, das die zu löschenden Wiedervorlagen beinhaltet. Die jeweilige userId ist die ID des Benutzers, für den die Wiedervorlage eingerichtet ist.

Beispiel POST-Body-JSON

[ { "osid": 14008672, "duedate": 1433847600000, "userId": 12345 }, ... ]

/osrest/api/notifications/workflows

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Die Methode liefert eine Liste aller Benachrichtigungen zu Workflowereignissen.

Optionale Parameter sind:

  • starttime (int - Unix Timestamp): Zeitpunkt, ab dem Benachrichtigungen angezeigt werden sollen (Standard: keine Beschränkung).

  • clienttype (String): Angeben, für welchen Client-Typ Workflow-Benachrichtigungen erhalten werden ("web", "mobile", "desktop" bzw. mit bestimmter Sprache z. B. "web_de", "web_en", "web_fr").

  • verbose (boolean): Es werden ausführlichere Daten zu den Workflows zurückgegeben.

Um diese Funktion zu nutzen, muss die Nutzung des Workflows über die Konfiguration aktiviert werden.

/osrest/api/notifications/count

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

  • Ab enaio 8.50

Die Methode liefert die Anzahl von ungelesenen Wiedervorlagen, Abonnements und Workflows zurück. Über Query-Parameter kann spezifiziert werden, welche Werte ermittelt werden sollen.

Optionale Parameter:

  • countSubscriptions (boolean): liefere die Anzahl ungelesener Abonnements zurück

  • countRevisits (boolean): liefere die Anzahl ungelesener Wiedervorlagen zurück

  • countWorkflows (boolean): liefere die Anzahl ungelesener Workflows zurück

Beispiel Ergebnis

{ revisits: 3, subscriptions: 1, workflows: 1 }

 

 

Inhalt:

Related content