| GET,OPTIONS | /v1/audit/documentaccess |
|---|
import Foundation
import ServiceStack
public class DocumentAccessAuditRequest : Codable
{
public var fromUtc:Date?
public var toUtc:Date?
public var actorUserId:String?
public var attachmentId:String?
public var eventType:String
public var maxRows:Int
required public init(){}
}
public class DocumentAccessAuditResponse : Codable
{
public var responseStatus:ResponseStatus
public var auditLog:[DocumentAccessAuditRow] = []
required public init(){}
}
public class DocumentAccessAuditRow : DocumentShareAccessLog
{
public var accessChannel:String
public var attachmentName:String
public var actorName:String
public var recipientDisplayName:String
public var recipientEmail:String
public var sensitivityTier:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case accessChannel
case attachmentName
case actorName
case recipientDisplayName
case recipientEmail
case sensitivityTier
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
accessChannel = try container.decodeIfPresent(String.self, forKey: .accessChannel)
attachmentName = try container.decodeIfPresent(String.self, forKey: .attachmentName)
actorName = try container.decodeIfPresent(String.self, forKey: .actorName)
recipientDisplayName = try container.decodeIfPresent(String.self, forKey: .recipientDisplayName)
recipientEmail = try container.decodeIfPresent(String.self, forKey: .recipientEmail)
sensitivityTier = try container.decodeIfPresent(String.self, forKey: .sensitivityTier)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if accessChannel != nil { try container.encode(accessChannel, forKey: .accessChannel) }
if attachmentName != nil { try container.encode(attachmentName, forKey: .attachmentName) }
if actorName != nil { try container.encode(actorName, forKey: .actorName) }
if recipientDisplayName != nil { try container.encode(recipientDisplayName, forKey: .recipientDisplayName) }
if recipientEmail != nil { try container.encode(recipientEmail, forKey: .recipientEmail) }
if sensitivityTier != nil { try container.encode(sensitivityTier, forKey: .sensitivityTier) }
}
}
public class DocumentShareAccessLog : Codable
{
public var documentShareAccessLogId:Int
public var documentShareId:Int?
public var attachmentId:String?
public var eventType:String
public var outcome:String
public var detailMessage:String
public var ipAddress:String
public var userAgent:String
public var actorUserId:String?
public var actorRole:String
public var createdAtUtc:Date
required public init(){}
}
Swift DocumentAccessAuditRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>