dms.GetObjectHistory

This job returns the editing history of a given object in XML format.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`Flags`	INT	Yes	Flags must be `0`
`ObjectID`	INT	Yes	ID of the object
`[LangID]`	INT	No	Language in which the action descriptions should be output. Action descriptions are available in German (`7`), English (`9`) and French (`12`). If this parameter is not specified or the language is not available, German is used as the default language.
`[Encoding]`	STRING	No	XML encoding for the result. Allowed are `UTF-16` (Default) and `UTF-8`.

Flags

INT

Yes

Flags must be 0

ObjectID

INT

Yes

ID of the object

[LangID]

INT

Language in which the action descriptions should be output.
Action descriptions are available in German (7), English (9) and French (12).
If this parameter is not specified or the language is not available, German is used as the default language.

[Encoding]

STRING

XML encoding for the result. Allowed are UTF-16 (Default) and UTF-8.

2. Output Parameters

Name Type Dependency Description

Name	Type	Dependency	Description
`History`	BASE64	—	Editing history in XML format. The response is returned as a UTF-16-encoded byte string.

History

BASE64

—

Editing history in XML format. The response is returned as a UTF-16-encoded byte string.

3. XML Structure of the History

3.1. Example

<?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">Index data modified</Action>
    <Description>The object's index data or its status has been modified using client functions or by carrying out an update as part of the import operation.</Description>
    <UserNameShort>ROOT</UserNameShort>
    <UserNameFull>Administrator</UserNameFull>
    <Station station_id="C7377EEAAE0A4486A97AAE671EA82A4E">ECM4</Station>
    <Info>Index data modified</Info>
  </Modification>
  <Modification osguid="11EB572C8C4E4FAFB66181AF16D3BD4B">
    <Time>15.08.2025 14:54:19</Time>
    <Action id="2">Object created</Action>
    <Description>The specified object was created using client functions or via an import operation.</Description>
    <UserNameShort>ROOT</UserNameShort>
    <UserNameFull>Administrator</UserNameFull>
    <Station station_id="C7377EEAAE0A4486A97AAE671EA82A4E">ECM4</Station>
    <Info>Object created</Info>
  </Modification>
</DMSHistory>

3.2. `<DMSHistory>` — Root Element

Attribute Type Description

Attribute	Type	Description
`exec_version`	STRING	Version number of the executing server (e.g. `12.0.769.25242`).
`timestamp`	STRING	Timestamp of the query in the format `DD.MM.YYYY HH:MM:SS`.

exec_version

STRING

Version number of the executing server (e.g. 12.0.769.25242).

timestamp

STRING

Timestamp of the query in the format DD.MM.YYYY HH:MM:SS.

3.3. `<Modification>` — Single History Entry

Repeating child element of <DMSHistory>. Entries are sorted in descending chronological order (most recent first).

Attribute Type Description

Attribute	Type	Description
`osguid`	STRING	Unique GUID of the history entry (32 hex characters, without hyphens).

osguid

STRING

Unique GUID of the history entry (32 hex characters, without hyphens).

Child elements:

Element Type Description

Element	Type	Description
`<Time>`	STRING	Timestamp of the modification in the format `DD.MM.YYYY HH:MM:SS`.
`<Action id="…">`	STRING (text) / INT (attribute)	Localized short name of the action. The `id` attribute contains the numeric action ID (see Actions).
`<Description>`	STRING	Localized long description of the action.
`<UserNameShort>`	STRING	Internal username (login name, e.g. `ROOT`).
`<UserNameFull>`	STRING	Display name of the user (e.g. `Administrator`).
`<Station station_id="…">`	STRING (text) / STRING (attribute)	Hostname of the workstation. The `station_id` attribute contains the GUID of the station.
`<Info>`	STRING	Additional information about the action.

<Time>

STRING

Timestamp of the modification in the format DD.MM.YYYY HH:MM:SS.

<Action id="…">

STRING (text) / INT (attribute)

Localized short name of the action. The id attribute contains the numeric action ID (see Actions).

<Description>

STRING

Localized long description of the action.

<UserNameShort>

STRING

Internal username (login name, e.g. ROOT).

<UserNameFull>

STRING

Display name of the user (e.g. Administrator).

<Station station_id="…">

STRING (text) / STRING (attribute)

Hostname of the workstation. The station_id attribute contains the GUID of the station.

<Info>

STRING

Additional information about the action.

<Action>, <Description> and <Info> are localized in the language selected via LangID. Entries are sorted in descending order by timestamp — the most recent entry appears first.

4. Actions

The following table lists all possible action types that can appear in the editing history:

ID Name Description

