| All Verbs | /api/activityfeed/{ObjectId} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get activity feed related to the specified object.
*/
@Api(Description="Get activity feed related to the specified object.")
open class GetActivityFeed
{
/**
* Object to get activity feed for.
*/
@ApiMember(Description="Object to get activity feed for.", IsRequired=true, Name="ObjectId")
open var ObjectId:UUID? = null
/**
* User, system or triggered.
*/
@ApiMember(Description="User, system or triggered.", Name="ActivityFeedType")
open var ActivityFeedType:ArrayList<UUID>? = null
/**
* Return all feeds matching criteria or paged results?
*/
@ApiMember(Description="Return all feeds matching criteria or paged results?", Name="IsPagedMode")
open var IsPagedMode:Boolean? = null
/**
* 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")
open var PageNumber:Int? = null
/**
* Number of feeds on each page if paged mode
*/
@ApiMember(Description="Number of feeds on each page if paged mode", Name="PageSize")
open var PageSize:Int? = null
}
@ApiResponse(Description="Activity feed related to the object.")
open class GetActivityFeedResponse
{
open var ActivityFeed:ArrayList<ActivityFeedModel>? = null
open var TotalRecords:Int? = null
open var ResponseStatus:ResponseStatus? = null
}
open class ActivityFeedModel
{
/**
* Object linked to the event.
*/
@ApiMember(DataType="Guid", Description="Object linked to the event.", IsRequired=true, Name="ObjectId")
open var ObjectId:UUID? = null
/**
* Event Id
*/
@ApiMember(DataType="Guid", Description="Event Id", IsRequired=true, Name="ActionEventId")
open var ActionEventId:UUID? = null
/**
* Name of the object linked to the event.
*/
@ApiMember(DataType="string", Description="Name of the object linked to the event.", Name="ObjectName")
open var ObjectName:String? = null
/**
* Event description
*/
@ApiMember(DataType="string", Description="Event description", Name="ActionDescription")
open var ActionDescription:String? = null
/**
* Date of occurence of the event.
*/
@ApiMember(DataType="DateTime", Description="Date of occurence of the event.", IsRequired=true, Name="OccurredDate")
open var OccurredDate:Date? = null
/**
* User, system or triggered
*/
@ApiMember(DataType="Guid", Description="User, system or triggered", Name="AuditLevelId")
open var AuditLevelId:UUID? = null
/**
* User, system or triggered
*/
@ApiMember(DataType="string", Description="User, system or triggered", Name="AuditLevelName")
open var AuditLevelName:String? = null
}
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
}
}
}