| All Verbs | /api/activityfeed/{ObjectId} |
|---|
import Foundation
import ServiceStack
/**
* Get activity feed related to the specified object.
*/
// @Api(Description="Get activity feed related to the specified object.")
public class GetActivityFeed : Codable
{
/**
* Object to get activity feed for.
*/
// @ApiMember(Description="Object to get activity feed for.", IsRequired=true, Name="ObjectId")
public var objectId:String
/**
* User, system or triggered.
*/
// @ApiMember(Description="User, system or triggered.", Name="ActivityFeedType")
public var activityFeedType:[String]
/**
* Return all feeds matching criteria or paged results?
*/
// @ApiMember(Description="Return all feeds matching criteria or paged results?", Name="IsPagedMode")
public var isPagedMode:Bool
/**
* 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 var pageNumber:Int
/**
* Number of feeds on each page if paged mode
*/
// @ApiMember(Description="Number of feeds on each page if paged mode", Name="PageSize")
public var pageSize:Int
required public init(){}
}
// @ApiResponse(Description="Activity feed related to the object.")
public class GetActivityFeedResponse : Codable
{
public var activityFeed:[ActivityFeedModel]
public var totalRecords:Int
public var responseStatus:ResponseStatus
required public init(){}
}
public class ActivityFeedModel : Codable
{
/**
* Object linked to the event.
*/
// @ApiMember(DataType="Guid", Description="Object linked to the event.", IsRequired=true, Name="ObjectId")
public var objectId:String
/**
* Event Id
*/
// @ApiMember(DataType="Guid", Description="Event Id", IsRequired=true, Name="ActionEventId")
public var actionEventId:String
/**
* Name of the object linked to the event.
*/
// @ApiMember(DataType="string", Description="Name of the object linked to the event.", Name="ObjectName")
public var objectName:String
/**
* Event description
*/
// @ApiMember(DataType="string", Description="Event description", Name="ActionDescription")
public var actionDescription:String
/**
* Date of occurence of the event.
*/
// @ApiMember(DataType="DateTime", Description="Date of occurence of the event.", IsRequired=true, Name="OccurredDate")
public var occurredDate:Date
/**
* User, system or triggered
*/
// @ApiMember(DataType="Guid", Description="User, system or triggered", Name="AuditLevelId")
public var auditLevelId:String
/**
* User, system or triggered
*/
// @ApiMember(DataType="string", Description="User, system or triggered", Name="AuditLevelName")
public var auditLevelName:String
required public init(){}
}
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
}
}
}