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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentAccessAuditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AuditLog>
    <DocumentAccessAuditRow>
      <ActorRole>String</ActorRole>
      <ActorUserId>00000000-0000-0000-0000-000000000000</ActorUserId>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <CreatedAtUtc>0001-01-01T00:00:00</CreatedAtUtc>
      <DetailMessage>String</DetailMessage>
      <DocumentShareAccessLogId>0</DocumentShareAccessLogId>
      <DocumentShareId>0</DocumentShareId>
      <EventType>String</EventType>
      <IpAddress>String</IpAddress>
      <Outcome>String</Outcome>
      <UserAgent>String</UserAgent>
      <AccessChannel>String</AccessChannel>
      <ActorName>String</ActorName>
      <AttachmentName>String</AttachmentName>
      <RecipientDisplayName>String</RecipientDisplayName>
      <RecipientEmail>String</RecipientEmail>
      <SensitivityTier>String</SensitivityTier>
    </DocumentAccessAuditRow>
  </AuditLog>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</DocumentAccessAuditResponse>