GET /api/dms/objects/{objectId}/history

Owned by Technische Redaktion
Oct 04, 2021
2 min read
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. 

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 to 100 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
{
    "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 ValueDetailMeaning
100CREATE_METADATADocument without document file was created
101CREATE_METADATA_WITH_CONTENTDocument including document file was created
110OBJECT_TAG_CREATEDObject tag was created
200OBJECT_DELETEDObject was irrevocably deleted
202OBJECT_FLAGGED_FOR_DELETEObject was marked for deletion
210OBJECT_TAG_DELETEDObject tag was deleted
300UPDATE_METADATAMetadata has been updated
301UPDATE_CONTENTDocument file has been updated
303OBJECT_UPDATE_CONTENT_MOVEDObject was updated and content moved
310OBJECT_TAG_UPDATEDObject tag was modified
400DOCUMENT_ACCESSEDContent was output
401METADATA_ACCESSEDMetadata was retrieved
402RENDITION_TEXT_ACCESSEDText preview was downloaded