Let's imagine you want to animate a floor plan with instant presence information for every space. Something like:

Spaces can have a single multi sensor or several multi sensors depending on the size of a space.

Fortunately for you, the BOS computes automatically, per space, a synthesis of the most common values: the average temperature, the average CO2, the global presence...

Great, let's learn how to retrieve such information.

Retrieve all presence data points

We need to target only presence data points. It means:

• We need real-time information, then we should the endpoint v1/operate/points
• We're looking at presence meaning:
  • It's a State (see Linksper data models) → pointType=State
  • It's a Presence → dimension=Presence
  • It's a synthesis (not related to a specific equipment). We will be using the keywork "synthesis"
  • It's a space synthesis. We will be using the keyword "space"
• The v1/opeate/points takes a query as parameter.
  • The query uses a syntax called NEQL (Niagara Entity Query Language). It is based on the semantics
  • The query parameter will look like pointType='State' and dimension='Presence' and synthesis and space

GET {{base-api-url}}/v1/operate/points?query=pointType='State' and dimension='Presence' and synthesis and space

Let's see it in action:

This is a good beginning, but we don't know which space it is related to...

Let's use the additionalFields parameter to get this information:

GET {{base-api-url}}/v1/operate/points?query=pointType='State' and dimension='Presence' and synthesis and space&additionalFields=b:space&additionalFields=b:spaceId

And see the result: