| All Verbs | /api/activityfeed/{ObjectId} |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ActivityFeedModel:
# @ApiMember(DataType="Guid", Description="Object linked to the event.", IsRequired=true, Name="ObjectId")
object_id: Optional[str] = None
"""
Object linked to the event.
"""
# @ApiMember(DataType="Guid", Description="Event Id", IsRequired=true, Name="ActionEventId")
action_event_id: Optional[str] = None
"""
Event Id
"""
# @ApiMember(DataType="string", Description="Name of the object linked to the event.", Name="ObjectName")
object_name: Optional[str] = None
"""
Name of the object linked to the event.
"""
# @ApiMember(DataType="string", Description="Event description", Name="ActionDescription")
action_description: Optional[str] = None
"""
Event description
"""
# @ApiMember(DataType="DateTime", Description="Date of occurence of the event.", IsRequired=true, Name="OccurredDate")
occurred_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
Date of occurence of the event.
"""
# @ApiMember(DataType="Guid", Description="User, system or triggered", Name="AuditLevelId")
audit_level_id: Optional[str] = None
"""
User, system or triggered
"""
# @ApiMember(DataType="string", Description="User, system or triggered", Name="AuditLevelName")
audit_level_name: Optional[str] = None
"""
User, system or triggered
"""
# @ApiResponse(Description="Activity feed related to the object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetActivityFeedResponse:
activity_feed: Optional[List[ActivityFeedModel]] = None
total_records: int = 0
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get activity feed related to the specified object.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetActivityFeed:
"""
Get activity feed related to the specified object.
"""
# @ApiMember(Description="Object to get activity feed for.", IsRequired=true, Name="ObjectId")
object_id: Optional[str] = None
"""
Object to get activity feed for.
"""
# @ApiMember(Description="User, system or triggered.", Name="ActivityFeedType")
activity_feed_type: Optional[List[str]] = None
"""
User, system or triggered.
"""
# @ApiMember(Description="Return all feeds matching criteria or paged results?", Name="IsPagedMode")
is_paged_mode: bool = False
"""
Return all feeds matching criteria or paged results?
"""
# @ApiMember(Description="Return feeds matching criteria on the specified page number if paged mode.", Name="PageNumber")
page_number: int = 0
"""
Return feeds matching criteria on the specified page number if paged mode.
"""
# @ApiMember(Description="Number of feeds on each page if paged mode", Name="PageSize")
page_size: int = 0
"""
Number of feeds on each page if paged mode
"""
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
}
}
}