Trendsic Platform Service

<back to all web services

DocumentShareAuditRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/documentshare/attachment/{AttachmentId}/log
DocumentShareAuditRequest Parameters:
NameParameterData TypeRequiredDescription
AttachmentIdpathGuidNo
DocumentShareAuditResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AuditLogformList<DocumentShareAccessLogExtended>No
DocumentShareAccessLogExtended Parameters:
NameParameterData TypeRequiredDescription
RecipientDisplayNameformstringNo
RecipientEmailformstringNo
RecipientTypeformstringNo
SensitivityTierformstringNo
ActorNameformstringNo
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

GET /v1/documentshare/attachment/{AttachmentId}/log HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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