Trendsic Platform Service

DocumentShareAuditRequest

The following routes are available for this service:
GET,OPTIONS	/v1/documentshare/attachment/{AttachmentId}/log

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 DocumentShareAccessLogExtended(DocumentShareAccessLog):
    recipient_display_name: Optional[str] = None
    recipient_email: Optional[str] = None
    recipient_type: Optional[str] = None
    sensitivity_tier: Optional[str] = None
    actor_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentShareAuditResponse:
    response_status: Optional[ResponseStatus] = None
    audit_log: List[DocumentShareAccessLogExtended] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentShareAuditRequest:
    attachment_id: Optional[str] = None

Python DocumentShareAuditRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/documentshare/attachment/{AttachmentId}/log HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentShareAuditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AuditLog>
    <DocumentShareAccessLogExtended>
      <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>
      <ActorName>String</ActorName>
      <RecipientDisplayName>String</RecipientDisplayName>
      <RecipientEmail>String</RecipientEmail>
      <RecipientType>String</RecipientType>
      <SensitivityTier>String</SensitivityTier>
    </DocumentShareAccessLogExtended>
  </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>
</DocumentShareAuditResponse>