DMS API Änderungen
In dieser Übersicht werden nur die Änderungen der API an sich beschrieben. Nähere Details dazu können Sie unserer API-Dokumentation entnehmen. Auf Änderungen von intern genutzten Interfaces (z.B. IApiReporting zur Bereitstellung der Dashboard-Funktionalität) wird hier nicht näher eingegangen.
Genaugenommen muss bei den API-Änderungen zwischen Erweiterungen und Änderung unterschieden werden. Während Erweiterungen meist unkritisch sind (z.B. neu hinzugefügte Properties), sind Änderungen als kritisch einzustufen, da sich hiermit die bestehende Struktur der API-Schnittstelle ändert und damit die Kompatibilität zur vorherigen API-Version nicht mehr gegeben ist. Hierunter zählen neben Änderungen der Methoden-Signatur (z.B. Hinzufügen/Entfernen von Parametern) auch die Erweiterungen von Enum-Ausprägungen.
Stand 7.1.0
- 1 API-Änderungen von V7.1.1 zu V7.1.2
- 2 API-Änderungen von V7.0.9 zu V7.1.0
- 3 API-Änderungen von V7.0.8 zu V7.0.9
- 4 API-Änderungen von V7.0.7 zu V7.0.8
- 5 API-Änderungen von V7.0.6.401 zu V7.0.7
- 6 API-Änderungen von V7.0.6 zu V7.0.6.401
- 7 API-Änderungen von V7.0.5 zu V7.0.6
- 8 API-Änderungen von V7.0.4 zu V7.0.5
- 9 API-Änderungen von V7.0.3 zu V7.0.4
- 9.1 Interface IApiArchive
- 9.2 Interface IApiAdmin
- 9.3 Enum Ausprägungen
- 9.4 Klassen
- 10 API-Änderungen von V7.0.2 zu V7.0.3
- 11 API-Änderungen von V6.3 zu V7.0.0
- 11.1 Interface IApiAdmin
- 11.2 Interface IApiArchive
- 11.3 Enum Ausprägungen
- 11.4 Klassen
API-Änderungen von V7.1.1 zu V7.1.2
In der Version V7.1.2 wurden keine Änderungen an der API vorgenommen.
API-Änderungen von V7.0.9 zu V7.1.0
Von der Version V7.0.9 auf die Version V7.1.0 wurden keine Änderungen an der API vorgenommen.
API-Änderungen von V7.0.8 zu V7.0.9
Interface IApiArchive
Kritisch: Im Zuge von Erweiterungen musste der enum EParamType ergänzt werden. Änderungen und Erweiterungen von Enum-Ausprägungen sind immer als kritisch einzustufen
Erweiterung des Enum EParamType
Neu: CsvExportAsText
Einstellung für den CSV-Export als Text. Es kann als Text oder typisiert exportiert werden
API-Änderungen von V7.0.7 zu V7.0.8
Von der Version V7.0.7 auf die Version V7.0.8 wurden keine Änderungen an der API vorgenommen.
API-Änderungen von V7.0.6.401 zu V7.0.7
Interface IApiArchive
Kritisch: Im Zuge von Erweiterungen musste der enum EUserRights um ein weiteres Recht ergänzt werden. Änderungen und Erweiterungen von Enum-Ausprägungen sind immer als kritisch einzustufen
Neue Methoden
AccLoginResult LoginImpersonate(AccLoginContext loginContext)
Erlaubt einem API-User, sich unter einem anderen Benutzer-Kontext anzumelden. Dafür muss dem API-User die Berechtigung „Als anderer Benutzer anmelden“ zugewiesen werden.AccStringResult GetObjectRecVersion(AccGetObjectRecVersionContext context, string ticket)
Damit kann die RecVersion eines Dokuments abgerufen werden. Mit der RecVersion kann festgestellt werden, ob das Objekt zwischenzeitlich geändert wurde.
Erweiterung des Enum EUserRights
Neu: Impersonate
Erlaubt API-Benutzer, sich unter einem anderen Benutzer-Kontext anzumelden
API-Änderungen von V7.0.6 zu V7.0.6.401
Interface IApiWeb
Kritisch: Im Zuge von Bugfixes musste der Rückgabewert von ashx-Handlern angepasst werden. Wenn die Sitzung abgelaufen wurde, dann wurde ein falscher HttpStatusCode zurückgegeben (Code 403). Der HttpStatusCode wurde im Fehlerfall wie folgt angepasst:
HttpCode 401 - wenn die Session abgelaufen oder ungültig ist
HttpCode 403 - wenn die Lizenz ungültig oder das Modul nicht lizenziert ist
API-Änderungen von V7.0.5 zu V7.0.6
Mit V7.0.6 waren nachfolgende Änderungen erforderlich. Die Interfaces für die Dokumenterfassung und für das Reporting sind nur für interne Zwecke gedacht und werden deshalb an dieser Stelle nicht näher beschrieben:
Interface IApiArchive
Neue Methoden
AccResult WriteDocumentHistoryEntry(AccWriteDocumentHistoryContext, string)
Schreibt einen benutzerdefinierten History-Eintrag zu einem DokumentBool TestConnection()
Prüft, ob noch eine gültige Verbindung zum Dienst besteht.AccCheckDocumentResult CheckDocument(Guid, string)
Prüft, ob ein Dokument exisitiert, gelöscht ist und welche Berechtigungen existierten
Interface IApiWeb
Änderungen von Methoden sind immer als kritisch einzustufen
Änderungen von Methoden
Parameter der Methode DownloadDocuments geändert
Auflistung der Dokumenten-IDs (Guid[] docids) durch ID des Suchergebnisses (int searchId) ersetzt.
Interface IApiAdmin
Neue Methoden
AccResult SetPersonalFolderPermissions(AccSetPersonalFolderPermissionContext context,)
Setzt die Berechtigungen für persönliche Ordner auf den konfigurierten Standardwert zurück
Klassen
Erweiterung der Klasse AccDocumentBase
Property FileExtension hinzugefügt
Erweiterung der Klasse AccLogEntry
Property System hinzugefügt
Erweiterung der Klasse AccTaskStepItem
Property DocType hinzugefügt
Property DocFileExtension hinzugefügt
Neue Klasse AccSetPersonalFolderPermissionContext
Property SetPersonalFolderPermissionType
Enum Ausprägungen
Änderungen und Erweiterungen von Enum-Ausprägungen sind immer als kritisch einzustufen
Erweiterung des Enum EParamType
Neu: CaptureCritErrFilingTemplate
Neu: CaptureCritErrNotification
Neu: CaptureCritErrTerminateFlag
Erweiterung des Enum ETaskSortField
Property ColTaskStepRemark hinzugefügt
Property ColTaskNextStepRemark hinzugefügt
Property ColTaskDocType hinzugefügt
Neuer Enum ESetPersonalFolderPermissionType
KeepAdvancedPermissions
Overwrite
OverwriteAndRemoveAdditional
API-Änderungen von V7.0.4 zu V7.0.5
Von V7.0.4 auf V7.0.5 wurden keine relevanten Änderungen an der API vorgenommen.
API-Änderungen von V7.0.3 zu V7.0.4
Mit V7.0.4 waren nachfolgende Änderungen erforderlich. Die anderen Interfaces für die Dokumenterfassung und für das Reporting sind nur für interne Zwecke gedacht und werden deshalb an dieser Stelle nicht näher beschrieben:
Interface IApiArchive
Neue Methoden
AccDocumentResult SeparateAttachment(AccSeparateAttachmentContext, string)
Spaltet Anhänge eines Dokuments als eigene Dokumente abAccDeleteResult DeleteRelations(Guid docID, Guid[] relatedDocIds, string ticket)
Löscht Beziehungen zu einem oder mehreren DokumentenAccStylesheetMappingResult StoreStylesheetMapping(Guid, AccStylesheetMapping, string)
Speichert eine Zuordnung zu einem StyleSheet (notwendig für die Visualisierung von XML-Dateien mit einem XSLT-Stylesheet)AccStylesheetMappingResult GetStylesheetMapping(Guid docID, string ticket)
Gibt die Zuordnung zu einem StyleSheet zurück.AccListItemResult GetObjectById(AccGetObjectByIdContext, string)
Gibt ein Stammdaten-Objekt anhand einer ID zurück (z.B. Attributdefinition)AccListItemsResult GetObjectByName(AccGetObjectByNameContext, string)
Gibt ein oder mehrere Stammdaten-Objekte anhand eines Namens zurückAccLoginResult LoginAuthCode(string, string, string, string)
Login-Methode zur 2-Faktor-Authentifizierung (2-FA)AccResult ResetTowFactorSecret(string, string, string)
Methode zum Zurücksetzen des 2-FA-SecretsAccLocationResult StoreLocationEx(AccStoreLocationContext, string)
Erweiterte Methode zum Speichern eines AblageortsAccContentsResult GetAllContents(Guid, int, AccGetAllContentsContext, string)
Lädt die zu einem Dokument zugehörigen Inhalts-Objekte
Interface IApiAdmin
Neue Methoden
AccResetTwoFactorAuthResult ResetUserTwoFactorAuth(Guid, string)
Setzt die 2-Faktor-Authentifizierung für einen Benutzer zurück
Änderung bestehender Methoden
Der Methode CreateDocumentation(AccCreateDocumentationContext string) wurde ein Parameter hinzugefügt
Enum Ausprägungen
Änderungen und Erweiterungen von Enum-Ausprägungen sind immer als kritisch einzustufen
Änderung des Enum EHashAlgorithm
Entfernt: SHA384
Entfernt: SHA512
Erweiterung des Enum EParamType
Neu: AdoptStampsFromPreviousVersion
Neu: AdoptNotesFromPreviousVersion
Neu: CaptureFailedNotification
Neu: CaptureFailedTerminateFlag
Neu: DokumentationFilePath
Neu: DocumentationDefaultCategory
Erweiterung des Enum EDocType
Neu: EInvoice
Klassen
Änderung der Klasse AccStampAttributeDef
Property UseReferencedAttributeValueOnce entfernt (wurde erst mit V7.0.3 hinzugefügt)
Erweiterung der Klasse AccUserListItem
Property LoginName hinzugefügt
Erweiterung der Klasse AccArchiveInfo
Property DefaultLanguage hinzugefügt
Erweiterung der Klasse AccAnalysisParams
Property Xml hinzugefügt
Neue Klasse AccXmlAnalysisParams
API-Änderungen von V7.0.2 zu V7.0.3
Von V7.0.2 auf V7.0.3 wurden keine relevanten Änderungen an der API vorgenommen.
API-Änderungen von V6.3 zu V7.0.0
Interface IApiAdmin
Neue Methoden
CreateDocumentation()
Erstellt alle Berichte zu den StammdatenSyncAttributeList()
Methode zum dynamischen Füllen von Attribut-Listen
Interface IApiArchive
Neue Methoden
GetLocationInfo(Guid, string)
Ruft zusätzliche Informationen zu einem Ablageorts abGetName(AccGetNameContext, string)
Ruft den Namen eines Stammdaten-Objekts anhand einer ID abGetIdentifier(AccGetIdentifierContext, string)
Ruft die ID eines Stammdaten-Objekts anhand eines Namens ab
Änderung bestehender Methoden
Die Methode StartTask() gibt jetzt ein AccStartTaskResult zurück.
Enum Ausprägungen
Änderungen und Erweiterungen von Enum-Ausprägungen sind immer als kritisch einzustufen
Änderung des Enum EMsgCode
Es mussten alle Fehlercodes neu durchnummeriert werden!
Es kann eine Mapping-Tabelle der Änderungen angefordert werden, sofern dies erforderlich ist.
Erweiterung des Enum EParamType
Neu: CaptureUnknownFilingTemplate
Neu: CaptureUnknownNotification
Neu: CaptureUnknownTerminateFlag
Klassen
Erweiterung der Klasse AccStartTask um neues Property Metadata
Änderung der Klasse AccExportResult
Property MasterData wurde umbenannt in Data
Änderung der Klasse AccTaskStepButtonDef
Property ExportMetadata wurde entfernt
Property ExportType wurde hinzugefügt
Änderung der Klasse AccDocListItemsResult
Property HaseMoreItems entfernt
Erweiterung der Klasse AccRelation
Property DocThumbnailID
Property DocThumbnailRotation
Property RelatedThumbnailID
Property RelatedThumbnailRotation