| All Verbs | /api/activityfeed/{ObjectId} |
|---|
"use strict";
export class ActivityFeedModel {
/** @param {{ObjectId?:string,ActionEventId?:string,ObjectName?:string,ActionDescription?:string,OccurredDate?:string,AuditLevelId?:string,AuditLevelName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Object linked to the event. */
ObjectId;
/**
* @type {string}
* @description Event Id */
ActionEventId;
/**
* @type {string}
* @description Name of the object linked to the event. */
ObjectName;
/**
* @type {string}
* @description Event description */
ActionDescription;
/**
* @type {string}
* @description Date of occurence of the event. */
OccurredDate;
/**
* @type {string}
* @description User, system or triggered */
AuditLevelId;
/**
* @type {string}
* @description User, system or triggered */
AuditLevelName;
}
export class GetActivityFeedResponse {
/** @param {{ActivityFeed?:ActivityFeedModel[],TotalRecords?:number,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ActivityFeedModel[]} */
ActivityFeed;
/** @type {number} */
TotalRecords;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetActivityFeed {
/** @param {{ObjectId?:string,ActivityFeedType?:string[],IsPagedMode?:boolean,PageNumber?:number,PageSize?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Object to get activity feed for. */
ObjectId;
/**
* @type {string[]}
* @description User, system or triggered. */
ActivityFeedType;
/**
* @type {boolean}
* @description Return all feeds matching criteria or paged results? */
IsPagedMode;
/**
* @type {number}
* @description Return feeds matching criteria on the specified page number if paged mode. */
PageNumber;
/**
* @type {number}
* @description Number of feeds on each page if paged mode */
PageSize;
}
JavaScript GetActivityFeed 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.
POST /api/activityfeed/{ObjectId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ActivityFeedType:
[
00000000-0000-0000-0000-000000000000
],
IsPagedMode: False,
PageNumber: 0,
PageSize: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ActivityFeed:
[
{
ObjectName: String,
ActionDescription: String,
OccurredDate: 0001-01-01,
AuditLevelName: String
}
],
TotalRecords: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}