Versions Compared

Old Version 10

changes.mady.by.user Technische Redaktion

Saved on

compared with

New Version Current

changes.mady.by.user Technische Redaktion

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue


Status

Status
colourGreen
titleDONE

Priority
Note
Assignee

Ressources

Remarks

Modification history

  • 6 Sep 2020 - info on paging query parameter added ...

...

As of Versionproduct version 1.0 | component version 1.0
Request MethodGET
Response FormatJSON
Required Permissionsuccessful authentication
Description

To retrieve the history entries of a DMS object, send the request with the ID of the DMS object as objectId. 

Meaning of action field values:
>> Audit Trail - an "Object's History"

By default, the last 50 entries are returned. You can control the history entries returned by using the following query parameters

  • size - defines the number of returned history entries
  • page - defines on which page the result list of history entries should be started (one page = 50 entries)

For example, to get 50 history entries from 51 101 to 100 150 returned use size=50 and page=2.

Request Example
/api/dms/objects/903f2ae8-2cfc-476c-8386-55c6811e41da/history
/api/dms/objects/903f2ae8-2cfc-476c-8386-55c6811e41da/history?size=50&page=2 
Result Example


Panel
{
    "objects": [{
        "properties": {
            "system:objectId": {
                "value": 213518578
            },
            "system:objectTypeId": {
                "value": "system:audit"
            },
            "system:baseTypeId": {
                "value": "item"
             },
            "system:createdBy": {
                "value": "1EF9EB6E7F2F41D69D5408609CFF5FFD"
            },
            "system:tenant": {
                "value": "default"
            },
            "system:creationDate": {
                "value": "2018-05-18T13:25:25.450Z"
            },
            "description": {
                "value": ""
            },
            "action": {
                "value": 401
            },
            "detail": {
                "value": "GET_METADATA"
            },
            "referredObjectId": {
                "value": "df398a31-3ed3-4fe6-a744-a0d0f90b8678"
            },
            "traceid": {
                "value": "0a53668f42b6691a"
            },
            "system:versionNumber": {
                "value": 1
            }
        }
    },
    {
        "properties": {
            "system:objectId": {
                "value": 213509340
            },
            "system:objectTypeId": {
                "value": "system:audit"
            },
            "system:baseTypeId": {
                "value": "item"
            },
            "system:createdBy": {
                "value": "1EF9EB6E7F2F41D69D5408609CFF5FFD"
            },
            "system:tenant": {
                "value": "default"
            },
            "system:creationDate": {
                "value": "2018-05-18T01:45:44.040Z"
            },
            "description": {
                "value": ""
            },
            "action": {
                "value": 101
            },
            "detail": {
                "value": "CREATE_METADATA_WITH_CONTENT"
            },
            "referredObjectId": {
                "value": "df398a31-3ed3-4fe6-a744-a0d0f90b8678"
            },
            "traceid": {
                "value": "43d141cec4ea8a58"
            },
            "system:versionNumber": {
                "value": 1
            }
        }
    }]
}

Meaning of action field values

Action ValueDetailMeaning100CREATE_METADATADocument without document file was created101CREATE_METADATA_WITH_CONTENTDocument including document file was created110OBJECT_TAG_CREATEDObject tag was created200OBJECT_DELETEDObject was irrevocably deleted202OBJECT_FLAGGED_FOR_DELETEObject was marked for deletion210OBJECT_TAG_DELETEDObject tag was deleted300UPDATE_METADATAMetadata has been updated301UPDATE_CONTENTDocument file has been updated303OBJECT_UPDATE_CONTENT_MOVEDObject was updated and content moved310OBJECT_TAG_UPDATEDObject tag was modified400DOCUMENT_ACCESSEDContent was output401METADATA_ACCESSEDMetadata was retrieved402RENDITION_TEXT_ACCESSEDText preview was downloaded