Der stand-alone WebAdmin bietet ein REST-API an, um Daten von konfigurierten UTM-Anwendungen auszulesen, die über die Programmschnittstelle der Administration verfügbar sind.
Als REST-API Client kann ein Web Browser oder ein eigenes Python Programm, z.B. das ausgelieferte client_anonym.py genutzt werden, siehe Python Client.
Der REST-API Client muss sich durch Eingabe eines WebAdmin Benutzers und gültigem Passwort authentisieren. Dazu genügt ein Benutzer mit Leserecht.
Über das REST-API kann in einem ersten Schritt eine Liste der in WebAdmin konfigurierten UTM-Anwendungen mit den zugehörigen IDs und weiteren Informationen wie Rechnername, Betriebssystem und Verfügbarkeit abgerufen werden, siehe Strukturen WebAdminInfo und applications.
Mit Hilfe dieser persistenten IDs können aktuelle Daten zu einer oder allen Datenstrukturen einer bestimmten UTM-Anwendung gelesen werden, und zwar
- allgemeine Anwendungsparameter, z.B. Parametertyp
KC_CURR_PARoder - Objekteigenschaften aller Objekte eines Typs, z.B. für Objekttyp
KC_USERalle USER
Alle Feldnamen einer Datenstruktur der ADMI Schnittstelle werden durch das REST-API ausgegeben. Ausnahmen siehe Ausnahmen für veraltete Felder. Beispiele siehe Strukturen WebAdminInfo, applicationInfo und applicationData.
Beispiele zum Aufruf des REST-APIs:
- Abfrage einer Übersicht aller im WebAdmin definierten UTM-Anwendungen mit deren IDs:
http://localhost:8080/UtmWebAdmin/api/v1/appls/ - Abfrage aller Daten zur UTM-Anwendung mit ID 4711:
http://localhost:8080/UtmWebAdmin/api/v1/appls/4711 - Abfrage der Daten aller TACs der UTM-Anwendung mit ID 4711:
http://localhost:8080/UtmWebAdmin/api/v1/appls/4711?struct=KC_TAC
v1 steht dabei für die Schnittstellenversion 1.x.y (z.B. 1.0.1).
Die Ausgabe der Daten des REST-APIs erfolgt als JSON Datenstruktur und kann z.B. im Browser Mozilla Firefox komfortabel angezeigt werden. Dazu dient die Option, einzelne Teilstrukturen auf- und zuklappen zu können.
Zur formalen Beschreibung des REST-API siehe YAML Datei.