dms.GetObjectHistory

Dieser Job liefert zu einem vorgegebenen Objekt die Bearbeitungshistorie im XML Format.

1. Eingabeparameter

Name Typ Pflicht Beschreibung

Flags

INT

Ja

Flags muss 0 sein

ObjectID

INT

Ja

ID des Objektes

[LangID]

INT

Nein

Sprache, in der die Aktionsbeschreibungen ausgegeben werden sollen.
Aktionsbeschreibungen liegen in den Sprachen Deutsch (7), Englisch (9) und Französisch (12) vor.
Wenn dieser Parameter nicht angegeben wird oder die Sprache nicht zur Verfügung steht, wird Deutsch als Defaultsprache verwendet.

[Encoding]

STRING

Nein

XML-Encoding für das Ergebnis. Erlaubt sind UTF-16 (Default) und UTF-8.

2. Ausgabeparameter

Name Typ Abhängigkeit Beschreibung

History

BASE64

—

Bearbeitungshistorie im XML-Format. Die Antwort wird als UTF-16-kodierter Byte-String zurückgegeben.

3. XML-Struktur der Historie

3.1. Beispiel

<?xml version="1.0" encoding="UTF-16" standalone="yes"?>
<DMSHistory exec_version="12.0.769.25242" timestamp="09.04.2026 10:47:20">
  <Modification osguid="278D932B28F34F1B97CC5B87F6B37AF9">
    <Time>09.04.2026 10:40:27</Time>
    <Action id="3">Indexdaten geändert</Action>
    <Description>Die Indexdaten des Objekts oder dessen Status wurden durch Funktionen des Clients oder durch ein Update mittels des Imports geändert.</Description>
    <UserNameShort>ROOT</UserNameShort>
    <UserNameFull>Administrator</UserNameFull>
    <Station station_id="C7377EEAAE0A4486A97AAE671EA82A4E">ECM4</Station>
    <Info>Indexdaten geändert</Info>
  </Modification>
  <Modification osguid="11EB572C8C4E4FAFB66181AF16D3BD4B">
    <Time>15.08.2025 14:54:19</Time>
    <Action id="2">Objekt angelegt</Action>
    <Description>Das angegebene Objekt wurde durch Funktionen des Clients oder durch einen Import erzeugt.</Description>
    <UserNameShort>ROOT</UserNameShort>
    <UserNameFull>Administrator</UserNameFull>
    <Station station_id="C7377EEAAE0A4486A97AAE671EA82A4E">ECM4</Station>
    <Info>Objekt angelegt</Info>
  </Modification>
</DMSHistory>

3.2. <DMSHistory> — Root-Element

Attribut Typ Beschreibung

exec_version

STRING

Versionsnummer des ausführenden Servers (z. B. 12.0.769.25242).

timestamp

STRING

Zeitpunkt der Abfrage im Format DD.MM.YYYY HH:MM:SS.

3.3. <Modification> — Einzelner History-Eintrag

Wiederholendes Kind-Element von <DMSHistory>. Die Einträge sind chronologisch absteigend sortiert (neueste zuerst).

Attribut Typ Beschreibung

osguid

STRING

Eindeutige GUID des History-Eintrags (32 Zeichen Hex, ohne Bindestriche).

Kind-Elemente:

Element Typ Beschreibung

<Time>

STRING

Zeitpunkt der Änderung im Format DD.MM.YYYY HH:MM:SS.

<Action id="…​">

STRING (Text) / INT (Attribut)

Lokalisierter Kurzname der Aktion. Das id-Attribut enthält die numerische Action-ID (siehe Actions).

<Description>

STRING

Lokalisierte Langbeschreibung der Aktion.

<UserNameShort>

STRING

Interner Benutzername (Login-Name, z. B. ROOT).

<UserNameFull>

STRING

Anzeigename des Benutzers (z. B. Administrator).

<Station station_id="…​">

STRING (Text) / STRING (Attribut)

Hostname der Workstation. Das station_id-Attribut enthält die GUID der Station.

<Info>

STRING

Zusätzliche Informationen zur Aktion.
<Action>, <Description> und <Info> sind in der über LangID gewählten Sprache lokalisiert. Die Sortierung ist absteigend nach Zeitpunkt — der neueste Eintrag steht oben.

4. Actions

Die folgende Tabelle listet alle möglichen Action-Typen auf, die in der Bearbeitungshistorie vorkommen können:

ID Name Beschreibung

1

ELECTRONIC_SIGNATURE

Das Dokument wurde elektronisch signiert.

2

OBJECT_CREATED

Das Objekt wurde über Clientfunktionen oder eine Importoperation erstellt.

3

INDEX_DATA_MODIFIED

Die Indexdaten oder der Status des Objekts wurden geändert.

4

CONTENT_CHANGED

Der Dokumentinhalt wurde über Clientfunktionen oder ein Importupdate bearbeitet.

5

DOCUMENT_ARCHIVED

Das Dokument wurde revisionssicher archiviert.

6

DOCUMENT_DELETED

Das Dokument wurde gelöscht.

7

OUTPUT_CONTENT

Der Dokumentinhalt wurde gelesen, gedruckt oder anderweitig ohne Änderungen ausgegeben.

8

DOCUMENT_STATUS_APPROVED

Der Dokumentstatus wurde auf „Zur Archivierung freigegeben" gesetzt.

9

DOCUMENT_STATUS_NOT_APPROVED

Der Dokumentstatus wurde auf „Nicht zur Archivierung freigegeben" gesetzt.

10

DOCUMENT_CREATED

