Trendsic Platform Service

<back to all web services

DocumentAccessAuditRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/audit/documentaccess
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class DocumentAccessAuditRequest
    {
        public Date FromUtc = null;
        public Date ToUtc = null;
        public UUID ActorUserId = null;
        public UUID AttachmentId = null;
        public String EventType = null;
        public Integer MaxRows = null;
        
        public Date getFromUtc() { return FromUtc; }
        public DocumentAccessAuditRequest setFromUtc(Date value) { this.FromUtc = value; return this; }
        public Date getToUtc() { return ToUtc; }
        public DocumentAccessAuditRequest setToUtc(Date value) { this.ToUtc = value; return this; }
        public UUID getActorUserId() { return ActorUserId; }
        public DocumentAccessAuditRequest setActorUserId(UUID value) { this.ActorUserId = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public DocumentAccessAuditRequest setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public String getEventType() { return EventType; }
        public DocumentAccessAuditRequest setEventType(String value) { this.EventType = value; return this; }
        public Integer getMaxRows() { return MaxRows; }
        public DocumentAccessAuditRequest setMaxRows(Integer value) { this.MaxRows = value; return this; }
    }

    public static class DocumentAccessAuditResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<DocumentAccessAuditRow> AuditLog = new ArrayList<DocumentAccessAuditRow>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DocumentAccessAuditResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<DocumentAccessAuditRow> getAuditLog() { return AuditLog; }
        public DocumentAccessAuditResponse setAuditLog(ArrayList<DocumentAccessAuditRow> value) { this.AuditLog = value; return this; }
    }

    public static class DocumentAccessAuditRow extends DocumentShareAccessLog
    {
        public String AccessChannel = null;
        public String AttachmentName = null;
        public String ActorName = null;
        public String RecipientDisplayName = null;
        public String RecipientEmail = null;
        public String SensitivityTier = null;
        
        public String getAccessChannel() { return AccessChannel; }
        public DocumentAccessAuditRow setAccessChannel(String value) { this.AccessChannel = value; return this; }
        public String getAttachmentName() { return AttachmentName; }
        public DocumentAccessAuditRow setAttachmentName(String value) { this.AttachmentName = value; return this; }
        public String getActorName() { return ActorName; }
        public DocumentAccessAuditRow setActorName(String value) { this.ActorName = value; return this; }
        public String getRecipientDisplayName() { return RecipientDisplayName; }
        public DocumentAccessAuditRow setRecipientDisplayName(String value) { this.RecipientDisplayName = value; return this; }
        public String getRecipientEmail() { return RecipientEmail; }
        public DocumentAccessAuditRow setRecipientEmail(String value) { this.RecipientEmail = value; return this; }
        public String getSensitivityTier() { return SensitivityTier; }
        public DocumentAccessAuditRow setSensitivityTier(String value) { this.SensitivityTier = value; return this; }
    }

    public static class DocumentShareAccessLog
    {
        public Long DocumentShareAccessLogId = null;
        public Integer DocumentShareId = null;
        public UUID AttachmentId = null;
        public String EventType = null;
        public String Outcome = null;
        public String DetailMessage = null;
        public String IpAddress = null;
        public String UserAgent = null;
        public UUID ActorUserId = null;
        public String ActorRole = null;
        public Date CreatedAtUtc = null;
        
        public Long getDocumentShareAccessLogId() { return DocumentShareAccessLogId; }
        public DocumentShareAccessLog setDocumentShareAccessLogId(Long value) { this.DocumentShareAccessLogId = value; return this; }
        public Integer getDocumentShareId() { return DocumentShareId; }
        public DocumentShareAccessLog setDocumentShareId(Integer value) { this.DocumentShareId = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public DocumentShareAccessLog setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public String getEventType() { return EventType; }
        public DocumentShareAccessLog setEventType(String value) { this.EventType = value; return this; }
        public String getOutcome() { return Outcome; }
        public DocumentShareAccessLog setOutcome(String value) { this.Outcome = value; return this; }
        public String getDetailMessage() { return DetailMessage; }
        public DocumentShareAccessLog setDetailMessage(String value) { this.DetailMessage = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public DocumentShareAccessLog setIpAddress(String value) { this.IpAddress = value; return this; }
        public String getUserAgent() { return UserAgent; }
        public DocumentShareAccessLog setUserAgent(String value) { this.UserAgent = value; return this; }
        public UUID getActorUserId() { return ActorUserId; }
        public DocumentShareAccessLog setActorUserId(UUID value) { this.ActorUserId = value; return this; }
        public String getActorRole() { return ActorRole; }
        public DocumentShareAccessLog setActorRole(String value) { this.ActorRole = value; return this; }
        public Date getCreatedAtUtc() { return CreatedAtUtc; }
        public DocumentShareAccessLog setCreatedAtUtc(Date value) { this.CreatedAtUtc = value; return this; }
    }

}

Java 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>