| GET,OPTIONS | /v1/audit/documentaccess |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentShareAccessLog:
document_share_access_log_id: int = 0
document_share_id: Optional[int] = None
attachment_id: Optional[str] = None
event_type: Optional[str] = None
outcome: Optional[str] = None
detail_message: Optional[str] = None
ip_address: Optional[str] = None
user_agent: Optional[str] = None
actor_user_id: Optional[str] = None
actor_role: Optional[str] = None
created_at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentAccessAuditRow(DocumentShareAccessLog):
access_channel: Optional[str] = None
attachment_name: Optional[str] = None
actor_name: Optional[str] = None
recipient_display_name: Optional[str] = None
recipient_email: Optional[str] = None
sensitivity_tier: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentAccessAuditResponse:
response_status: Optional[ResponseStatus] = None
audit_log: List[DocumentAccessAuditRow] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentAccessAuditRequest:
from_utc: Optional[datetime.datetime] = None
to_utc: Optional[datetime.datetime] = None
actor_user_id: Optional[str] = None
attachment_id: Optional[str] = None
event_type: Optional[str] = None
max_rows: int = 0
Python DocumentAccessAuditRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}