Trendsic Platform Service

<back to all web services

OrgAuditTrailRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/audit
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 RecordAuditDto:
    event_id: int = 0
    record_key: Optional[str] = None
    verb: Optional[str] = None
    who_label: Optional[str] = None
    detail: Optional[str] = None
    when_label: Optional[str] = None
    event_ref: Optional[str] = None
    actor_kind: Optional[str] = None
    auth_context: Optional[str] = None
    ip: Optional[str] = None
    device: Optional[str] = None
    rel_kind: Optional[str] = None
    rel_key: Optional[str] = None
    when_full: Optional[str] = None
    age_days: int = 0
    record_name: Optional[str] = None
    series_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecordAuditResponse:
    response_status: Optional[ResponseStatus] = None
    events: List[RecordAuditDto] = field(default_factory=list)
    total: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrgAuditTrailRequest:
    q: Optional[str] = None
    verb: Optional[str] = None
    range: int = 0
    page: int = 0
    page_size: int = 0
    top: int = 0

Python OrgAuditTrailRequest 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/records/audit HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<RecordAuditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Events>
    <RecordAuditDto>
      <ActorKind>String</ActorKind>
      <AgeDays>0</AgeDays>
      <AuthContext>String</AuthContext>
      <Detail>String</Detail>
      <Device>String</Device>
      <EventId>0</EventId>
      <EventRef>String</EventRef>
      <Ip>String</Ip>
      <RecordKey>String</RecordKey>
      <RecordName>String</RecordName>
      <RelKey>String</RelKey>
      <RelKind>String</RelKind>
      <SeriesName>String</SeriesName>
      <Verb>String</Verb>
      <WhenFull>String</WhenFull>
      <WhenLabel>String</WhenLabel>
      <WhoLabel>String</WhoLabel>
    </RecordAuditDto>
  </Events>
  <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>
  <Total>0</Total>
</RecordAuditResponse>