Qodex.ai

Query events

GET {{baseUrl}}/events?size=20&page=0&filter=<json>&sort=<json>&history=false&includeShared=false&enablePageCache=false

Returns events based on the request parameters. If no typeId is given in the filter expression then MindsphereStandardEvent typed events (and its descendants excluding descendant specific fields) will be returned.

\ Note: Clients must always expect incompleteness of the list of returned events, as internal processing is limited by eventual consistency.

Request Params

KeyDatatypeRequiredDescription
sizenumberSpecifies the number of elements in a page. Default is 20, minimum is 1 , maximum is 500.
pagenumberSpecifies the requested page index. Default is 0
filterstringdescription:
Filter parameter (JSON) encoded format. Events can be filtered by the following fields
  • timestamp
  • typeId
  • correlationId
  • entityId
  • code
  • severity
  • source
  • acknowledged
  • assetTypeId
  • parentAssetId
  • Other custom filters, based on filterable field in custom EventType can also be used.

Following conditions apply for filtering events,

  • If timestamp is not provided in the filter, the events from the 7 days will be filtered for by default.
  • The timestamp property can be filtered by before, after and between functions.
  • Multiple typeId expressions (by using and, or logical operators) in filter parameter is not allowed. Only equality function is supported on it.
  • Filtering with typeId having BaseEvent is not supported. If typeId is missing from filter expression then MindsphereStandardEvent typed (including) descendants - polymorphic query) events will be returned.
  • Negation of typeId in filter expression is not allowed.
  • If there are multiple events that have the same correlationId, entityId and typeId then only the latest one will be present in the returning list of events if history is false (false is default value).
  • Negation of assetTypeId in filter expression is not allowed.
  • Only equality and IN function (with max 5 values) in filter are allowed with assetTypeId.
  • Negation of 'parentAssetId' in filter expression is not allowed.
  • Only equality function in filter is allowed with parentAssetId. | | sort | string | | Order in which events are returned. Supported only on filterable fields. Default is timestamp descending order | | history | boolean | | Optional paramater, if we want to retrieve the history of an event which is based on using the same correlationID, entityID, typeID. If the latest event instance in a history of an event is deleted then the history of the event will be deleted. | | includeShared | boolean | | To specify if received event or eventTypes should be consider for the API operation. | | enablePageCache | boolean | | To specify if page caching is enabled or not. This property enables faster fetching of events from multiple pages for same filter criteria. |

HEADERS

KeyDatatypeRequiredDescription
If-None-MatchstringETag hash of previous request to allow caching
Acceptstring

RESPONSES

status: OK

{&quot;_embedded&quot;:{&quot;events&quot;:[{&quot;id&quot;:&quot;urn:uuid:d48fa919-ca2f-af45-9db5-f10ef55f884c&quot;,&quot;typeId&quot;:&quot;sit dolor Duis&quot;,&quot;correlationId&quot;:&quot;50ffd539-3f7b-0e67-505a-8afe306246ee&quot;,&quot;timestamp&quot;:&quot;quis nostrud ea&quot;,&quot;entityId&quot;:&quot;a3909fa6-98e4-2732-ed9c-b2bd769295a6&quot;,&quot;etag&quot;:-93404448,&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}},&quot;sharing&quot;:{&quot;modes&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}]},&quot;severity&quot;:49,&quot;description&quot;:&quot;do adipisicing non ut&quot;,&quot;code&quot;:&quot;ut&quot;,&quot;source&quot;:&quot;nostrud velit magna&quot;,&quot;acknowledged&quot;:true},{&quot;id&quot;:&quot;urn:uuid:3e21b369-74a3-f027-7cbe-9c715bb339a1&quot;,&quot;typeId&quot;:&quot;ex&quot;,&quot;correlationId&quot;:&quot;21536f85-ec40-d6f6-57c6-c8b37460b91b&quot;,&quot;timestamp&quot;:&quot;pariatur elit aliqua conseq&quot;,&quot;entityId&quot;:&quot;595526f7-6ff7-12cc-ec65-6cfacec25c5d&quot;,&quot;etag&quot;:-1326454,&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}}},&quot;sharing&quot;:{&quot;modes&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}]},&quot;severity&quot;:11,&quot;description&quot;:&quot;anim&quot;,&quot;code&quot;:&quot;ipsum es&quot;,&quot;source&quot;:&quot;reprehenderit ut aliquip&quot;,&quot;acknowledged&quot;:true}]},&quot;_links&quot;:{&quot;first&quot;:{&quot;href&quot;:&quot;http://VoHhARxLCuoPigGwXKuKCfZnDq.ayswn,hb0dWQQhgv&quot;},&quot;self&quot;:{&quot;href&quot;:&quot;https://SfTwqKJYB.sjpmHf&quot;,&quot;templated&quot;:true},&quot;next&quot;:{&quot;href&quot;:&quot;https://qxweCNcJneeWNG.ajfwtUKnPlyQ4c4t64vy,19izBjMmE7pFmMSKoL.-&quot;},&quot;prev&quot;:{&quot;href&quot;:&quot;http://prlGtLszuFCPsIzYDUStsHIZWc.ecnseYhGQLGlXHjKWb,5iczxR77.J.xuQ5SDyul8QuG0c,n&quot;},&quot;last&quot;:{&quot;href&quot;:&quot;http://jEHHWMVqyBisVwRZYy.muSJds,9qwUMWfVes,tc9xt.o2cS&quot;}},&quot;page&quot;:{&quot;size&quot;:16928505,&quot;totalElements&quot;:61473582,&quot;totalPages&quot;:26192063,&quot;number&quot;:-25228288}}