Only one more week until Social Connections 11 is going to take place in Chicago. I am really happy to be selected as a speaker for this event! I will be speaking about the IBM Connections REST APIs and will show in many live examples how to use them, what to keep in mind an what to avoid. Furthermore I will give a brief introduction on what to expect with Connections Pink in terms of APIs. Looking forward to seeing you in Chicago!

Haben Sie schon einmal überlegt, Domino Daten über REST zu lesen und zu schreiben, wussten aber nicht, wie Sie das anstellen sollten? Sind die Überlegungen vielleicht in die Richtung gegangen, eine eigene Schnittstelle zu schreiben, vielleicht als OSGI Plugin?

Nun, es geht viel einfacher! Domino hat nämlich bereits alles an Bord, um auf Domino Daten per REST zuzugreifen! Die Domino Data Services und Domino Calendar Services erlauben den direkten Zugriff per REST auf Domino Daten.

Die Einrichtung ist ein mehrstufiger Prozess. Zunächst müssen die Data Services aktiviert werden. Dazu öffnet man das Internet Site Dokument, für welches man die Aktivierung vornehmen möchte.

DominoInternetSiteAuf dem Reiter „Configuration“ (englischer Client) müssen die Data Services eingestellt werden. Wenn Sie Daten zurückschreiben möchten, dann müssen die Methoden POST, PUT und PATCH aktiviert sein!

Anschließend muss jede Datenbank, die per REST zur Verfügung stehen soll, also solche markiert werden. Dazu müssen die Datenbank-Eigenschaften geöffnet werden und der letzte Reiter aktiviert.

DominoDBDataService

Sie können hier bestimmen, ob nur auf Daten in Ansichten zugegriffen werden soll oder ob auch ganze Dokumente gelesen und geschrieben werden können. Damit steht die Datenbank grundsätzlich für die REST API zur Verfügung, sie liefert aber noch keine Daten. Im letzten Schritt muss jeder Ansicht mitgeteilt werden, dass sie für die Data Services zur Verfügung stehen. Dazu öffnen Sie die Ansicht im DDE.

DominoViewDataService

Auf dem vorletzten Reiter muss das Häkchen gesetzt sein bei „Allow Domino Data Service operations“. Wenn alle Voraussetzungen erfüllt sind. Dann kann über verschiedene URIs (siehe Dokumentation) auf die Daten der Ansicht zugegriffen werden. Beispielsweise können alle Einträge einer Ansicht unter Berücksichtigung der vergebenen Zugriffsrechte mit folgender URI abgerufen werden:

Die Antwort vom Server sieht dann exemplarisch so aus:

Die URIs erlauben einige Parameter, um die Rückgabemenge einzugrenzen und zu steuern, was genau zurückgegeben werden soll. U.a. kann ein QueryString übergeben werden, um eine Volltextsuche durchzuführen.

Die Domino Data Services bietet somit ein tolle Möglichkeit auf Notes-Daten zuzugreifen. Diese Idee haben wir als hedersoft aufgegriffen und eine wesentlich flexiblere und dynamischere Schnittstelle geschaffen. Es muss zwar ein Osgi-Plug-In auf dem Domino Server installiert werden jedoch entfällt die globale Konfiguration des Servers bzw. von einzelnen Gestaltungselementen. Weiterhin können kann direkt Business-Logik implementiert werden.

Bei Interesse einfach melden, wie freuen uns über das spannende Thema REST mit Interessierten zu sprechen.