Discussions
How do we scope all API data by Building or Site? Need to understand hierarchy + filter these entities.
We are integrating with the Corrigo Enterprise REST API and need to scope our connector to specific buildings or sites. We want every API fetch to be limited to those buildings/sites.
We also need to understand the relationship/hierarchy between entities (e.g. Customer → Spaces → AssetTree → Location, and how Building fits in). A short meeting with your team would be very helpful to align on the right approach before we implement.
Entities we use and need to filter by building/site
In our integration, we currently call the Query API for these entities. We need to know how to filter each of them by building (or site) so that we only get data for the selected scope:
- Customer – we need to restrict to a given set of customers (sites).
- AssetTree – we need only assets that belong to the selected building(s)/site(s).
- Location – we need only locations (assets) that belong to the selected building(s)/site(s).
- Model – we request models for the locations we use; we need to ensure this stays scoped to the same building(s)/site(s).
- WorkOrder – we need only work orders for the selected building(s)/site(s).
We also use Employee, Specialty, WoPriority, WoActionLog, WorkOrderType, and Task (mainly to enrich work orders). If any of these can or should be scoped by building/site, we’d like to know.
What we need from you
- Hierarchy – How do Customer, Spaces, AssetTree, Location, WorkZone, and Building relate? Where does “building” sit (e.g. Location TypeId, level in AssetTree, or something else)?
- Filtering – For each of the entities above (Customer, AssetTree, Location, Model, WorkOrder), what is the supported way to filter by building or site (e.g. which property/query to use)?
- Building in our tenant – When we query Location with no filters, we see TypeIds like Regular, Community, Unit, RoomArea, but not Building. Does our tenant use a different structure for buildings, or should we get building-level data differently?
- Meeting – We would appreciate a short call or meeting to walk through the hierarchy and the recommended way to “filter everything by building” so we implement it correctly.
Thank you for your guidance.
