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