docs.hyperviewhq.com
hyperviewhq.com
Authentication
AccessPolicies
get
Returns an array of access policies.
post
Saves an access policy.
get
Returns an individual access policy.
put
Updates a access policy.
del
Deletes a access policy.
get
Returns the access policy ID associated with an asset.
put
Updates an asset access policy and returns the updated asset access policy.
AccessPolicyGroups
get
Returns a list of user groups
get
Returns user groups that can be assigned to an access policy.
AlarmEvents
get
Returns a list of events for a specific asset.
post
Closes an active alarm event.
put
Acknowledge or unacknowledge an alarm event.
Ancestors
get
Returns a list of asset ancestors.
ApplicationEventLogs
get
Returns a list of application events.
AssetChangeEventLogs
get
Returns a list of asset events.
AssetProperties
get
Returns a list of all properties for an asset.
put
Updates the value of asset property and returns the updated property.
del
Deletes a single asset property.
post
Creates a new asset property and returns the new property.
Assets
get
Returns a list of assets.
post
Creates an asset and returns its ID.
get
Returns an individual asset.
put
Updates an asset and returns the updated asset.
del
Deletes an asset.
AssetsByType
get
Returns a list of assets for a specific asset type.
get
Returns a list of rack assets.
AssetTypeCount
get
Returns a list of asset type count.
AssetTypeDashboardSettings
get
Returns a dashboard setting for a specific asset type.
put
Updates a dashboard setting and returns the updated dashboard setting.
AvailablePowerSources
get
Returns available outlets for a given asset ID.
get
Returns available PDU breakers.
get
Returns available busway tap offs.
AvailableRackSpace
get
Returns available rack space
get
Returns an array of what space there is available in a rack to place a sensor.
BackgroundImages
get
Returns information for each layout background image as a list.
post
Uploads a layout background image and its descriptive data.
get
Returns background image.
del
Deletes a layout background image.
BacnetIpDefinitions
get
Returns a collection of BACnet/IP definitions.
post
Creates a BACnet/IP definition.
get
Returns a BACnet/IP definition.
del
Deletes a BACnet/IP definition.
put
Updates a BACnet/IP definition.
BacnetIpNonNumericSensors
get
Returns a collection of BACnet/IP non-numeric sensors.
post
Creates a BACnet/IP non-numeric sensor.
put
Updates a BACnet/IP non-numeric sensor.
del
Deletes a BACnet/IP non-numeric sensor.
BacnetIpNumericSensors
get
Returns a collection of BACnet/IP numeric sensors.
post
Creates a BACnet/IP numeric sensor.
put
Updates a BACnet/IP numeric sensor.
del
Deletes a BACnet/IP numeric sensor.
Bulk
post
Deletes a set of assets.
BuswayTapOff
get
Returns a list of busway tap offs.
post
Creates a new busway tap off.
del
Deletes a new busway tap off.
put
Updates a busway tap off.
ComponentAssets
get
Returns a list of component assets for a given parent asset.
get
Returns a list of virtual component assets for a given parent asset.
ContainedAssets
get
Returns a list of assets that are contained inside the given parent.
get
Returns a list of assets or placeholder assets that are contained inside the given parent.
get
Returns a list of assets or placeholder assets that are contained inside the given parent.
Control
post
Controls the electronic lock of a rack door.
ControlCredentialAssociation
post
Creates an association between an asset and a control credential.
del
Updates an association between an asset and a control credential.
put
Updates an association between an asset and a control credential.
get
Returns a control credential for an asset.
Credentials
get
Returns an array of protocol credentials.
post
Saves a Credential.
get
Returns an individual credential.
put
Updates a Credential.
del
Deletes a Credential.
CustomAssetProperties
get
Returns a list of all custom properties for an asset.
del
Deletes a single custom asset property.
put
Updates the value of custom asset property and returns the updated property.
post
Creates a new custom asset property value and returns the new custom property.
CustomComponents
get
Returns a list of custom components for a specific asset.
post
Creates a custom component and returns its ID.
get
Returns a list of asset property value strings.
put
Updates a custom component and returns the updated custom component.
del
Deletes a custom component.
CustomPropertyGroup
post
Creates a custom property group and returns its ID.
get
Get a list of custom property groups.
put
Update custom property group for group ID.
del
Deletes a single custom property group.
CustomPropertySetting
post
Creates a custom property setting and returns its ID.
get
Get a list of custom property settings.
put
Update custom property setting for setting ID.
del
Deletes a single custom property setting.
DataCollector
get
Retrieve a list of Data Collectors.
post
Retires a Data Collector and transfer responsibilities to an active Data Collector.
DataCollectorToken
post
Saves registration token to database.
Discoveries
get
Returns a collection of discovery settings.
post
Creates a discovery setting.
get
Returns a discovery setting.
put
Updates a discovery setting.
del
Deletes a discovery setting.
get
Returns an individual discovery schedule.
DiscoveryAssetHistories
get
Returns a collection of summaries about discovered assets for a given discovery history.
DiscoveryHistories
get
Returns a collection history of ran discoveries.