Event filtering

You can filter events by using the where field within events on a query.

Filtering by event ID

You can filter events by their unique identifiers using the id field.

Retrieve single ID

To retrieve a single event with a specific id (for example, "pisrv.line1.pump101.event1"), use the eq (equals) operator.

To retrieve the event with the ID "pisrv.line1.pump101.event1":

where: { id: { eq: "pisrv.line1.pump101.event1" } }

Retrieve multiple IDs

To retrieve multiple events whose id matches any value in a list (such as "pisrv.line1.pump101.event1", "pisrv.line1.pump101.event2", and "pisrv.line1.pump101.event3"), use the in operator.

To retrieve events with the specified IDs:

where: { id: { in: ["pisrv.line1.pump101.event1", "pisrv.line1.pump101.event2", "pisrv.line1.pump101.event3"] } }

Filtering by standard fields

Events include standard fields such as name, duration, and createdDate. You can filter events based on these fields.

Name starts with

To retrieve events whose name starts with "pump":

where: { name: { startsWith: "pump" } }

Name ends with

To retrieve events whose name ends with "fl":

where: { name: { endsWith: "fl" } }

Created date after

To retrieve events created after January 1, 2024:

where: { createdDate: { gt: "2024-01-01T00:00:00Z" } }

Created date equals

To retrieve events created on March 15, 2024:

where: { createdDate: { eq: "2024-03-15T00:00:00Z" } }

Created by equals

To retrieve events created by user with ID "795df5a3-535f-45bc-baf7-5fb36abe32fd":

where: { createdBy: "795df5a3-535f-45bc-baf7-5fb36abe32fd" }

Modified date before

To retrieve events modified before June 1, 2024:

where: { modifiedDate: { lt: "2024-06-01T00:00:00Z" } }

Modified by equals

To retrieve events last modified by user id "795df5a3-535f-45bc-baf7-5fb36abe32fd":

where: { modifiedBy: "795df5a3-535f-45bc-baf7-5fb36abe32fd" }

TypeId equals

To retrieve events with typeId equals "Alarm":

where: { typeId: "Alarm" }

TypeName equals

To retrieve events with typeName equal to "Alarm Type Name":

where: { typeName: { eq: "Alarm Type Name" } }

TypeName not equal

To retrieve events with typeName not equal to "Alarm Type Name":

where: { typeName: { ne: "Alarm Type Name" } }

TypeName startsWith

To retrieve events with typeName starting with "Alarm":

where: { typeName: { startsWith: "Alarm" } }

TypeName endsWith

To retrieve events with typeName ending with "Name":

where: { typeName: { endsWith: "Name" } }

TypeName contains

To retrieve events with typeName containing "arm":

where: { typeName: { contains: "arm" } }

State ACTIVE

To retrieve events with an EventState ACTIVE:

where: { state: ACTIVE }

Start time on or after

To retrieve events with a start time on or after June 1, 2024:

where: { startTime: { ge: "2024-06-01T00:00:00Z" } }

End time before

To retrieve events with an end time before June 1, 2024:

where: { endTime: { lt: "2024-06-01T00:00:00Z" } }

Duration equals

To retrieve events with a duration equal to 4 minutes and 15 seconds:

where: { duration: { eq: "00:04:15" } }

Duration greater than

To retrieve events with a duration greater than 1 hour:

where: { duration: { gt: "01:00:00" } }

Active between

To retrieve events that are active at some point between June 1, 2024 and June 2, 2024:

where: {activeBetween: {startTime: "2024-06-01T00:00:00Z" endTime: "2024-06-02T00:00:00Z"}}

Parent relationship values

To retrieve events with a parent relationship with value "ParentEntity":

where: { parent: { values: "ParentEntity" } }

Data sources

To retrieve events with datasource DataSource1:

where: { dataSources: [ "DataSource1" ] }

Security tags in

To retrieve events with security tag securityTag1 or securityTag2:

where: { securityTags: { in: [ "securityTag1", "securityTag2" ] } }

Security tags eq

To retrieve events with security tag securityTag1:

where: { securityTags: { eq: "securityTag1" } }

Filtering by properties

Events may have additional properties. You can filter based on these properties to refine your results.

Manufacturer starts with

To retrieve events where at least one Manufacturer property starts with "Big pump company", use the startsWith operator:

