SystemEventResource Resource

Provides a web service interface for the Event model. Note: Event instances are created by the system, so we do not have create/update/delete methods here.

The following query parameters apply to all actions in this resource to apply filtering to the event streams.

eventTypes
Filter events by type
itemTypes
Filter events based on the item type of their subjects
itemIds
Filter events pertaining to specific item IDs
users
Filter events based on the user IDs they involve
from
Exclude events prior to this date (ISO 8601 format)
to
Exclude events after this date (ISO 8601 format)

Additionally the aggregate* end-points accept an aggregation parameter that groups sequential events according to one of two different strategies:

user
Groups sequential events of all types that are initiated by the same actioner
strict
Groups sequential events that:
  • have the same type
  • have the same actioner
  • have the same subjects
  • have the same scope
  • have the same log message

Additionally, aggregation can be disabled by using aggregation=off.

Standard paging parameters apply to all end-points.

GET /classes/SystemEvent

List aggregated global events. Standard list parameters for paging apply.

Request Parameters
name type description default constraints
aggregation query The manner in which to aggregate the results, accepting "user", "strict" or "off" (no aggregation). Default is "user". user "off" or "strict" or "user"
Response Body
media type data type description
application/json (custom) a list of events

Example

Request
GET /classes/SystemEvent
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /classes/SystemEvent/{id}

Fetch a resource by id.

Request Parameters
name type description constraints
id path The requested item id regex: [^/]+
Response Body
media type data type description
application/json (custom) A serialized item representation

Example

Request
GET /classes/SystemEvent/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /classes/SystemEvent/{id}/subjects

Fetch a page of subjects for a given event.

Request Parameters
name type description constraints
id path the event id regex: [^/]+
Response Body
media type data type description
application/json (custom) a list of subject items

Example

Request
GET /classes/SystemEvent/{id}/subjects
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...