Trendsic Platform Service

<back to all web services

DocumentAccessAuditRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/audit/documentaccess
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DocumentShareAccessLog() = 
        member val DocumentShareAccessLogId:Int64 = new Int64() with get,set
        member val DocumentShareId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AttachmentId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val EventType:String = null with get,set
        member val Outcome:String = null with get,set
        member val DetailMessage:String = null with get,set
        member val IpAddress:String = null with get,set
        member val UserAgent:String = null with get,set
        member val ActorUserId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val ActorRole:String = null with get,set
        member val CreatedAtUtc:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type DocumentAccessAuditRow() = 
        inherit DocumentShareAccessLog()
        member val AccessChannel:String = null with get,set
        member val AttachmentName:String = null with get,set
        member val ActorName:String = null with get,set
        member val RecipientDisplayName:String = null with get,set
        member val RecipientEmail:String = null with get,set
        member val SensitivityTier:String = null with get,set

    [<AllowNullLiteral>]
    type DocumentAccessAuditResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val AuditLog:ResizeArray<DocumentAccessAuditRow> = new ResizeArray<DocumentAccessAuditRow>() with get,set

    [<AllowNullLiteral>]
    type DocumentAccessAuditRequest() = 
        member val FromUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ToUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ActorUserId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val AttachmentId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val EventType:String = null with get,set
        member val MaxRows:Int32 = new Int32() with get,set

F# DocumentAccessAuditRequest DTOs

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/audit/documentaccess 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: 
	[
		{
			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-01
		}
	]
}