/
Organization Service (/organization)

Organization Service (/organization)

/osrest/api/organization/users

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Diese Methode liefert eine Liste aller ECM-Benutzer zurück.

Optionale Parameter sind:

  • refresh (boolean): Die Benutzer werden neu vom Server abgerufen und nicht aus dem Cache zurückgegeben. (Ab 1.5.91)

Globaler Schalter

  • Es existiert ab Version 194 ein globaler Schalter für die osrest.properties datei: limit.user.data=true
    Wenn dieser den Wert true besitzt liefert der AppConnector lediglich die Properties id, name, fullname, locked, limted, valid aus. Alle anderen, wie die Gruppen, werden ausgefiltert. Dies gilt jedoch nicht für Benutzer, die die Systemrolle ID=4 besitzen. Diese bekommen immer alle Properties zurück, da sie administrative Rechte besitzen.

Rückgabebeispiel

[ { "id": 2, "name": "ROOT", "fullname": "Optimus Prime", "description": "", "locked": "0", "limited": "0", "valid": true, "groups": [ "STANDARD" ], "email": "transformer@transformers.transform", "guid": "7763A6209BA9413DBFF2F7EF470E6198", "wfguid": "375E1A7ACBA34CC283EF280FC2FA229E" }, ... ]

/osrest/api/organization/groups

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Diese Methode liefert eine Liste aller ECM-Gruppen, in denen der aktuelle Benutzer Mitglied ist oder, wenn der Parameter all gesetzt ist, alle ECM-Gruppen des Systems zurück.

Optionale Parameter sind:

  • all (boolean): Es werden alle Gruppen des Systems ausgegeben (Standard: false).

  • loadUsers (boolean): Zu jeder Gruppe werden deren Mitglieder (Benutzer) ausgegeben.

/osrest/api/organization/sendmail

  • Unterstützte Anfragemethoden: POST 

  • Unterstützte Ergebnisformate: JSON

Über diese Methode kann eine E-Mail versendet werden. Als POST-Body muss ein Mail-JSON-Objekt übermittelt werden:

JSON Content

{ "receiver": "empfaenger@optimal-systems.de", "sender": "absender@optimal-systems.de", "subject": "Titel der E-Mail", "text": "Inhalt der E-Mail" }

/osrest/api/organization/avatar/{username}

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: Image/*.* 

Diese Methode liefert das Avatarbild des Benutzers mit dem angegebenen Benutzernamen zum Download zurück. Das Avatar wird hierbei in der Größe 80px ausgeliefert.

/osrest/api/organization/avatar/{username}/{size}

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: Image/*.* 

Diese Methode liefert das Avatarbild des Benutzers mit dem angegebenen Benutzernamen zum Download zurück. Das Avatar wird hierbei in der mit size gewünschten Größe ausgeliefert.

/osrest/api/organization/user/updateCreate

  • Unterstützte Anfragemethoden: POST 

  • Unterstützte Ergebnisformate: JSON

Über diese Methode kann ein ECM-Benutzer angelegt oder die Daten eines bestehenden ECM-Benutzers geändert werden:

JSON Content

{ "id": 0, "name": "BENUTZERNAME", "fullname": "Max Mustermann", "password": "passwort", "description": "Dieser Benutzer hat diese Freitext-Beschreibung", "locked": 0, "email": "max@mustermann.de" }

Für die Ausführung werden Supervisor-Rechte benötigt. Wird als ID eine 0 übergeben, so wird der Benutzer angelegt. Ist die ID > 0, so wird der betreffende Benutzer aktualisiert. Eine Aktualisierung des Benutzernamens ist nicht möglich.

/osrest/api/organization/user/delete/{id}

  • Unterstützte Anfragemethoden: GET 

Diese Methode löscht einen ECM-Benutzer unter Angabe seiner ID. Für die Ausführung werden Supervisor-Rechte benötigt. Supervisor-Benutzer können nicht gelöscht werden.

Optionale Parameter sind:

  • transferPortfolios (Boolean, default: false): Die Mappen des zu löschenden Benutzers können an einen anderen Benutzer übergeben werden.

  • transferNotifications (Boolean, default: false): Die Abonnements und Wiedervorlagen des zu löschenden Benutzers können an einen anderen Benutzer übergeben werden.

  • transferUserId(Integer, default: 0): Die Benutzer-ID des ECM-Benutzers, an den Mappen und/oder Abonnements und Wiedervorlagen übergeben werden sollen.

/osrest/api/organization/securitysystem

  • Unterstützte Anfragemethoden: GET

  • Unterstützte Ergebnisformate: JSON

Diese Methode liefert einen Dump der des Sicherheitssystems zurück. Für den Aufruf muss der User über die DMS Supervisor Systemrolle verfügen.

 

Inhalt: