DMS service
Hier finden Sie Informationen zum DMS service.
Installationsvoraussetzungen
Eine Übersicht der Installationsvoraussetzungen finden Sie in der Entwicklerdokumentation.
Installation
Services werden über die Datei os_service-manager_setup.exe aus dem Verzeichnis \Win32\Disk1\Microservices\Service-Manager installiert. Aktualisierungen erfolgen über enaio_services_versionfix.exe aus dem Verzeichnis \Win32\Disk1\SP\Microservices.


Der DMS service für enaio® ist die neue REST-API (inklusive API-Projekt) für die Version 9.10 und bereits in enaio® coLab eingebunden. Die erste offizielle Version stellen wir Ihnen hiermit zur Verfügung. Weitere Feature-/Bugfix-Releases werden regelmäßig ausgeliefert.
Damit steht Ihnen neben enaio® appconnector (OSRest) unser neuer DMS service als Alternative zur Verfügung. Er kommt zwar aktuell noch mit deutlich kleinerem Umfang daher - dafür aber mit neuem Technologie-Stack: Skalierbarer, cloud-fähiger Microservice und für große Systeme gebaut. Langfristiges Ziel ist es, diese REST-API nach und nach wachsen zu lassen und vom Funktionsumfang an enaio® appconnector anzugleichen.
Die Version 3.0.0 des DMS services für enaio® stellt die erste offizielle Freigabe des neuen Microservices dar. Die REST-API setzt sich aus der Core-API sowie einem enaio-spezifischem Teil – Native-API – zusammen. Sie ist identisch zur 'yuuvis-core'-Codebase und ermöglicht es Ihnen, entwickelte Plugins für beide Produktlinien - enaio® und yuuvis® - einzusetzen. Den detaillierten Funktionsumfang und weitere Informationen entnehmen Sie bitte der Entwicklerdokumentation.
Einen ersten Teil an Funktionen haben wir aus enaio® appconnector (OSRest) übernommen. Die Roadmap für weitere Versionen ist in Arbeit. Für konkrete Wünsche von Ihrer Seite im Rahmen neuer Projekte oder eine aktuelle Vergleichsliste der beiden REST-APIs wenden Sie sich bitte direkt an pm@optimal-systems.de.

Objekthistorie: Neue Endpunkte
- GET dms/objects/{objectId}/history – liefert die Historie zu einem Dokument
- POST dms/objects/search – Abfrage nach system:history ist möglich
Folgende Endpunkte sind korrigiert worden. Die Rückgaben haben eine leicht geänderte Struktur.
-
POST dms/objects/search
-
POST dms/objects/search/native
-
GET dms/objects/{objectId}
-
POST dms/objects
Einige Systemfelder liefern jetzt einen integer Wert als Bit-Kombination statt der Beschreibung, beispielsweise 'system:OBJECT_FLAGS'. Hintergrund ist, dass nicht nur ein Wert, sondern mehrere Werte möglich sind.
Details dazu finden Sie in der Entwicklerdokumentation.
Setzen Sie den DMS service bereits ein, dann prüfen Sie bitte die Verarbeitung.

Variantenverwaltung: Neue Endpunkte
-
POST dms/objects/{objectId}/native/variants
-
PUT dms/objects/{objectId}/native/variants/{activateId}
-
GET dms/objects/{objectId}/native/variants
Objekte verschieben: Erweiterungen
-
PATCH api/dms/objects/{objectId}
-
Typenlose Dokumente der externen Ablage können typisiert werden.
Retention einstellen mit neuem Parameter 'OBJECT_RETENTION_PLANNED'
-
POST dms/objects
-
POST dms/properties/{objectId}
-
PATCH dms/properties/{objectId}
Neuer Abfrageparameter
-
GET dms/objects/{objectId}
-
Ein Abfrageparameter zum Abfragen der einfügbaren untergeordneten Objekttypen wurde hinzugefügt.
Schema gibt Kindobjekte zurück
-
GET dms/schema
-
Das Schema gibt standardmäßig die statischen einfügbaren untergeordneten Objekttypen zurück.
POST, PATCH api/dms/objects/{objectId}
-
Bisher wurde, anders als dokumentiert, als Eingabe ein einzelnes Objekt akzeptiert. Das ist nicht mehr der Fall. Notwendig ist, wie auch zuvor bereits dokumentiert war, die Eingabe als Array.
-
Als Resultat wird jetzt eine JSON mit einer Ergebnisliste, anstelle eines einzelnen DMS-Objekts, ausgegeben. Der DMS service liefert zukünftig standardmäßig immer Ergebnislisten. In der Dokumentation wird auf den Fakt hingewiesen.
Wenn Sie den DMS service bereits einsetzen, dann prüfen Sie bitte die Verarbeitung. Details dazu finden Sie in der Entwicklerdokumentation.

Parameteränderungen
-
Die Schreibweise eines Parameters - Groß- / Kleinschreibung - wurde geändert:
includeallowedchildobjecttypeids -> includeAllowedChildObjectTypeIds
Der Parameter rights wurde umbenannt: includePermissions
Einige optionale Parameter wurden hinzugefügt. Die Default-Einstellungen führen zu keiner Änderung der Rückgabe.
- POST /api/dms/objects
Der Multipart-Abschnitt 'data' benötigt jetzt zwingend den Content-Type 'application/json'.
- POST /api/dms/objects/<objectId>
- PATCH /api/dms/objects/<objectId>
Der Multipart-Abschnitt 'data' benötigt jetzt zwingend den Content-Type 'application/json'.
Der Request-Body benötigt den Content-Type 'application/json'.
Systeminformationen: Neue Endpunkte
-
enaio®-Version und DMS-Version
-
enaio®-Version, DMS-Version und Detail-Informationen zum Benutzer und den Service-URIs
Bearbeitungshistorie: Erweiterungen
-
GET /api/dms/objects/{objectId}/history
size - Anzahl der zurückzugebenden Einträge pro Seite
page - Nummer der Seite, die zurückgegeben wird
Neuer Parameter 'minimalResponse'
Folgende Endpunkte haben den Parameter minimalResponse zur Beschleunigung der Verarbeitung erhalten:
Tabellen
Für Tabellen auf Indexdatenmasken wird ebenfalls die Spaltenbezeichnung zurückgegeben.
Wenn Sie den DMS service bereits einsetzen, dann prüfen Sie bitte die Verarbeitung. Details dazu finden Sie in der Entwicklerdokumentation.

Parameteränderung
Die Eigenschaft system:versionSeriesCheckedOutBy wurde ersetzt durch system:versionSeriesLockedBy.
Dokumente als ausgecheckt/eingecheckt markieren
-
PATCH /dms/objects/<objectId>/contents/native/locked
Dokument als ausgecheckt markieren
- PATCH /dms/objects/<objectId>/contents/native/unlock
Dokument als eingecheckt markieren
Erweiterung der Suche
-
Suche nach allen ausgecheckten Dokumenten
SELECT * FROM system:locked
Aktuell sind noch keine Einschränkungen dieser Suche über Klauseln möglich.
Wenn Sie den DMS service bereits einsetzen, dann prüfen Sie bitte die Verarbeitung. Details dazu finden Sie in der Entwicklerdokumentation.

Historieneinträge
-
POST /api/dms/objects/{objectId}/history
Einträge können in die Bearbeitungshistorie von Objekten geschrieben werden.