| All Verbs | /api/activityfeed/{ObjectId} |
|---|
export class ActivityFeedModel
{
/** @description Object linked to the event. */
// @ApiMember(DataType="Guid", Description="Object linked to the event.", IsRequired=true, Name="ObjectId")
public ObjectId: string;
/** @description Event Id */
// @ApiMember(DataType="Guid", Description="Event Id", IsRequired=true, Name="ActionEventId")
public ActionEventId: string;
/** @description Name of the object linked to the event. */
// @ApiMember(DataType="string", Description="Name of the object linked to the event.", Name="ObjectName")
public ObjectName: string;
/** @description Event description */
// @ApiMember(DataType="string", Description="Event description", Name="ActionDescription")
public ActionDescription: string;
/** @description Date of occurence of the event. */
// @ApiMember(DataType="DateTime", Description="Date of occurence of the event.", IsRequired=true, Name="OccurredDate")
public OccurredDate: string;
/** @description User, system or triggered */
// @ApiMember(DataType="Guid", Description="User, system or triggered", Name="AuditLevelId")
public AuditLevelId: string;
/** @description User, system or triggered */
// @ApiMember(DataType="string", Description="User, system or triggered", Name="AuditLevelName")
public AuditLevelName: string;
public constructor(init?: Partial<ActivityFeedModel>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="Activity feed related to the object.")
export class GetActivityFeedResponse
{
public ActivityFeed: ActivityFeedModel[];
public TotalRecords: number;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetActivityFeedResponse>) { (Object as any).assign(this, init); }
}
/** @description Get activity feed related to the specified object. */
// @Api(Description="Get activity feed related to the specified object.")
export class GetActivityFeed
{
/** @description Object to get activity feed for. */
// @ApiMember(Description="Object to get activity feed for.", IsRequired=true, Name="ObjectId")
public ObjectId: string;
/** @description User, system or triggered. */
// @ApiMember(Description="User, system or triggered.", Name="ActivityFeedType")
public ActivityFeedType: string[];
/** @description Return all feeds matching criteria or paged results? */
// @ApiMember(Description="Return all feeds matching criteria or paged results?", Name="IsPagedMode")
public IsPagedMode: boolean;
/** @description Return feeds matching criteria on the specified page number if paged mode. */
// @ApiMember(Description="Return feeds matching criteria on the specified page number if paged mode.", Name="PageNumber")
public PageNumber: number;
/** @description Number of feeds on each page if paged mode */
// @ApiMember(Description="Number of feeds on each page if paged mode", Name="PageSize")
public PageSize: number;
public constructor(init?: Partial<GetActivityFeed>) { (Object as any).assign(this, init); }
}
TypeScript 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
}
}
}