Skip to main content
Publish And Retrieve Ui Events

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

LatestKnownEventId, PublishEvents, Metrics

PublishAndRetrieveUiEvents: Publish zero or more events, and return any new events since the given event id. The initial implementation is in-memory only; applies solely to the front-end web server; and anything older than 20 minutes is discarded

LatestKnownEventId
integer<int32>
PublishEvents
object[]
Metrics
object[]

Response

OK

EventId
integer<int32>

Id of event, increasing in chronological order, assigned by server

EventName
string

Name of event, for instance 'change' or 'edit'

EntityType
string

Name of entity, for instance 'ticket'

EntityKey
integer<int32>

Primary key of entity the event concerns

AssociateId
integer<int32>

The ID of the associate causing the event

AssociateName
string

The full person name of the associate causing the event

EventDateTime
string<date-time>

When did the event happen

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.