Resource: AuditEntry

About this resource

Audit Resouce

Properties

Property	Description	Type
entries	Gets or sets a list of entries.	jarray
entryCount	Gets or sets the total entry count.	int32
objectId	Gets or sets the audit object id.	guid

Relations

Method	Name	Select-key	Resource type	Description
GET	self			Provides a link to this resource.

Examples

Reading the audit trail of a record (This route only supports paging type: Skip, Take)

GET /record/55C030F3-185A-4437-B01C-ABDB001F1FA9/trail HTTP/1.1
accept: application/hal+json

{
"objectId": "55c030f3185a4437b01cabdb001f1fa9",
"entryCount": 4,
"entries": [
{
"id": 4,
"type": "recordDownloaded",
"userId": "fa286193ddbf44299d2ea2390e2a8b99",
"createdOn": "0001-01-01T00:00:00",
"changeCount": 1
},
{
"id": 3,
"type": "recordModified",
"userId": "fa286193ddbf44299d2ea2390e2a8b99",
"createdOn": "0001-01-01T00:00:00",
"changeCount": 2
},
{
"id": 2,
"type": "recordCreated",
"userId": "fa286193ddbf44299d2ea2390e2a8b99",
"createdOn": "0001-01-01T00:00:00",
"changeCount": 2
},
{
"id": 1,
"type": "recordModified",
"userId": "fa286193ddbf44299d2ea2390e2a8b99",
"createdOn": "0001-01-01T00:00:00",
"changeCount": 2
}
]
}

The 'filter' parameter is optional and has three valid values. If a different value is passed in the request, the DAM REST API will process the request as if no filter was passed. Valid values:

"" (empty, no filter is applied)
"change" (only record changes are returned)
"download" (only downloads of files of the record are returned)

Reading the audit trail of a record (with an empty filter parameter)

GET /record/55C030F3-185A-4437-B01C-ABDB001F1FA9/trail?filter= HTTP/1.1
accept: application/hal+json

Same response as without the 'filter' parameter.

Reading the audit trail of changes of a record (without download events)

GET /record/55C030F3-185A-4437-B01C-ABDB001F1FA9/trail?filter=change HTTP/1.1
accept: application/hal+json

{
"objectId": "55c030f3185a4437b01cabdb001f1fa9",
"entryCount": 3,
"entries": [
{
"id": 3,
"type": "recordModified",
"userId": "fa286193ddbf44299d2ea2390e2a8b99",
"createdOn": "0001-01-01T00:00:00",
"changeCount": 2
},
{
"id": 2,
"type": "recordCreated",
"userId": "fa286193ddbf44299d2ea2390e2a8b99",
"createdOn": "0001-01-01T00:00:00",
"changeCount": 2
},
{
"id": 1,
"type": "recordModified",
"userId": "fa286193ddbf44299d2ea2390e2a8b99",
"createdOn": "0001-01-01T00:00:00",
"changeCount": 2
}
]
}

Reading the audit trail of downloads of a record (without change events)

GET /record/55C030F3-185A-4437-B01C-ABDB001F1FA9/trail?filter=download HTTP/1.1
accept: application/hal+json

{
"objectId": "55c030f3185a4437b01cabdb001f1fa9",
"entryCount": 4,
"entries": [
{
"id": 4,
"type": "recordDownloaded",
"userId": "fa286193ddbf44299d2ea2390e2a8b99",
"createdOn": "0001-01-01T00:00:00",
"changeCount": 1
}
]
}