where: { properties: [ { id: "Manufacturer", stringValue: { startsWith: "Big pump company" } } ] }

Manufacturer in

To retrieve events where at least one Manufacturer property starts with "Big pump company" or "Big sensor company", use the in operator:

where: { properties: [ { id: "Manufacturer", stringValue: { in: ["Big pump company", "Big sensor company"] } } ] }

Numeric property filtering

To retrieve events where a property (such as maxPressure) is greater than 200:

where: { properties: [ { id: "maxPressure", numberValue: { gt: 200 } } ] }

To retrieve events where a property (such as maxPressure) is 200 or 300:

where: { properties: [ { id: "maxPressure", numberValue: { in: [200, 300] } } ] }

DateTime property filtering

To retrieve events where a property (such as lastServiced) is after May 1, 2024:

where: { properties: [ { id: "lastServiced", dateTimeValue: { gt: "2024-05-01T00:00:00Z" } } ] }

To retrieve events where a property (such as lastServiced) is on May 1, 2024 or June 1, 2024:

where: { properties: [ { id: "lastServiced", dateTimeValue: { in: ["2024-05-01T00:00:00Z", "2024-06-01T00:00:00Z"] } } ] }

Boolean property filtering

To retrieve events where a property (such as isActive) is true, use one of these methods:

where: { properties: [ { id: "isActive", booleanValue: { eq: true } } ] }

where: { properties: [ { id: "isActive", booleanValue: { in: [true] } } ] }

TimeSpan property filtering

To retrieve events where a property (such as runTime) equals 1 hour:

where: { properties: [ { id: "runTime", timeSpanValue: { eq: "01:00:00" } } ] }

To retrieve events where a property (such as runTime) equals 1 hour or 2 hours:

where: { properties: [ { id: "runTime", timeSpanValue: { in: ["01:00:00", "02:00:00"] } } ] }

Enumeration property value filtering

To retrieve events where a property (such as status) equals enum value 2:

where: { properties: [ { id: "status", enumValue: { eq: 2 } } ] }

To retrieve events where a property (such as status) equals enum value 2 or 3:

where: { properties: [ { id: "status", enumValue: { in: [2, 3] } } ] }

Enumeration property string value filtering

To retrieve events where a property (such as status) with enumeration id status equals enum value Active:

where: { properties: [ { id: "status", enumStringValue: { enumerationSetId: "status", eq: "Active" } } ] }

To retrieve events where a property (such as status) with enumeration id status equals enum value Active or Closed:

where: { properties: [ { id: "status", enumValue: { enumerationSetId: "status", in: [ "Active", "Closed" ] } } ] }

Multiple properties

You can combine multiple property filters. To retrieve events where:

• The name starts with "HEPA-C".

• At least one class property starts with "process col".

• At least one installWeight property has a unit of measure (uom) of "kg" and a value greater than 100 with type code INT_32.

  where: {

  name: { startsWith: "HEPA-C" }

  properties: [

  { id: "class", stringValue: { startsWith: "process col" } }

  { id: "installWeight", numberValue: { gt: 100, uom: "kg" } }

  ]

  }

Property discovery

To retrieve events that have a property with the ID "Temperature":

where: { properties: [ { id: "Temperature" } ] }

Filtering by relationships

Events can be related to other events or streams. Filtering by relationships allows you to target events or streams based on these connections.

Entity relationship

To retrieve events that have a relationship with a specific entity (for example, "pisrv.line1.pump101.event1"):

where: { relationships: [ { values: ["pisrv.line1.pump101"], targetBase: ENTITY} ] }

Event relationship

To retrieve events that have a relationship with a specific event (for example, "pisrv.line1.pump101.event1"):

where: { relationships: [ { values: ["pisrv.line1.pump101.event2"], targetBase: EVENT } ] }

Stream relationship

To retrieve events that have a relationship with a specific stream (for example, "HEFAOutput001"):

where: { relationships: [ { values: ["HEFAOutput001"], targetBase: STREAM } ] }

Type relationship

To retrieve events that have a relationship with a specific type (for example, "pisrv.line1.pump101.type1"):

where: { relationships: [ { values: ["pisrv.line1.pump101.type1"], targetBase: TYPE } ] }

Relationship by type

To retrieve events that are children of a specific event:

where: { relationships: [ { values: ["parent-event-id"], targetBase: EVENT, relationshipType: CHILD } ] }