/osrest/api/session

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

Die Methode liefert Informationen zur enaio^®-Benutzersession zurück.

{
	"userid": 2,
	"username": "ROOT",
	"osGuid": "BF894230A0324FB887CDD732FCDDD61D",
	"wfGuid": "E68A04C8054C4BEA9990995A4D629C7F",
	"wfOrg": "0947CC57A9C24B3E8D1DC27BAE777CBE",
	"isWorkflowAbsent": false,
	"sessionGuid": "_550A62C49B8E9B3A6FB562DF914800F0A27FFB5D7766405CE0B6DF96FBC1927FCC0468",
	"language": "de",
	"languageObjDef": "de",
	"autostar": "2",
	"fullname": "Optimus Prime",
	"email": "transformer@transformers.transform",
	"profile": -1,
	"groups": [
		"TECHUSERS"
	]
}

/osrest/api/session/logout

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: HTTP 204 / No Content

Mit dieser Methode ist ein Beenden (Logout) der aktuellen Benutzersession möglich.

Dieser Endpunkt ist deprecated. Bitte am enaio Gateway /_secure/logout/ aufrufen!

/osrest/api/session/checkPassword

Unterstützte Anfragemethoden: GET
Unterstützte Ergebnisformate: HTTP 204 / No Content

Pflicht Parameter sind:

password (String): Das Passwort des Benutzers kodiert in Base64 mit Zeichenkodierung ISO-8859-1.

Mit dieser Methode kann das Passwort des Benutzers überprüft werden.

Das Passwort wird nur als Base64-Kodiert übermittelt. Base64-Kodierung ist keine richtige Verschlüsselung. Wir empfehlen zwingend den Einsatz von Transport Layer Security (TLS).

/osrest/api/session/changePassword

Unterstützte Anfragemethoden: POST
Unterstützte Ergebnisformate: HTTP 204 / No Content

Mit dieser Methode kann das eigene Passwort geändert werden. Die beiden Passwortzeichenketten müssen Base64-Kodiert mit Zeichenkodierung ISO-8859-1 sein.

Folgender JSON muss im POST-Body mitgesendet werden:

{
	"oldPassword": "Altes Passwort als Base64-Kodiert mit Zeichenkodierung ISO-8859-1",
	"newPassword": "Neues Passwort als Base64-Kodiert mit Zeichenkodierung ISO-8859-1"
}

Das Passwort wird nur als Base64-Kodiert übermittelt. Base64-Kodierung ist keine richtige Verschlüsselung. Wir empfehlen zwingend den Einsatz von Transport Layer Security (TLS).

/osrest/api/session/checklicense/[lizenzmodul]

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

Mit dieser Methode lässt sich das Vorhandensein von enaio^®-Lizenzmodulen auf dem Server überprüfen. Die Methode liefert einen einfachen JSON-String mit den Werten true oder false zurück. Im Zweifel muss das jeweilige Lizenzmodul der OSRest-Station zugeordnet sein.

/osrest/api/session/runscript

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

Mit dieser Methode lässt sich ein VB-Script auf dem Server ausführen.

In einem POST-Request werden hier Parameter und der Name einer Skriptdatei im Unterverzeichnis scripts der Konfiguration übergeben. Wenn lediglich die Parameter in einem serverseitigen Event ausgewertet werden sollen, kann der Parameter script auch weggelassen werden.

{
	"parameters": {
		"Aktennummer": "4711",
		"GetLastVersion": true
	},
	"script": "beispiel.vbs"
}

Der Aufruf gibt die individuellen Rückgabeparameter des Jobs zurück:

{
Aktennummer: "4711",
MaxVersion: 4,
DocumentCount: 6
}

/osrest/api/session/systemroles

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

Die Methode liefert eine Liste der Systemrollen des aktuellen Benutzers zurück. Systemrollen werden im AppConnector für 10 Minuten im Cache gehalten. Werden diese im enaio^® Administrator für einen Benutzer geändert, so treten diese erst nach Ablauf der Cachingzeit in Effekt oder der AppConnector muss nach der Änderung neugestartet werden.

Beispielergebnis

[
	"R_CLNT_STORE_SETTINGS",
	"R_WFADM_START",
	"R_WFEDIT_START",
	"R_WFEDIT_ORG_EDIT",
	"R_WFEDIT_MODEL_EDIT",
	"R_SRV_ADMIN",
	"R_CLNT_OBJHIST",
	"R_CLNT_EXPMOD",
	"R_CLNT_EXPORT",
	"R_CLNT_NOTES",
	...
]

