Trendsic Platform Service

<back to all web services

DocumentAccessAuditRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/audit/documentaccess
"use strict";
export class DocumentShareAccessLog {
    /** @param {{DocumentShareAccessLogId?:number,DocumentShareId?:number,AttachmentId?:string,EventType?:string,Outcome?:string,DetailMessage?:string,IpAddress?:string,UserAgent?:string,ActorUserId?:string,ActorRole?:string,CreatedAtUtc?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DocumentShareAccessLogId;
    /** @type {?number} */
    DocumentShareId;
    /** @type {?string} */
    AttachmentId;
    /** @type {string} */
    EventType;
    /** @type {string} */
    Outcome;
    /** @type {string} */
    DetailMessage;
    /** @type {string} */
    IpAddress;
    /** @type {string} */
    UserAgent;
    /** @type {?string} */
    ActorUserId;
    /** @type {string} */
    ActorRole;
    /** @type {string} */
    CreatedAtUtc;
}
export class DocumentAccessAuditRow extends DocumentShareAccessLog {
    /** @param {{AccessChannel?:string,AttachmentName?:string,ActorName?:string,RecipientDisplayName?:string,RecipientEmail?:string,SensitivityTier?:string,DocumentShareAccessLogId?:number,DocumentShareId?:number,AttachmentId?:string,EventType?:string,Outcome?:string,DetailMessage?:string,IpAddress?:string,UserAgent?:string,ActorUserId?:string,ActorRole?:string,CreatedAtUtc?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    AccessChannel;
    /** @type {string} */
    AttachmentName;
    /** @type {string} */
    ActorName;
    /** @type {string} */
    RecipientDisplayName;
    /** @type {string} */
    RecipientEmail;
    /** @type {string} */
    SensitivityTier;
}
export class DocumentAccessAuditResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AuditLog?:DocumentAccessAuditRow[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {DocumentAccessAuditRow[]} */
    AuditLog = [];
}
export class DocumentAccessAuditRequest {
    /** @param {{FromUtc?:string,ToUtc?:string,ActorUserId?:string,AttachmentId?:string,EventType?:string,MaxRows?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    FromUtc;
    /** @type {?string} */
    ToUtc;
    /** @type {?string} */
    ActorUserId;
    /** @type {?string} */
    AttachmentId;
    /** @type {string} */
    EventType;
    /** @type {number} */
    MaxRows;
}

JavaScript DocumentAccessAuditRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}]}