Hub 2018.2 Help

Get All Events

Request

GET <REST API URL>/events?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter Description
fields Optional. Returns only the specified subset of the fields for each Event. Use Fields Syntax to define the subset.
$skip Optional. Lets you set a number of Events to skip before returning the first one.
$top Optional. Lets you set the maximum number of Events to return.
query

Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the Events, the following fields and tuples are supported:

after: instant — Events after the given moment

afterId: number — Events after the given id (exclusive)

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

before: instant — Events before the given moment

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

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

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

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

orderBy Optional. Returns the list of Events sorted by a specified field. See Sorting Syntax for details. Events support ordering by the following fields: id, timestamp

Response

Response Code Meaning
200 OK Successful request.
400 Bad Request At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.
403 Forbidden The requester has no access to the requested resource.
404 Not Found The requested resource was not found.
500 Internal Server Error Failed to process request because of the server error. For details, check the error message in the response.

Response body

page

{ "skip": int, "top": int, "total": int, "events": [event, ...] }
Last modified: 30 May 2018