Trendsic Platform Service

<back to all web services

OrgAuditTrailRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/audit
"use strict";
export class RecordAuditDto {
    /** @param {{EventId?:number,RecordKey?:string,Verb?:string,WhoLabel?:string,Detail?:string,WhenLabel?:string,EventRef?:string,ActorKind?:string,AuthContext?:string,Ip?:string,Device?:string,RelKind?:string,RelKey?:string,WhenFull?:string,AgeDays?:number,RecordName?:string,SeriesName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    EventId;
    /** @type {string} */
    RecordKey;
    /** @type {string} */
    Verb;
    /** @type {string} */
    WhoLabel;
    /** @type {string} */
    Detail;
    /** @type {string} */
    WhenLabel;
    /** @type {string} */
    EventRef;
    /** @type {string} */
    ActorKind;
    /** @type {string} */
    AuthContext;
    /** @type {string} */
    Ip;
    /** @type {string} */
    Device;
    /** @type {string} */
    RelKind;
    /** @type {string} */
    RelKey;
    /** @type {string} */
    WhenFull;
    /** @type {number} */
    AgeDays;
    /** @type {string} */
    RecordName;
    /** @type {string} */
    SeriesName;
}
export class RecordAuditResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Events?:RecordAuditDto[],Total?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {RecordAuditDto[]} */
    Events = [];
    /** @type {number} */
    Total;
}
export class OrgAuditTrailRequest {
    /** @param {{Q?:string,Verb?:string,Range?:number,Page?:number,PageSize?:number,Top?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Q;
    /** @type {string} */
    Verb;
    /** @type {number} */
    Range;
    /** @type {number} */
    Page;
    /** @type {number} */
    PageSize;
    /** @type {number} */
    Top;
}

JavaScript OrgAuditTrailRequest DTOs

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

HTTP + JSV

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: 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
		}
	},
	Events: 
	[
		{
			EventId: 0,
			RecordKey: String,
			Verb: String,
			WhoLabel: String,
			Detail: String,
			WhenLabel: String,
			EventRef: String,
			ActorKind: String,
			AuthContext: String,
			Ip: String,
			Device: String,
			RelKind: String,
			RelKey: String,
			WhenFull: String,
			AgeDays: 0,
			RecordName: String,
			SeriesName: String
		}
	],
	Total: 0
}