1.Verfügbare Endpunkte
Es ist möglich, auf diverse Objekte im HS/FS per HTTP zuzugreifen. Im Folgenden werden die Aufrufe zu den einzelnen Objekten näher beschrieben.
Für folgende Objekte stehen Endpunkte zur Verfügung:
Für folgende Objekte stehen Endpunkte zur Verfügung:
2.Aufruf
Der grundsätzliche Aufruf sieht folgendermaßen aus (Platzhalter in GROSSBUCHSTABEN):
https://HS_IP/endpoints/call?key=OBJECT-KEY&method=METHOD&PARAMETER=VALUE&user=USER&pw=PWD| Platzhalter | Erklärung |
|---|---|
| HS_IP | Die IP-Adresse des HS/FS. |
OBJECT-KEY | Der Objekt-Schlüssel setzt sich aus einem für die Art des jeweiligen Objekts festgelegten Präfix, gefolgt von einem '@'-Zeichen und der im Experte beim Objekt festgelegten ID zusammen. Beispiel für den Objekt-Schlüssel eines K-Objekts: CO@100_2_3. |
METHOD | Die hier angegebene Methode ist abhängig von der Art des angesprochenen Objekts. Eine Liste der für das jeweilige Objekte verfügbaren Methoden ist in der Hilfe des betreffenden Objekts angegeben. |
PARAMETER=VALUE | Optional, kann auch mehrfach vorkommen! Die Anzahl der Parameter variiert bei den Methoden (0 bis n). Diese werden jeweils durch ein '&'-Zeichen, gefolgt von der Parameter-Art, einem Gleichheits-Zeichen und dem Wert des Parameters in den Aufruf integriert. Ob, und falls ja, welche Parameter benötigt werden, hängt vom jeweils verwendeten Objekt und der verwendeten Methode ab. Beispiel: Um ein K-Objekt auf den Wert 7 zu setzen, muss als PARAMETER 'value' und als WERT '7' angegeben werden: &value=7. |
USER | Benutzername eines im HS/FS-Experte verwendeten Benutzers. Dieser Benutzer muss Zugriffsrechte zum Lesen und ggf. Schreiben auf das jeweilige Objekt besitzen. |
PWD | Passwort des zuvor angegebenen Benutzers im HS/FS-Experte. |
Eine Beschreibung der Methoden (und ggf. der von ihnen benötigten Parameter) sind bei den einzelnen Objekten angegeben.