Hub 2.5 Help

Get All Events

Request

GET <REST API URL>/events?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter Description
fields Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset.
$skip Optional query parameter. Number of roles to skip before returning first entry of the page.
$top Optional query parameter. Max number of roles to return in the page.
query

Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for Events:

author: user — Events triggered by the user, group or service

author: group — Events triggered by the user, group or service

author: service — Events triggered by the user, group or service

event: auditEventType — Events of the given type created, updated or deleted

entityType: entityType — Events with the entities of the given type

target: value — Events with the given event target

target: authModule — Events with the given event target

target: role — Events with the given event target

target: service — Events with the given event target

target: user — Events with the given event target

target: group — Events with the given event target

before: instant — Events before the given moment

beforeId: number — Events before the given id (including)

after: instant — Events after the given moment

afterId: number — Events after the given id excluding

orderBy Order results. See Sorting Syntax for details. Roles can be ordered by the following fields: timestamp, id

Response

Response Code Meaning
200 OK Successful request.
400 Bad Request Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource wasn't found.
500 Internal Server Error Failed to process request because of the server error. The response contains message describing the error.

Response body

page

{ "skip": int, "top": int, "total": int, "events": [event, ...] }
Last modified: 20 September 2016