Trendsic Platform Service

<back to all web services

DocumentAccessAuditRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/audit/documentaccess

export class DocumentShareAccessLog
{
    public DocumentShareAccessLogId: number;
    public DocumentShareId?: number;
    public AttachmentId?: string;
    public EventType: string;
    public Outcome: string;
    public DetailMessage: string;
    public IpAddress: string;
    public UserAgent: string;
    public ActorUserId?: string;
    public ActorRole: string;
    public CreatedAtUtc: string;

    public constructor(init?: Partial<DocumentShareAccessLog>) { (Object as any).assign(this, init); }
}

export class DocumentAccessAuditRow extends DocumentShareAccessLog
{
    public AccessChannel: string;
    public AttachmentName: string;
    public ActorName: string;
    public RecipientDisplayName: string;
    public RecipientEmail: string;
    public SensitivityTier: string;

    public constructor(init?: Partial<DocumentAccessAuditRow>) { super(init); (Object as any).assign(this, init); }
}

export class DocumentAccessAuditResponse
{
    public ResponseStatus: ResponseStatus;
    public AuditLog: DocumentAccessAuditRow[] = [];

    public constructor(init?: Partial<DocumentAccessAuditResponse>) { (Object as any).assign(this, init); }
}

export class DocumentAccessAuditRequest
{
    public FromUtc?: string;
    public ToUtc?: string;
    public ActorUserId?: string;
    public AttachmentId?: string;
    public EventType: string;
    public MaxRows: number;

    public constructor(init?: Partial<DocumentAccessAuditRequest>) { (Object as any).assign(this, init); }
}

TypeScript DocumentAccessAuditRequest DTOs

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"}]}