Strukturen

Hier werden die Strukturen der Ausgabe des REST-API beschrieben.

Bei jeder Ausgabe wird der allgemeine Header WebAdminInfo, der die Version des WebAdmin und des REST-API, den angemeldeten WebAdmin Benutzer und den Zeitstempel des Aufrufs enthält, mit ausgegeben:

• WebAdminVersion
• usedApiVersion: Die beim Request spezifizierte API Version
• apiVersion
• user
• time

Nach Anforderung einer Liste der in WebAdmin konfigurierten UTM-Anwendungen wird zusätzlich zum Header WebAdminInfo die Struktur applications, die ein Array mit Informationen zu den konfigurierten UTM Anwendungen enthält, ausgegeben:
Jedes Array-Element enthält die eindeutige ID, den Rechnernamen, den Anwendungsnamen, den Typ des Betriebssystems und die Verfügbarkeit der Anwendung beim letzten Kontaktversuch:

• id
• serverName
• appliName
• osType: Unix / BS2000 / Windows
• availability: yes / no / unknown 

Nach Anforderung von Daten einer bestimmten UTM Anwendung wird zusätzlich zum Header WebAdminInfo die Struktur applicationInfo, die Informationen zur ausgewählten UTM-Anwendung ausgibt sowie die Struktur applicationData, die die gewünschten Daten enthält, mit ausgegeben:

Struktur applicationInfo:

• id
• serverName
• platform
• appliName
• UTMVersion

Beispiel zur Ausgabe der Anwendungsdaten zu struct = KC_CURR_PAR:

• KC_CURR_PAR
  • Array mit einem Element:
    • appliname
      • unit: ""
      • datatype: "string"
      • value: "APPLNAME"

usw.

Beispiel zur Ausgabe der Daten zu struct = KC_BCAMAPPL:

• KC_BCAMAPPL
  • Array mit ggf. mehreren Elementen. Erstes Element:
    • bc_name
      • unit: ""
      • datatype: "name"
      • value: "BCNAME00"
    • usw.

• • Eventuell weiteres Element:
    • bc_name
      • unit: ""
      • datatype: "name"
      • value: "BCNAME01"

usw.

Mögliche Werte von datatype und deren Bedeutung:

Wert	Bedeutung
boolean	true / false / null
enum	Es gibt nur definierte Werte
integer	Ganze Zahl
name	Name eines UTM Objekts
string	Folge von Zeichen

Mögliche Werte von unit und deren Bedeutung:

Wert	Bedeutung
	Keine Einheit
%	Prozent
days	Tage
microsec	Mikrosekunden
msec	Millisekunden
per mille	Promille
sec	Sekunden