| Page Properties |
|---|
|
| Status | |
|---|
| Priority |
|
|---|
| Note |
|
|---|
| Assignee |
|
|---|
RessourcesModification history- 6 Sep 2020 - info on paging query parameter added ...
|
...
| As of Version | 1.0 |
|---|
| Request Method | GET |
|---|
| Response Format | JSON |
|---|
| 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 entriespage - 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 |
| 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 Value | Detail | Meaning |
|---|
| 100 | CREATE_METADATA | Document without document file was created |
| 101 | CREATE_METADATA_WITH_CONTENT | Document including document file was created | 201 | DELETE_CONTENT | Document file
| 110 | OBJECT_TAG_CREATED | Object tag was created |
| 200 | OBJECT_DELETED | Object was irrevocably deleted |
| 202 | OBJECT_FLAGGED_FOR_DELETE | Object was marked for deletion |
| 210 | OBJECT_TAG_DELETED | Object tag was deleted |
| 300 | UPDATE_METADATA | Metadata has been updated |
| 301 | UPDATE_CONTENT | Document file has been updated |
| 302303 | OBJECT_UPDATE_METADATA_WITH_CONTENT | Metadata and document file have been updated |
| 400 | GET_CONTENT | Document file was downloaded |
| 401 | GET_METADATA_CONTENT_MOVED | Object was updated and content moved |
| 310 | OBJECT_TAG_UPDATED | Object tag was modified |
| 400 | DOCUMENT_ACCESSED | Content was output |
| 401 | METADATA_ACCESSED | Metadata was retrieved |
| 402 | GETRENDITION_TEXT_RENDITIONACCESSED | Text preview was downloaded | 403 | GET_PDF_RENDITION | Document file was downloaded as PDF | 404 | GET_THUMBNAIL_RENDITION | Thumbnail preview has been downloaded |