Hyperview API

docs.hyperviewhq.com
hyperviewhq.com

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