Trendsic Platform Service

<back to all web services

DocumentAccessAuditRequest

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

GET /v1/audit/documentaccess HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01
		}
	]
}