/osrest/api/session/userdesktops

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

Die Methode liefert den privaten und öffentlichen Desktop als Baum.

Optionale Parameter sind:

refresh (Boolean): Ist der Parameter gesetzt und 'true', wird der Cache ignoriert und die Anfragen neu vom Server abgefragt.

/osrest/api/session/userdesktops/add

Unterstützte Anfragemethoden: POST
Unterstütztes Anfrageformat: JSON

Mit dieser Methode lassen sich Ordner und Verweise auf DMS-Objekte dem privaten Desktop des aktuellen Benutzers hinzufügen. Ist keine "parentId" gegeben wird das hinzuzufügende Objekt auf oberster Ebene dem privaten Desktop hinzugefügt.

Die "objectTypeId" für DMS Objekte ist optional. Aus Performanzgründen ist es allerdings empfehlenswert sie anzugeben. Nach dem Hinzufügen wird das hinzugefügte Objekt zurück geliefert.

Ordner hinzufügen

{
	"name": "Kundenordner",
	"folderId" : "26279936",
	"type" : "FOLDER"
}

DMS Objekt hinzufügen

{
	"name": "Vertragsakte 12",
	"id": "4570",
	"objectType" : "131082",
	"folderId": "26279936",
	"type" : "OBJECT"
}

/osrest/api/session/userdesktops/remove

Unterstützte Anfragemethoden: POST
Unterstütztes Anfrageformat: JSON

Mit dieser Methode lassen sich Ordner, Suchanfragen und Verweise auf DMS-Objekte aus dem privaten Desktop des aktuellen Benutzers entfernen.

Ordner entfernen

{
	"id" : "26279941",
	"folderId" : "26279936",
	"type" : "FOLDER"
}

Gespeicherte Suchanfrage entfernen

{
	"id" : "5632986",
	"type" : "QUERY"
}

Verweis auf DMS-Objekt entfernen

{
	"name" : "1",
	"type" : "OBJECT"
}

Der AppConnector löscht keine Resourcenzeichenketten, welche mit enaio 10.10 für Profilbenutzer eingeführt wurden. Diese müssen Sie manuell löschen, falls Sie sie zuvor angelegt haben.

/osrest/api/session/userdesktops/save

Unterstützte Anfragemethoden: POST
Unterstütztes Anfrageformat: JSON

Diese Methode speichert die übergebenen Daten als gesamten privaten Desktop. Der bisherige Desktop wird dabei überschrieben. Die Struktur des JSON sollte der "userdesktops/get"-Struktur entsprechen. So können Änderungen wie das Anlegen, Umbenennen, Verschieben und Löschen von Desktopeinträgen gespeichert werden. Das Erstellen von Suchanfragen sollte weiterhin über den zugehörigen (storedqueries/add) - Aufruf erfolgen.

/osrest/api/session/settings/load

Unterstützte Anfragemethoden: GET
Unterstütztes Anfrageformat: JSON

Mit dieser Methode lässt sich die AS.INI-Konfiguration im JSON-Format abrufen.

/osrest/api/session/settings/save

Unterstützte Anfragemethoden: POST
Unterstütztes Anfrageformat: JSON

Mit dieser Methode lässt sich die AS.INI-Konfiguration im JSON-Format speichern. Die Methode erwartet eine JSON-Zeichenkette, wie sie über die Load-Methode hier drüber abgerufen werden kann.
Die JSON-Zeichenkette wird im Anschluss in das INI-Format konvertiert und dann im Server als Ganzes gespeichert.

Sie speichern über diese Methode die komplette AS.INI. Dies betrifft viele Softwarekomponenten von enaio. Seien Sie dementsprechend vorsichtig. Der JSON wird 1:1 in das INI-Format überführt und dann im Server gespeichert.

/osrest/api/session/settings/custom/load

Unterstützte Anfragemethoden: GET
Unterstütztes Anfrageformat: JSON
Ab: enaio 9.00

Mit dieser Methode lassen sich eigene gespeicherte Konfigurationen aus der Datenbank auslesen. Der angeforderte Wert wird Base64 enkodiert zurückgeliefert.

Parameter sind:

type (int): Der Datentyp des Konfigurationswertes gemäß Server
name (String): Der Name unter welchem der Konfigurationswert auf dem Server abgelegt ist.

/osrest/api/session/settings/custom/save

Unterstützte Anfragemethoden: POST
Unterstütztes Anfrageformat: JSON
Ab: enaio 9.00

Mit dieser Methode lassen sich eigene Konfigurationen in der Datenbank des enaio Server speichern um sie für später zu persistieren.