Trendsic Platform Service

<back to all web services

DocumentAccessAuditRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/audit/documentaccess
DocumentAccessAuditRequest Parameters:
NameParameterData TypeRequiredDescription
FromUtcqueryDateTime?No
ToUtcqueryDateTime?No
ActorUserIdqueryGuid?No
AttachmentIdqueryGuid?No
EventTypequerystringNo
MaxRowsqueryintNo
DocumentAccessAuditResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AuditLogformList<DocumentAccessAuditRow>No
DocumentAccessAuditRow Parameters:
NameParameterData TypeRequiredDescription
AccessChannelformstringNo
AttachmentNameformstringNo
ActorNameformstringNo
RecipientDisplayNameformstringNo
RecipientEmailformstringNo
SensitivityTierformstringNo
DocumentShareAccessLog Parameters:
NameParameterData TypeRequiredDescription
DocumentShareAccessLogIdformlongNo
DocumentShareIdformint?No
AttachmentIdformGuid?No
EventTypeformstringNo
OutcomeformstringNo
DetailMessageformstringNo
IpAddressformstringNo
UserAgentformstringNo
ActorUserIdformGuid?No
ActorRoleformstringNo
CreatedAtUtcformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/audit/documentaccess HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"AuditLog":[{"AccessChannel":"String","AttachmentName":"String","ActorName":"String","RecipientDisplayName":"String","RecipientEmail":"String","SensitivityTier":"String","DocumentShareAccessLogId":0,"DocumentShareId":0,"AttachmentId":"00000000000000000000000000000000","EventType":"String","Outcome":"String","DetailMessage":"String","IpAddress":"String","UserAgent":"String","ActorUserId":"00000000000000000000000000000000","ActorRole":"String","CreatedAtUtc":"0001-01-01T00:00:00.0000000"}]}