ID	Name	Description
`1`	`ELECTRONIC_SIGNATURE`	The document has been electronically signed.
`2`	`OBJECT_CREATED`	The object was created using client functions or via an import operation.
`3`	`INDEX_DATA_MODIFIED`	The object’s index data or its status has been modified.
`4`	`CONTENT_CHANGED`	The document content was edited via client functions or an import update.
`5`	`DOCUMENT_ARCHIVED`	The document was archived in a legally compliant manner.
`6`	`DOCUMENT_DELETED`	The document was deleted.
`7`	`OUTPUT_CONTENT`	The document content was read, printed, or otherwise output without changes.
`8`	`DOCUMENT_STATUS_APPROVED`	The document’s status was set to 'Approved for archiving'.
`9`	`DOCUMENT_STATUS_NOT_APPROVED`	The document’s status was set to 'Not approved for archiving'.
`10`	`DOCUMENT_CREATED`	The object was created using client functions or via an import operation.
`11`	`LINK_CREATED`	The document was linked via notes to another object.
`12`	`LINK_REMOVED`	An existing link to another object has been removed.
`13`	`SQL_QUERY`	Data was requested via SQL.
`14`	`SQL_COMMAND`	Data was modified via SQL.
`15`	`ELECTRONIC_SIGNATURE_ADDED`	An electronically signed document was marked with another signature.
`16`	`SIGNED_DOCUMENT_DELETED`	The signed document was deleted.
`17`	`VERSION_CREATED`	A version was created for the document.
`18`	`VERSION_DELETED`	A version of the document was deleted.
`19`	`RESTORED_FROM_VERSION`	The document was restored from a previous version.
`20`	`FULLTEXT_QUERY`	The database was searched using a full-text query.
`21`	`DOCUMENT_MOVED`	The document location was changed.
`22`	`REGISTER_MOVED`	The register location was changed.
`23`	`FOLDER_MERGED_FROM`	Objects in the folder were merged from another folder.
`24`	`FOLDER_MERGED_TO`	Objects in the folder were moved to another folder.
`25`	`REGISTER_MERGED_FROM`	Objects in the register were merged from another register.
`26`	`REGISTER_MERGED_TO`	Objects in the register were moved to another register.
`27`	`OBJECT_MARKED_FOR_DELETION`	The object was moved to the recycle bin.
`28`	`OBJECT_RECOVERED`	The object has been restored from the recycle bin.
`29`	`OBJECT_IRREVOCABLY_DELETED`	The object was deleted and cannot be restored.
`30`	`NOTICE_CONFIRMED`	The user has acknowledged the document’s content.
`31`	`OBJECT_INFORMATION`	Log entry from the business model.
`32`	`OWNER_CHANGED`	Ownership of the object was transferred to another user.
`33`	`VARIANT_ACTIVATED`	The document was defined as the active variant.
`34`	`VARIANT_DEACTIVATED`	The 'active variant' status was deactivated.
`35`	`VARIANT_DELETED`	A variant of the document was deleted.
`36`	`VARIANT_CREATED`	A variant of the document was created.
`37`	`TYPE_ASSIGNED`	An object type was assigned to an object without a type.
`38`	`MOVED_FROM_FILING_TRAY`	The document location was changed from the filing tray to a folder or register.
`39`	`NEW_LOCATION_ADDED`	A new location was added to this document.
`40`	`USER_INFORMATION`	Additional information entered by user.
`41`	`RETENTION_TIME_SET`	The retention time was set during archiving or while increasing the retention time.
`42`	`DOCUMENT_DEARCHIVED`	The document was dearchived.
`43`	`DOCUMENT_TYPE_MODIFIED`	The document type was modified.
`44`	`PREVIEW_ANNOTATION_CREATED`	A preview annotation was created for this document.
`45`	`PREVIEW_ANNOTATION_CHANGED`	A preview annotation was changed.
`46`	`PREVIEW_ANNOTATION_DELETED`	A preview annotation was deleted.
`47`	`NOTICE_CONFIRMED_BY_PASSWORD`	The confirmation of notice was confirmed by the user by entering a password.
`48`	`DOCUMENT_SHARE_CREATED`	This document was shared with other users for editing or in read-only mode.
`49`	`DOCUMENT_SHARE_MODIFIED`	This document share was modified.
`50`	`DOCUMENT_SHARE_DELETED`	This document share was deleted.
`51`	`CREATED_FROM_COPY`	This object was created as a copy of another object.
`52`	`REMOVED_FROM_LOCATION`	This object was removed from a location.
`53`	`ACTIVE_VARIANT_STATUS_CHANGED`	The 'active variant' status has been changed in variant administration.
`54`	`ADDITIONAL_VARIANT_CREATED`	Another variant has been created in variant administration.
`55`	`DOCUMENT_COLLABORATIVE_EDITING`	The user has participated in the collaborative editing of this document.
`56`	`DOCUMENT_EDITED_EXTERNALLY`	A user has edited the document content via an external application.

1

ELECTRONIC_SIGNATURE

The document has been electronically signed.