Das Objekt wurde über Clientfunktionen oder eine Importoperation erstellt.

11

LINK_CREATED

Das Dokument wurde über Notizen mit einem anderen Objekt verknüpft.

12

LINK_REMOVED

Eine bestehende Verknüpfung zu einem anderen Objekt wurde entfernt.

13

SQL_QUERY

Daten wurden per SQL abgefragt.

14

SQL_COMMAND

Daten wurden per SQL geändert.

15

ELECTRONIC_SIGNATURE_ADDED

Ein elektronisch signiertes Dokument wurde mit einer weiteren Signatur versehen.

16

SIGNED_DOCUMENT_DELETED

Das signierte Dokument wurde gelöscht.

17

VERSION_CREATED

Für das Dokument wurde eine Version erstellt.

18

VERSION_DELETED

Eine Version des Dokuments wurde gelöscht.

19

RESTORED_FROM_VERSION

Das Dokument wurde aus einer früheren Version wiederhergestellt.

20

FULLTEXT_QUERY

Die Datenbank wurde mit einer Volltextabfrage durchsucht.

21

DOCUMENT_MOVED

Der Ablageort des Dokuments wurde geändert.

22

REGISTER_MOVED

Der Ablageort des Registers wurde geändert.

23

FOLDER_MERGED_FROM

Objekte im Ordner wurden aus einem anderen Ordner zusammengeführt.

24

FOLDER_MERGED_TO

Objekte im Ordner wurden in einen anderen Ordner verschoben.

25

REGISTER_MERGED_FROM

Objekte im Register wurden aus einem anderen Register zusammengeführt.

26

REGISTER_MERGED_TO

Objekte im Register wurden in ein anderes Register verschoben.

27

OBJECT_MARKED_FOR_DELETION

Das Objekt wurde in den Papierkorb verschoben.

28

OBJECT_RECOVERED

Das Objekt wurde aus dem Papierkorb wiederhergestellt.

29

OBJECT_IRREVOCABLY_DELETED

Das Objekt wurde unwiderruflich gelöscht.

30

NOTICE_CONFIRMED

Der Benutzer hat den Inhalt des Dokuments zur Kenntnis genommen.

31

OBJECT_INFORMATION

Protokolleintrag aus dem Geschäftsmodell.

32

OWNER_CHANGED

Der Eigentümer des Objekts wurde auf einen anderen Benutzer übertragen.

33

VARIANT_ACTIVATED

Das Dokument wurde als aktive Variante definiert.

34

VARIANT_DEACTIVATED

Der Status „Aktive Variante" wurde deaktiviert.

35

VARIANT_DELETED

Eine Variante des Dokuments wurde gelöscht.

36

VARIANT_CREATED

Eine Variante des Dokuments wurde erstellt.

37

TYPE_ASSIGNED

Einem Objekt ohne Typ wurde ein Objekttyp zugewiesen.

38

MOVED_FROM_FILING_TRAY

Der Ablageort des Dokuments wurde vom Eingangskorb in einen Ordner oder ein Register geändert.

39

NEW_LOCATION_ADDED

Diesem Dokument wurde ein neuer Ablageort hinzugefügt.

40

USER_INFORMATION

Zusätzliche Information, die vom Benutzer eingegeben wurde.

41

RETENTION_TIME_SET

Die Aufbewahrungsfrist wurde bei der Archivierung oder bei einer Verlängerung der Aufbewahrungsfrist gesetzt.

42

DOCUMENT_DEARCHIVED

Das Dokument wurde dearchiviert.

43

DOCUMENT_TYPE_MODIFIED

Der Dokumenttyp wurde geändert.

44

PREVIEW_ANNOTATION_CREATED

Für dieses Dokument wurde eine Vorschau-Annotation erstellt.

45

PREVIEW_ANNOTATION_CHANGED

Eine Vorschau-Annotation wurde geändert.

46

PREVIEW_ANNOTATION_DELETED

Eine Vorschau-Annotation wurde gelöscht.

47

NOTICE_CONFIRMED_BY_PASSWORD

Die Kenntnisnahme wurde vom Benutzer durch Eingabe eines Passworts bestätigt.

48

DOCUMENT_SHARE_CREATED

Dieses Dokument wurde für andere Benutzer zur Bearbeitung oder im Lesemodus freigegeben.

49

DOCUMENT_SHARE_MODIFIED

Die Dokumentfreigabe wurde geändert.

50

DOCUMENT_SHARE_DELETED

Die Dokumentfreigabe wurde gelöscht.

51

CREATED_FROM_COPY

Dieses Objekt wurde als Kopie eines anderen Objekts erstellt.

52

REMOVED_FROM_LOCATION

Dieses Objekt wurde von einem Ablageort entfernt.

53

ACTIVE_VARIANT_STATUS_CHANGED

Der Status „Aktive Variante" wurde in der Variantenverwaltung geändert.

54

ADDITIONAL_VARIANT_CREATED

Eine weitere Variante wurde in der Variantenverwaltung erstellt.

55

DOCUMENT_COLLABORATIVE_EDITING

Der Benutzer hat an der kollaborativen Bearbeitung dieses Dokuments teilgenommen.

56

DOCUMENT_EDITED_EXTERNALLY

Ein Benutzer hat den Dokumentinhalt über eine externe Anwendung bearbeitet.

5. Rückgabe

(INT): 0 = Job erfolgreich, sonst Fehlercode
Vollständige Fehlerliste

Wenn der Benutzer zwischenzeitig gelöscht wurde, sind UserNameShort und UserNameFull im Ergebnis nicht ausgefüllt.