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 'package:servicestack/servicestack.dart';

class DocumentShareAccessLog implements IConvertible
{
    int? DocumentShareAccessLogId;
    int? DocumentShareId;
    String? AttachmentId;
    String? EventType;
    String? Outcome;
    String? DetailMessage;
    String? IpAddress;
    String? UserAgent;
    String? ActorUserId;
    String? ActorRole;
    DateTime? CreatedAtUtc;

    DocumentShareAccessLog({this.DocumentShareAccessLogId,this.DocumentShareId,this.AttachmentId,this.EventType,this.Outcome,this.DetailMessage,this.IpAddress,this.UserAgent,this.ActorUserId,this.ActorRole,this.CreatedAtUtc});
    DocumentShareAccessLog.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DocumentShareAccessLogId = json['DocumentShareAccessLogId'];
        DocumentShareId = json['DocumentShareId'];
        AttachmentId = json['AttachmentId'];
        EventType = json['EventType'];
        Outcome = json['Outcome'];
        DetailMessage = json['DetailMessage'];
        IpAddress = json['IpAddress'];
        UserAgent = json['UserAgent'];
        ActorUserId = json['ActorUserId'];
        ActorRole = json['ActorRole'];
        CreatedAtUtc = JsonConverters.fromJson(json['CreatedAtUtc'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DocumentShareAccessLogId': DocumentShareAccessLogId,
        'DocumentShareId': DocumentShareId,
        'AttachmentId': AttachmentId,
        'EventType': EventType,
        'Outcome': Outcome,
        'DetailMessage': DetailMessage,
        'IpAddress': IpAddress,
        'UserAgent': UserAgent,
        'ActorUserId': ActorUserId,
        'ActorRole': ActorRole,
        'CreatedAtUtc': JsonConverters.toJson(CreatedAtUtc,'DateTime',context!)
    };

    getTypeName() => "DocumentShareAccessLog";
    TypeContext? context = _ctx;
}

class DocumentAccessAuditRow extends DocumentShareAccessLog implements IConvertible
{
    String? AccessChannel;
    String? AttachmentName;
    String? ActorName;
    String? RecipientDisplayName;
    String? RecipientEmail;
    String? SensitivityTier;

    DocumentAccessAuditRow({this.AccessChannel,this.AttachmentName,this.ActorName,this.RecipientDisplayName,this.RecipientEmail,this.SensitivityTier});
    DocumentAccessAuditRow.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        AccessChannel = json['AccessChannel'];
        AttachmentName = json['AttachmentName'];
        ActorName = json['ActorName'];
        RecipientDisplayName = json['RecipientDisplayName'];
        RecipientEmail = json['RecipientEmail'];
        SensitivityTier = json['SensitivityTier'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'AccessChannel': AccessChannel,
        'AttachmentName': AttachmentName,
        'ActorName': ActorName,
        'RecipientDisplayName': RecipientDisplayName,
        'RecipientEmail': RecipientEmail,
        'SensitivityTier': SensitivityTier
    });

    getTypeName() => "DocumentAccessAuditRow";
    TypeContext? context = _ctx;
}

class DocumentAccessAuditResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<DocumentAccessAuditRow>? AuditLog = [];

    DocumentAccessAuditResponse({this.ResponseStatus,this.AuditLog});
    DocumentAccessAuditResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        AuditLog = JsonConverters.fromJson(json['AuditLog'],'List<DocumentAccessAuditRow>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'AuditLog': JsonConverters.toJson(AuditLog,'List<DocumentAccessAuditRow>',context!)
    };

    getTypeName() => "DocumentAccessAuditResponse";
    TypeContext? context = _ctx;
}

class DocumentAccessAuditRequest implements IConvertible
{
    DateTime? FromUtc;
    DateTime? ToUtc;
    String? ActorUserId;
    String? AttachmentId;
    String? EventType;
    int? MaxRows;

    DocumentAccessAuditRequest({this.FromUtc,this.ToUtc,this.ActorUserId,this.AttachmentId,this.EventType,this.MaxRows});
    DocumentAccessAuditRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FromUtc = JsonConverters.fromJson(json['FromUtc'],'DateTime',context!);
        ToUtc = JsonConverters.fromJson(json['ToUtc'],'DateTime',context!);
        ActorUserId = json['ActorUserId'];
        AttachmentId = json['AttachmentId'];
        EventType = json['EventType'];
        MaxRows = json['MaxRows'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FromUtc': JsonConverters.toJson(FromUtc,'DateTime',context!),
        'ToUtc': JsonConverters.toJson(ToUtc,'DateTime',context!),
        'ActorUserId': ActorUserId,
        'AttachmentId': AttachmentId,
        'EventType': EventType,
        'MaxRows': MaxRows
    };

    getTypeName() => "DocumentAccessAuditRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'DocumentShareAccessLog': TypeInfo(TypeOf.Class, create:() => DocumentShareAccessLog()),
    'DocumentAccessAuditRow': TypeInfo(TypeOf.Class, create:() => DocumentAccessAuditRow()),
    'DocumentAccessAuditResponse': TypeInfo(TypeOf.Class, create:() => DocumentAccessAuditResponse()),
    'List<DocumentAccessAuditRow>': TypeInfo(TypeOf.Class, create:() => <DocumentAccessAuditRow>[]),
    'DocumentAccessAuditRequest': TypeInfo(TypeOf.Class, create:() => DocumentAccessAuditRequest()),
});

Dart DocumentAccessAuditRequest DTOs

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

HTTP + JSV

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: 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
		}
	]
}