| GET,OPTIONS | /v1/audit/documentaccess |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class DocumentShareAccessLog implements JsonSerializable
{
public function __construct(
/** @var int */
public int $DocumentShareAccessLogId=0,
/** @var int|null */
public ?int $DocumentShareId=null,
/** @var string|null */
public ?string $AttachmentId=null,
/** @var string|null */
public ?string $EventType=null,
/** @var string|null */
public ?string $Outcome=null,
/** @var string|null */
public ?string $DetailMessage=null,
/** @var string|null */
public ?string $IpAddress=null,
/** @var string|null */
public ?string $UserAgent=null,
/** @var string|null */
public ?string $ActorUserId=null,
/** @var string|null */
public ?string $ActorRole=null,
/** @var DateTime */
public DateTime $CreatedAtUtc=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['DocumentShareAccessLogId'])) $this->DocumentShareAccessLogId = $o['DocumentShareAccessLogId'];
if (isset($o['DocumentShareId'])) $this->DocumentShareId = $o['DocumentShareId'];
if (isset($o['AttachmentId'])) $this->AttachmentId = $o['AttachmentId'];
if (isset($o['EventType'])) $this->EventType = $o['EventType'];
if (isset($o['Outcome'])) $this->Outcome = $o['Outcome'];
if (isset($o['DetailMessage'])) $this->DetailMessage = $o['DetailMessage'];
if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
if (isset($o['UserAgent'])) $this->UserAgent = $o['UserAgent'];
if (isset($o['ActorUserId'])) $this->ActorUserId = $o['ActorUserId'];
if (isset($o['ActorRole'])) $this->ActorRole = $o['ActorRole'];
if (isset($o['CreatedAtUtc'])) $this->CreatedAtUtc = JsonConverters::from('DateTime', $o['CreatedAtUtc']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->DocumentShareAccessLogId)) $o['DocumentShareAccessLogId'] = $this->DocumentShareAccessLogId;
if (isset($this->DocumentShareId)) $o['DocumentShareId'] = $this->DocumentShareId;
if (isset($this->AttachmentId)) $o['AttachmentId'] = $this->AttachmentId;
if (isset($this->EventType)) $o['EventType'] = $this->EventType;
if (isset($this->Outcome)) $o['Outcome'] = $this->Outcome;
if (isset($this->DetailMessage)) $o['DetailMessage'] = $this->DetailMessage;
if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
if (isset($this->UserAgent)) $o['UserAgent'] = $this->UserAgent;
if (isset($this->ActorUserId)) $o['ActorUserId'] = $this->ActorUserId;
if (isset($this->ActorRole)) $o['ActorRole'] = $this->ActorRole;
if (isset($this->CreatedAtUtc)) $o['CreatedAtUtc'] = JsonConverters::to('DateTime', $this->CreatedAtUtc);
return empty($o) ? new class(){} : $o;
}
}
class DocumentAccessAuditRow extends DocumentShareAccessLog implements JsonSerializable
{
/**
* @param int $DocumentShareAccessLogId
* @param int|null $DocumentShareId
* @param string|null $AttachmentId
* @param string|null $EventType
* @param string|null $Outcome
* @param string|null $DetailMessage
* @param string|null $IpAddress
* @param string|null $UserAgent
* @param string|null $ActorUserId
* @param string|null $ActorRole
* @param DateTime $CreatedAtUtc
*/
public function __construct(
int $DocumentShareAccessLogId=0,
?int $DocumentShareId=null,
?string $AttachmentId=null,
?string $EventType=null,
?string $Outcome=null,
?string $DetailMessage=null,
?string $IpAddress=null,
?string $UserAgent=null,
?string $ActorUserId=null,
?string $ActorRole=null,
DateTime $CreatedAtUtc=new DateTime(),
/** @var string|null */
public ?string $AccessChannel=null,
/** @var string|null */
public ?string $AttachmentName=null,
/** @var string|null */
public ?string $ActorName=null,
/** @var string|null */
public ?string $RecipientDisplayName=null,
/** @var string|null */
public ?string $RecipientEmail=null,
/** @var string|null */
public ?string $SensitivityTier=null
) {
parent::__construct($DocumentShareAccessLogId,$DocumentShareId,$AttachmentId,$EventType,$Outcome,$DetailMessage,$IpAddress,$UserAgent,$ActorUserId,$ActorRole,$CreatedAtUtc);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['AccessChannel'])) $this->AccessChannel = $o['AccessChannel'];
if (isset($o['AttachmentName'])) $this->AttachmentName = $o['AttachmentName'];
if (isset($o['ActorName'])) $this->ActorName = $o['ActorName'];
if (isset($o['RecipientDisplayName'])) $this->RecipientDisplayName = $o['RecipientDisplayName'];
if (isset($o['RecipientEmail'])) $this->RecipientEmail = $o['RecipientEmail'];
if (isset($o['SensitivityTier'])) $this->SensitivityTier = $o['SensitivityTier'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->AccessChannel)) $o['AccessChannel'] = $this->AccessChannel;
if (isset($this->AttachmentName)) $o['AttachmentName'] = $this->AttachmentName;
if (isset($this->ActorName)) $o['ActorName'] = $this->ActorName;
if (isset($this->RecipientDisplayName)) $o['RecipientDisplayName'] = $this->RecipientDisplayName;
if (isset($this->RecipientEmail)) $o['RecipientEmail'] = $this->RecipientEmail;
if (isset($this->SensitivityTier)) $o['SensitivityTier'] = $this->SensitivityTier;
return empty($o) ? new class(){} : $o;
}
}
class DocumentAccessAuditResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<DocumentAccessAuditRow>|null */
public ?array $AuditLog=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['AuditLog'])) $this->AuditLog = JsonConverters::fromArray('DocumentAccessAuditRow', $o['AuditLog']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->AuditLog)) $o['AuditLog'] = JsonConverters::toArray('DocumentAccessAuditRow', $this->AuditLog);
return empty($o) ? new class(){} : $o;
}
}
class DocumentAccessAuditRequest implements JsonSerializable
{
public function __construct(
/** @var DateTime|null */
public ?DateTime $FromUtc=null,
/** @var DateTime|null */
public ?DateTime $ToUtc=null,
/** @var string|null */
public ?string $ActorUserId=null,
/** @var string|null */
public ?string $AttachmentId=null,
/** @var string|null */
public ?string $EventType=null,
/** @var int */
public int $MaxRows=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['FromUtc'])) $this->FromUtc = JsonConverters::from('DateTime', $o['FromUtc']);
if (isset($o['ToUtc'])) $this->ToUtc = JsonConverters::from('DateTime', $o['ToUtc']);
if (isset($o['ActorUserId'])) $this->ActorUserId = $o['ActorUserId'];
if (isset($o['AttachmentId'])) $this->AttachmentId = $o['AttachmentId'];
if (isset($o['EventType'])) $this->EventType = $o['EventType'];
if (isset($o['MaxRows'])) $this->MaxRows = $o['MaxRows'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->FromUtc)) $o['FromUtc'] = JsonConverters::to('DateTime', $this->FromUtc);
if (isset($this->ToUtc)) $o['ToUtc'] = JsonConverters::to('DateTime', $this->ToUtc);
if (isset($this->ActorUserId)) $o['ActorUserId'] = $this->ActorUserId;
if (isset($this->AttachmentId)) $o['AttachmentId'] = $this->AttachmentId;
if (isset($this->EventType)) $o['EventType'] = $this->EventType;
if (isset($this->MaxRows)) $o['MaxRows'] = $this->MaxRows;
return empty($o) ? new class(){} : $o;
}
}
PHP 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
}
]
}