1.4 History Codes
The GET "/dms/objects/{id}/history” REST endpoint returns a list of changes made to the object with the ID {id}. The meanings of the individual history codes are listed in the table below.
Some of the Core API codes do not have a corresponding enaio code yet. These are Core API history codes currently only supported in the yuuvis® system. However, as they will most likely be introduced to the enaio® system in the future, they are already mentioned here.
Core API | enaio | Description | Constant |
|
|---|---|---|---|---|
100 | 2 | Object created | OBJECT_CREATED | The specified object was created by functions of the client or by an import. |
101 | 10 | Document created | OBJECT_CREATED_WITH_CONTENT | The object was created using functions of the client or via an import operation. |
102 | 51 | Created from copy | OBJECT_CREATED_FROM_COPY | This object was created as a copy of another object. |
|
|
|
|
|
110 | - | Object tag created | OBJECT_TAG_CREATED | A tag for the object was created. |
|
|
|
|
|
120 | 17 | Version created | VERSION_CREATED | A version of the document was created. |
121 | 36 | Variant created | VARIANT_CREATED | A variant of the document was created. |
122 | 54 | Additional variant created | VARIANT_CREATION_SOURCE | As opposed to 121, the entry is added to the source document from which the variant was derived. |
|
|
|
|
|
130 | - | Document created | DOCUMENT_CREATED |
|
131 | - | Document added from template | DOCUMENT_CREATED_FROM_TEMPLATE | An object's document was added from a template. |
|
|
|
|
|
140 | 39 | New location added | REFERENCE_COPY_CREATED | A new location was added to this document. |
141 | 11 | Link created | OBJECT_LINK_CREATED | The document was linked via notes to another object. |
142 | - | Location created | OBJECT_LOCATION_CREATED | Another location was added to this object. |
|
|
|
|
|
150 | 44 | Preview annotation created | ANNOTATION_CREATED | A preview annotation was created for this document. |
|
|
|
|
|
160 | 48 | Document share created | OBJECT_SHARE_CREATED | This document was shared with other users for editing or in read-only mode. |
|
|
|
|
|
200 | 29 | Object irrevocably deleted | OBJECT_DELETED | The object was deleted and cannot be restored. |
201 | - | Document file deleted | OBJECT_CONTENT_DELETED | The content of the object was deleted. The object contains only index data now. |
202 | 27 | Object marked for deletion | OBJECT_FLAGGED_FOR_DELETE | The object was moved to the recycle bin. |
|
|
|
|
|
210 | - | Object tag deleted | OBJECT_TAG_DELETED | One of the object's tags was deleted. |
|
|
|
|
|
220 | 18 | Version deleted | VERSION_DELETED | A version of the document was deleted. |
221 | 35 | Variant deleted | VARIANT_DELETED | A variant of the document was deleted. |
|
|
|
|
|
230 | 6 | Document deleted | DOCUMENT_DELETED | The object was deleted and cannot be restored. |
231 | 16 | Signed document deleted | SIGNED_DOCUMENT_DELETED | The signed document was deleted. |
|
|
|
|
|
240 | - | Reference copy deleted | OBJECT_REFERENCE_DELETED | A reference copy of this document was deleted. |
241 | 12 | Link removed | OBJECT_LINK_DELETED | An existing link to another object has been removed. |
242 | 52 | Removed from a location | OBJECT_LOCATION_DELETED | This object was removed from a location. |
|
|
|
|
|
250 | 46 | Preview annotation deleted | ANNOTATION_DELETED | A preview annotation was deleted. |
|
|
|
|
|
260 | 50 | Document share deleted | OBJECT_SHARE_DELETED | This document share was deleted. |
|
|
|
|
|
300 | 3 | Index data modified | OBJECT_METADATA_CHANGED | The index data of the object or its status was edited using functions of the client or via an update carried out during the import operation. |
301 | 4 | Content changed | OBJECT_DOCUMENT_CHANGED | The document was edited using functions of the client or via an update carried out during the import operation. |
302 | - | Index data and document modified | OBJECT_METADATA_DOCUMENT_CHANGED | Index data and document were edited at the same time. |
303 | - | Object updated and content moved | OBJECT_UPDATE_CONTENT_MOVED | The object was updated and the document was moved. |
304 | 55 | Content collaborative changed | OBJECT_DOCUMENT_COLLABORATIVE_CHANGED | The document was collaborative editted by this user. |
305 | 56 | Content changed through external application | OBJECT_DOCUMENT_CHANGED_EXT_APP | The document was changed within an external application. |
|
|
|
|
|
310 | - | Object tag modified | OBJECT_TAG_UPDATED | One of the object's tags was changed. |
|
|
|
|
|
320 | 37 | Type assigned to object without type | OBJECT_TYPED | An object type was assigned to an object without a type. |
321 | 43 | Document type modified | OBJECT_TYPE_CHANGED | The document type was modified. |
322 | 32 | Owner of object changed | OBJECT_OWNER_CHANGED | Ownership of the object was transferred to another user. |
323 | 14 | SQL command | OBJECT_CHANGED_OVER_SQL | Data was changed via SQL. |
324 | 28 | Object restored | OBJECT_RESTORED | The object has been restored. |
325 | 19 | Restored from version | VERSION_RESTORED | The document was restored from a previous version of the document. |
326 | 41 | Retention time set | OBJECT_RETENTION_TIME_SET | The retention time was set during archiving or while increasing the retention time. |
|
|
|
|
|
330 | 33 | Variant activated | VARIANT_ACTIVATED | The document was defined as the active variant. |
331 | 53 | Status 'active variant' changed | VARIANT_SOURCE_ACTIVATED | As opposed to 321, this entry is added to the source document from which the variant was activated. |
332 | 34 | Variant deactivated | VARIANT_DEACTIVATED | The 'active variant' status was deactivated. |
|
|
|
|
|
340 | 21 | Document moved | DOCUMENT_MOVED | The document location was changed. |
341 | 22 | Register moved | REGISTER_MOVED | The register location was changed. |
342 | 38 | Document moved from filing tray | OBJECT_MOVED_FROM_TRAY | The document location has been in the clipboard up to this point; it is now a folder or register. |
|
|
|
|
|
350 |