/osrest/api/serviceinfo

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Die Methode liefert Informationen über API-Version und Buildrevision des OSREST-Service. Diese Informationen werden im Supportfall abgefragt. Auch werden über diesen Service die mobilen Fähigkeiten der Installation angezeigt.

{
    apiVersion: "1.1.0"
    buildRevision: "5168"
}

/osrest/api/serviceinfo/counter/{guid}

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: Integer

Die Methode liefert den Integerwert des Counters zurück, welcher die angegebene GUID besitzt. Es wird ein neuer Counter angelegt, wenn keiner mit der angegebenen GUID existiert. Über den Resetparameter wird ein bestehender Counter zurückgesetzt, sofern dieser vom Type 0 ist. Bei jedem Aufruf, sofern der Counter bereits existierte und mit dem Aufruf nicht zurückgesetzt wird, wird der Counter um eins erhöht.

Optionale Parameter sind:

type (Integer): Art des Counter (0 = Manueller zurückzusetzender Counter, 1 = Counter wird täglich zurückgesetzt, 2 = Counter wird monatlich zurückgesetzt, 3 = Counter wird jährlich zurückgesetzt)
reset (Boolean): Bei einem Type 0 Counter wird dieser auf den Initialwert zurückgesetzt
initial (Integer): Der Initialwert des Counters wenn dieser Angelegt oder Zurückgesetzt wird.

/osrest/api/serviceinfo/ping

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Die Methode liefert die Zeit auf dem OSREST-Server als Timestamp zurück. Die Funktion dient in erster Linie dazu, die Erreichbarkeit des Service sowie die Authentifizierung zu testen.

/osrest/api/serviceinfo/mimetypes

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON
Ab enaio 9.10

Die Methode liefert eine Liste von Mimetypes, die mit spezifischen Infos wie z.B. Icon-IDs angereichert ist.

/osrest/api/serviceinfo/errorTypes/

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert alle Fehlerarten zurück, die die API kennt.

/osrest/api/serviceinfo/errorTypes/{errorCode}

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: JSON

Diese Methode liefert einen einzelnen Fehlertypen zurück.

Beispiel einer Fehlermeldung

{
  "ErrorType": "UNSPECIFIC_ERROR",
  "HttpStatusCode": "Internal Server Error - [500]",
  "DefaultMessage": "It seems to be an internal failure occurred - this should not had happened! :(",
  "ErrorCode": 0
}

/osrest/api/serviceinfo/registry

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: JSON

Diese Methode liefert Werte aus der Serverregistry zurück. Es sind jedoch nur die nachfolgend im Beispiel aufgezählten Schlüssel aktuell erlaubt. Möchten Sie andere abfragen, so wenden Sie sich bitte an unser Produktmanagement. Der Rückgabewert ist identisch zum Anfrage-JSON. In den einzelnen Objekten befindet sich dann neben dem Key auch ein Value. Nicht erlaubte Schlüssel sind im Antwort-JSOn nicht enthalten.

Beispiel für Parameter

[{
	"key": "Login\\PwdComplexityDescription"
},{
	"key": "Login\\PwdComplexity"
},{
	"key": "AdminMail"
},{
	"key": "Services\\Gateway\\API"
},{
	"key": "Services\\Gateway\\API_DIRECT"
}]

/osrest/api/serviceinfo/etc

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: application/octet-stream
Ab: enaio 9.00

Über diesen Job können Dateien aus dem ETC-Verzeichnis des enaio Server runtergeladen werden. Aktuell ist dieser Job auf folgende Dateien beschränkt (Whitelist):

SuggestionScripts.zip

Beispiel für Parameter

{
	"path": "%ETCPATH%\\SuggestionScripts.zip"
}

/osrest/api/serviceinfo/systemConfigValue

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: JSON
Ab: enaio 9.10 Final (1.5.96)

Über diesen Job können Daten aus der as.cfg des ETC-Verzeichnis des enaio Server ausgelesen werden.

Beispiel einer Übergabe

{
	path: "%ETCPATH%\\as.cfg",
    section: "System",
    value: "SHOWBASISPARAMETER"
}

Beispiel einer Rückgabe

{
	SHOWBASISPARAMETER: 1
}

Inhalt:

1 /osrest/api/serviceinfo
2 /osrest/api/serviceinfo/counter/{guid}
3 /osrest/api/serviceinfo/ping
4 /osrest/api/serviceinfo/mimetypes
5 /osrest/api/serviceinfo/errorTypes/
6 /osrest/api/serviceinfo/errorTypes/{errorCode}
7 /osrest/api/serviceinfo/registry
8 /osrest/api/serviceinfo/etc
9 /osrest/api/serviceinfo/systemConfigValue

enaio® appconnector

ServiceInfoService (/serviceinfo)