Skip to main content
Index

API Reference

 

 

 Name  Summary
Hierarchy
Get Location Hierarchy  Retrieve the corresponding location hierarchy of related assets in IBX SmartView. 
Get Power Hierarchy  Collect the corresponding power hierarchy of related assets in IBX SmartView.
 
Assets
Get Asset List  Obtain a list of assets in an asset category of an IBX for an account.
Get Asset Details  Procure the asset details and list of tag points in an asset category with an asset ID for an IBX of an account.
Get  Affected Locations for an Asset  Fetch the corresponding location hierarchy of related assets for an asset ID in an IBX of an account. 
Get Asset Search  Acquire all search results matching the search string query of a given asset ID.
Get Asset Tag Point  Retrieve the latest value of an asset tag point for an IBX of an account.
Get Asset Tag Point Trending  Gain the corresponding trending information of an asset tag point in an IBX of an account.
Post Asset Details  Returns the asset details and list of tag points for an asset in a category of an IBX in an account with a given asset ID.
Post Asset Tag Points  Returns the latest value of an asset tag point for an IBX of an account.
 
Alarm 
Get Active Alarms  Obtain all active alarms and returns a list with a count specifying the number of alarms for an account.
   
Power
Get Power Data  Fetch the current power consumption information for all level values in an IBX of an account.
Get Trending Power Data  Collect the trending power consumption data for an an asset. 
Post Power Data  Returns the power consumption data for all levels in an IBX of an account. 
 
Environmental (V1) 
Get Environmental Data for a Level  Acquire current environmental data for a single level value in an IBX of an account.
Get Environmental Data for a Level Type  Obtain a list of current environmental data for all level types in an IBX of an account.
Get Environmental Trending Data  Gain current environmental trending data for a single level in an IBX of an account. 
 
Environmental (V2) 
Get IBX Sensors Current Readings {ibx}  Procure current readings of all environmental sensors in an IBX.
Get Single Sensor Current Values {ibx} {sensorId}  Fetch the current environmental readings for a requested sensor ID in an IBX.
 
Subscription (V1) 
Get Subscriptions  View the near real-time stream subscription details of subscriptions for an organization.
Get Subscription by Id {subscriptionId}  See the near real-time stream subscription details of a specific subscription for an organization. 
Update Subscriptions  Update the near real-time feed of an existing subscription to add or remove events. 
Delete Subscriptions  Close and delete the near real-time stream of a subscription. 
 
Subscription (V2) 
Post Subscriptions  Define and create new streaming subscriptions for an organization.
Get Subscriptions  Collect the details of all streaming subscriptions for an organization. 
Get Subscriptions by ID  Retrieve the details of a specific streaming subscription for an organization. 
Update Subscriptions  Modify and update an existing streaming subscription for an organization. 
Delete Subscriptions  Delete and remove an existing streaming subscription for an organization.