2

OBJECT_CREATED

The object was created using client functions or via an import operation.

3

INDEX_DATA_MODIFIED

The object’s index data or its status has been modified.

4

CONTENT_CHANGED

The document content was edited via client functions or an import update.

5

DOCUMENT_ARCHIVED

The document was archived in a legally compliant manner.

6

DOCUMENT_DELETED

The document was deleted.

7

OUTPUT_CONTENT

The document content was read, printed, or otherwise output without changes.

8

DOCUMENT_STATUS_APPROVED

The document’s status was set to 'Approved for archiving'.

9

DOCUMENT_STATUS_NOT_APPROVED

The document’s status was set to 'Not approved for archiving'.

10

DOCUMENT_CREATED

The object was created using client functions or via an import operation.

11

LINK_CREATED

The document was linked via notes to another object.

12

LINK_REMOVED

An existing link to another object has been removed.

13

SQL_QUERY

Data was requested via SQL.

14

SQL_COMMAND

Data was modified via SQL.

15

ELECTRONIC_SIGNATURE_ADDED

An electronically signed document was marked with another signature.

16

SIGNED_DOCUMENT_DELETED

The signed document was deleted.

17

VERSION_CREATED

A version was created for the document.

18

VERSION_DELETED

A version of the document was deleted.

19

RESTORED_FROM_VERSION

The document was restored from a previous version.

20

FULLTEXT_QUERY

The database was searched using a full-text query.

21

DOCUMENT_MOVED

The document location was changed.

22

REGISTER_MOVED

The register location was changed.

23

FOLDER_MERGED_FROM

Objects in the folder were merged from another folder.

24

FOLDER_MERGED_TO

Objects in the folder were moved to another folder.

25

REGISTER_MERGED_FROM

Objects in the register were merged from another register.

26

REGISTER_MERGED_TO

Objects in the register were moved to another register.

27

OBJECT_MARKED_FOR_DELETION

The object was moved to the recycle bin.

28

OBJECT_RECOVERED

The object has been restored from the recycle bin.

29

OBJECT_IRREVOCABLY_DELETED

The object was deleted and cannot be restored.

30

NOTICE_CONFIRMED

The user has acknowledged the document’s content.

31

OBJECT_INFORMATION

Log entry from the business model.

32

OWNER_CHANGED

Ownership of the object was transferred to another user.

33

VARIANT_ACTIVATED

The document was defined as the active variant.

34

VARIANT_DEACTIVATED

The 'active variant' status was deactivated.

35

VARIANT_DELETED

A variant of the document was deleted.

36

VARIANT_CREATED

A variant of the document was created.

37

TYPE_ASSIGNED

An object type was assigned to an object without a type.

38

MOVED_FROM_FILING_TRAY

The document location was changed from the filing tray to a folder or register.

39

NEW_LOCATION_ADDED

A new location was added to this document.

40

USER_INFORMATION

Additional information entered by user.

41

RETENTION_TIME_SET

The retention time was set during archiving or while increasing the retention time.

42

DOCUMENT_DEARCHIVED

The document was dearchived.

43

DOCUMENT_TYPE_MODIFIED

The document type was modified.

44

PREVIEW_ANNOTATION_CREATED

A preview annotation was created for this document.

45

PREVIEW_ANNOTATION_CHANGED

A preview annotation was changed.

46

PREVIEW_ANNOTATION_DELETED

A preview annotation was deleted.

47

NOTICE_CONFIRMED_BY_PASSWORD

The confirmation of notice was confirmed by the user by entering a password.

48

DOCUMENT_SHARE_CREATED

This document was shared with other users for editing or in read-only mode.

49

DOCUMENT_SHARE_MODIFIED

This document share was modified.

50

DOCUMENT_SHARE_DELETED

This document share was deleted.

51

CREATED_FROM_COPY

This object was created as a copy of another object.

52

REMOVED_FROM_LOCATION

This object was removed from a location.

53

ACTIVE_VARIANT_STATUS_CHANGED

The 'active variant' status has been changed in variant administration.

54

ADDITIONAL_VARIANT_CREATED

Another variant has been created in variant administration.

55

DOCUMENT_COLLABORATIVE_EDITING

The user has participated in the collaborative editing of this document.

56

DOCUMENT_EDITED_EXTERNALLY

A user has edited the document content via an external application.

5. Return Value

(INT): 0 = Job successful, otherwise error code
Complete list of error codes

If the user was deleted in the meantime, UserNameShort and UserNameFull are not filled in the result.

dms.GetObjectHistory

1. Input Parameters

2. Output Parameters

3. XML Structure of the History

3.1. Example

3.2. <DMSHistory> — Root Element

3.3. <Modification> — Single History Entry

4. Actions

5. Return Value

3.2. `<DMSHistory>` — Root Element

3.3. `<Modification>` — Single History Entry