Hyperview API 4.0 (4.0)

Download OpenAPI specification:Download

AccessPolicies

Returns an array of access policies.

Authorizations:
oauth2
query Parameters
(after)
integer
Default: 0

Return records after the specified number of records.

(limit)
integer
Default: 25

Number of records to return.

(sort)
string
Default: "+Id"

Sort order. Format: "+|-fieldName".

(filter)
string

Cross field filter. Filters results that have the given value.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Saves an access policy.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

Access policy data.

id
string or null <uuid>
name
string or null
description
string or null
allowedUsers
Array of strings or null <uuid>
allowedGroups
Array of strings or null <uuid>
associatedAssetsCount
integer <int32>
associatedDocumentsCount
integer <int32>
associatedApiClientCount
integer <int32>
lastUpdated
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "allowedUsers": [
    ],
  • "allowedGroups": [
    ],
  • "associatedAssetsCount": 0,
  • "associatedDocumentsCount": 0,
  • "associatedApiClientCount": 0,
  • "lastUpdated": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Updates an access policy.

Authorizations:
oauth2
path Parameters
accessPolicyId
required
string <uuid>

An access policy ID.

header Parameters
api-version
string
Request Body schema: application/json

Access policy data.

id
string or null <uuid>
name
string or null
description
string or null
allowedUsers
Array of strings or null <uuid>
allowedGroups
Array of strings or null <uuid>
associatedAssetsCount
integer <int32>
associatedDocumentsCount
integer <int32>
associatedApiClientCount
integer <int32>
lastUpdated
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "allowedUsers": [
    ],
  • "allowedGroups": [
    ],
  • "associatedAssetsCount": 0,
  • "associatedDocumentsCount": 0,
  • "associatedApiClientCount": 0,
  • "lastUpdated": "2019-08-24T14:15:22Z"
}

Deletes a access policy.

Authorizations:
oauth2
path Parameters
accessPolicyId
required
string <uuid>

An access policy ID.

header Parameters
api-version
string

Responses

Returns the access policy ID associated with an asset.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Updates an asset access policy and returns the updated asset access policy.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string
Request Body schema: application/json

An access policy ID.

string <uuid>

Responses

Request samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7"
}

AccessPolicyGroups

Returns a list of user groups

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns user groups that can be assigned to an access policy.

Authorizations:
oauth2
path Parameters
accessPolicyId
required
string <uuid>

An access policy ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AlarmEventPolicies

Creates an alarm event policy and returns its ID.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

Alarm event policy data.

id
string or null <uuid>
name
string or null
assetId
string <uuid>
severity
string (AlarmEventPolicySeverityFilter)
Enum: "all" "warningEqualHigher" "critical"
users
Array of strings or null <uuid>
groups
Array of strings or null <uuid>
notificationChannels
Array of strings or null <uuid>
filteredAssetTypeIds
Array of strings or null (AssetTypeEnum)
Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "severity": "all",
  • "users": [
    ],
  • "groups": [
    ],
  • "notificationChannels": [
    ],
  • "filteredAssetTypeIds": [
    ]
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Returns an array of alarm event policies.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an alarm event policy.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An alarm event policy ID.

header Parameters
api-version
string
Request Body schema: application/json

Alarm event policy data.

id
string or null <uuid>
name
string or null
assetId
string <uuid>
severity
string (AlarmEventPolicySeverityFilter)
Enum: "all" "warningEqualHigher" "critical"
users
Array of strings or null <uuid>
groups
Array of strings or null <uuid>
notificationChannels
Array of strings or null <uuid>
filteredAssetTypeIds
Array of strings or null (AssetTypeEnum)
Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "severity": "all",
  • "users": [
    ],
  • "groups": [
    ],
  • "notificationChannels": [
    ],
  • "filteredAssetTypeIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "severity": "all",
  • "users": [
    ],
  • "groups": [
    ],
  • "notificationChannels": [
    ],
  • "filteredAssetTypeIds": [
    ]
}

Deletes an alarm event policy.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An alarm event policy ID.

header Parameters
api-version
string

Responses

AlarmEvents

Closes an active alarm event.

Authorizations:
oauth2
path Parameters
alarmEventId
required
string <uuid>

An alarm event's ID.

header Parameters
api-version
string

Responses

Closes active alarm events.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json
required

a list of alarm event IDs.

Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Acknowledge or unacknowledge an alarm event.

Authorizations:
oauth2
path Parameters
alarmEventId
required
string <uuid>

An alarm event's ID.

header Parameters
api-version
string
Request Body schema: application/json

A new acknowledgement state for alarm event.

string (AcknowledgementState)
Enum: "unacknowledged" "acknowledged"

Responses

Request samples

Content type
application/json
"unacknowledged"

Acknowledge or unacknowledge a list of alarm events.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the list of alarm event IDs and a new AcknowledgementState.

alarmEventIds
Array of strings or null <uuid>
acknowledgementState
string (AcknowledgementState)
Enum: "unacknowledged" "acknowledged"

Responses

Request samples

Content type
application/json
{
  • "alarmEventIds": [
    ],
  • "acknowledgementState": "unacknowledged"
}

Ancestors

Returns a list of asset ancestors.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ApplicationEventLogs

Returns a list of application events.

Authorizations:
oauth2
query Parameters
(after)
integer
Default: 0

Return records after the specified number of records.

(limit)
integer
Default: 25

Number of records to return.

(sort)
string
Default: "+Id"

Sort order. Format: "+|-fieldName".

(filter)
string

Cross field filter. Filters results that have the given value.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AssetChangeEventLogs

Returns a list of asset events.

Authorizations:
oauth2
query Parameters
assetId
string <uuid>

An asset ID.

(after)
integer
Default: 0

Return records after the specified number of records.

(limit)
integer
Default: 25

Number of records to return.

(sort)
string
Default: "+Id"

Sort order. Format: "+|-fieldName".

(filter)
string

Cross field filter. Filters results that have the given value.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AssetDashboardSettings

Returns a dashboard setting for a specific asset.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "assetTypeId": "unknown",
  • "assetDashboardOverrideSetting": null,
  • "defaultDashboardSetting": null,
  • "assetTypeDashboardOverrideSetting": null,
  • "chartWidgetSettings": [
    ]
}

Saves asset dashboard setting and returns the updated asset dashboard setting.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string
Request Body schema:

An asset dashboard setting.

assetId
string <uuid>
assetDashboardOverrideSetting
any or null

Responses

Request samples

Content type
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "assetDashboardOverrideSetting": null
}

Response samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "assetDashboardOverrideSetting": null
}

Deletes an asset dashboard setting.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

AssetFirmware

Update assets to a firmware version.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing a new firmware version ID and a list of assets to update.

newFirmwareVersionId
string <uuid>
assetIds
Array of strings or null <uuid>
workOrderName
string or null

Responses

Request samples

Content type
application/json
{
  • "newFirmwareVersionId": "19c4e818-3ac0-4399-abb6-ecd2a7a17f5c",
  • "assetIds": [
    ],
  • "workOrderName": "string"
}

AssetProperties

Returns a list of all properties for an asset.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates the value of asset property and returns the updated property.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

ID of the asset property to be updated.

header Parameters
api-version
string
Request Body schema: application/json

The asset property to be updated.

id
string or null <uuid>
type
string (AssetPropertyKeyEnum)
Enum: "buswayTapOffNumber" "serialNumber" "ipAddressValue" "macAddress" "costPerRack" "locationType" "desiredRackTemperature" "contactName" "emailAddress" "phoneNumberOne" "phoneNumberTwo" "costPerKiloWattHour" "designValue" "rackDesign" "assetTag" "width" "height" "depth" "weight" "consumedRackUnits" "providedRackUnits" "ratedPower" "description" "guid" "manufacturer" "model" "name" "objectId" "outletNumber" "contact" "componentManufacturer" "componentModel" "internalDeviceId" "technology" "size" "operationalStatus" "listIndex" "networkInterfaceIndex" "highSpeed" "designatedRoot" "designatedBridge" "designatedPort" "speed" "nicHostSystemId" "isNicPartOfADeviceChain" "hostName" "currentClockSpeed" "maxClockSpeed" "enabledCoresCount" "processorFamily" "powerManagementSupported" "gatewayIpAddress" "ipAddressEnabled" "isBmcIpAddress" "applicationId" "applicationVersion" "applicationCaption" "installDate" "physicalStorageType" "blockSize" "blockCount" "buildNumber" "buildType" "operatingSystemVersion" "operatingSystemMajorVersion" "operatingSystemMinorVersion" "architecture" "pduBreakerRating" "outletPhase" "outletBank" "hardwareVersion" "firmwareVersion" "dnsHostName" "domain" "domainRole" "powerSaverMode" "deviceChainId" "totalOutlets" "numberOfPhases" "ratedInputVoltage" "panelBreakerRating" "breakerCount" "breakersPerPanel" "panelCount" "ratedCurrent" "ratedVoltage" "powerFactor" "ratedVa" "memoryTotalWidth" "portNumber" "commissionDate" "endOfLifeDate" "retirementDate" "boardSerialNumber" "memoryType" "streetAddress" "presence" "internalStatus" "bladeBmcMacAddress" "operatingSystemPlatformId" "operatingSystemSignature" "operatingSystemVendor" "operatingSystemServicePackMajorVersion" "operatingSystemServicePackMinorVersion" "operatingSystemEditionId" "toolsStatus" "linkState" "captureState" "simulatedCableState" "numberOfPoles" "breakerNumber" "panelNumber" "defaultMainPanelBreakerSize" "defaultBreakerSize" "latitude" "longitude" "controllerSerialNumber" "powerModuleSerialNumber" "fanSerialNumber" "assetPlacementDescription" "outletType" "locationDescription" "note" "snmpVersion" "rackTotalPowerSetting" "bayLocation" "itEnergySetting" "breakerStatus" "enclosureSerialNumber" "macOuiManufacturer" "assetTrackerTagSerialNumber" "assetTrackerModuleSerialNumber" "assetTrackerExpectedReportedRackUnits" "assetTrackerRackOffset" "rackDeltaTCalculationOrientation" "mediaType" "physicalConnectorType" "length" "portType" "portSide" "circuitType" "circuitProvisioningStatus" "smartViewLocationType" "smartViewLevelValue" "smartViewAccountNumber" "smartViewIbx" "locationAverageTemperatureSetting" "locationAverageHumiditySetting" "webPortalLaunchUrl" "biosVersion" "powerSupplyOutputRating" "powerSupplyInputRating" "powerSupplyType" "snmpPort" "businessEntityType" "streetAddressType"
value
any or null
dataType
string (PropertyValueType)
Enum: "string" "integer" "decimal" "dateTime" "enum" "ipAddress" "macAddress" "boolean" "base" "guid" "long"
dataSource
string (DataSource)
Enum: "application" "ribcl" "ipmi" "snmp" "ssh" "ucs" "vmware" "wbem" "wmi" "bacnetIp" "modbusTcp" "basicHttpAndHttps" "ntp" "tcp" "rimp" "arp" "racadm" "user" "dns" "ixos" "smartView"
assetPropertyDisplayCategory
string or null
isEditable
boolean
isInherited
boolean
createdDateTime
string or null <date-time>
updatedDateTime
string or null <date-time>
minimumValue
number or null <double>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "buswayTapOffNumber",
  • "value": null,
  • "dataType": "string",
  • "dataSource": "application",
  • "assetPropertyDisplayCategory": "string",
  • "isEditable": true,
  • "isInherited": true,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "updatedDateTime": "2019-08-24T14:15:22Z",
  • "minimumValue": 0.1
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "buswayTapOffNumber",
  • "value": null,
  • "dataType": "string",
  • "dataSource": "application",
  • "assetPropertyDisplayCategory": "string",
  • "isEditable": true,
  • "isInherited": true,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "updatedDateTime": "2019-08-24T14:15:22Z",
  • "minimumValue": 0.1
}

Deletes a single asset property.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

ID of the asset property.

header Parameters
api-version
string

Responses

Creates a new asset property and returns the new property.

Authorizations:
oauth2
query Parameters
assetId
string <uuid>

ID of the asset which owns this property.

header Parameters
api-version
string
Request Body schema: application/json

The asset property to be created.

id
string or null <uuid>
type
string (AssetPropertyKeyEnum)
Enum: "buswayTapOffNumber" "serialNumber" "ipAddressValue" "macAddress" "costPerRack" "locationType" "desiredRackTemperature" "contactName" "emailAddress" "phoneNumberOne" "phoneNumberTwo" "costPerKiloWattHour" "designValue" "rackDesign" "assetTag" "width" "height" "depth" "weight" "consumedRackUnits" "providedRackUnits" "ratedPower" "description" "guid" "manufacturer" "model" "name" "objectId" "outletNumber" "contact" "componentManufacturer" "componentModel" "internalDeviceId" "technology" "size" "operationalStatus" "listIndex" "networkInterfaceIndex" "highSpeed" "designatedRoot" "designatedBridge" "designatedPort" "speed" "nicHostSystemId" "isNicPartOfADeviceChain" "hostName" "currentClockSpeed" "maxClockSpeed" "enabledCoresCount" "processorFamily" "powerManagementSupported" "gatewayIpAddress" "ipAddressEnabled" "isBmcIpAddress" "applicationId" "applicationVersion" "applicationCaption" "installDate" "physicalStorageType" "blockSize" "blockCount" "buildNumber" "buildType" "operatingSystemVersion" "operatingSystemMajorVersion" "operatingSystemMinorVersion" "architecture" "pduBreakerRating" "outletPhase" "outletBank" "hardwareVersion" "firmwareVersion" "dnsHostName" "domain" "domainRole" "powerSaverMode" "deviceChainId" "totalOutlets" "numberOfPhases" "ratedInputVoltage" "panelBreakerRating" "breakerCount" "breakersPerPanel" "panelCount" "ratedCurrent" "ratedVoltage" "powerFactor" "ratedVa" "memoryTotalWidth" "portNumber" "commissionDate" "endOfLifeDate" "retirementDate" "boardSerialNumber" "memoryType" "streetAddress" "presence" "internalStatus" "bladeBmcMacAddress" "operatingSystemPlatformId" "operatingSystemSignature" "operatingSystemVendor" "operatingSystemServicePackMajorVersion" "operatingSystemServicePackMinorVersion" "operatingSystemEditionId" "toolsStatus" "linkState" "captureState" "simulatedCableState" "numberOfPoles" "breakerNumber" "panelNumber" "defaultMainPanelBreakerSize" "defaultBreakerSize" "latitude" "longitude" "controllerSerialNumber" "powerModuleSerialNumber" "fanSerialNumber" "assetPlacementDescription" "outletType" "locationDescription" "note" "snmpVersion" "rackTotalPowerSetting" "bayLocation" "itEnergySetting" "breakerStatus" "enclosureSerialNumber" "macOuiManufacturer" "assetTrackerTagSerialNumber" "assetTrackerModuleSerialNumber" "assetTrackerExpectedReportedRackUnits" "assetTrackerRackOffset" "rackDeltaTCalculationOrientation" "mediaType" "physicalConnectorType" "length" "portType" "portSide" "circuitType" "circuitProvisioningStatus" "smartViewLocationType" "smartViewLevelValue" "smartViewAccountNumber" "smartViewIbx" "locationAverageTemperatureSetting" "locationAverageHumiditySetting" "webPortalLaunchUrl" "biosVersion" "powerSupplyOutputRating" "powerSupplyInputRating" "powerSupplyType" "snmpPort" "businessEntityType" "streetAddressType"
value
any or null
dataType
string (PropertyValueType)
Enum: "string" "integer" "decimal" "dateTime" "enum" "ipAddress" "macAddress" "boolean" "base" "guid" "long"
dataSource
string (DataSource)
Enum: "application" "ribcl" "ipmi" "snmp" "ssh" "ucs" "vmware" "wbem" "wmi" "bacnetIp" "modbusTcp" "basicHttpAndHttps" "ntp" "tcp" "rimp" "arp" "racadm" "user" "dns" "ixos" "smartView"
assetPropertyDisplayCategory
string or null
isEditable
boolean
isInherited
boolean
createdDateTime
string or null <date-time>
updatedDateTime
string or null <date-time>
minimumValue
number or null <double>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "buswayTapOffNumber",
  • "value": null,
  • "dataType": "string",
  • "dataSource": "application",
  • "assetPropertyDisplayCategory": "string",
  • "isEditable": true,
  • "isInherited": true,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "updatedDateTime": "2019-08-24T14:15:22Z",
  • "minimumValue": 0.1
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "buswayTapOffNumber",
  • "value": null,
  • "dataType": "string",
  • "dataSource": "application",
  • "assetPropertyDisplayCategory": "string",
  • "isEditable": true,
  • "isInherited": true,
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "updatedDateTime": "2019-08-24T14:15:22Z",
  • "minimumValue": 0.1
}

AssetPropertyKeys

Returns a list of asset property keys.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AssetPropertyValues

Retrieves an ordered list of all string values for the provided asset property key.

Authorizations:
oauth2
path Parameters
assetPropertyKey
required
string (AssetPropertyKeyEnum)
Enum: "buswayTapOffNumber" "serialNumber" "ipAddressValue" "macAddress" "costPerRack" "locationType" "desiredRackTemperature" "contactName" "emailAddress" "phoneNumberOne" "phoneNumberTwo" "costPerKiloWattHour" "designValue" "rackDesign" "assetTag" "width" "height" "depth" "weight" "consumedRackUnits" "providedRackUnits" "ratedPower" "description" "guid" "manufacturer" "model" "name" "objectId" "outletNumber" "contact" "componentManufacturer" "componentModel" "internalDeviceId" "technology" "size" "operationalStatus" "listIndex" "networkInterfaceIndex" "highSpeed" "designatedRoot" "designatedBridge" "designatedPort" "speed" "nicHostSystemId" "isNicPartOfADeviceChain" "hostName" "currentClockSpeed" "maxClockSpeed" "enabledCoresCount" "processorFamily" "powerManagementSupported" "gatewayIpAddress" "ipAddressEnabled" "isBmcIpAddress" "applicationId" "applicationVersion" "applicationCaption" "installDate" "physicalStorageType" "blockSize" "blockCount" "buildNumber" "buildType" "operatingSystemVersion" "operatingSystemMajorVersion" "operatingSystemMinorVersion" "architecture" "pduBreakerRating" "outletPhase" "outletBank" "hardwareVersion" "firmwareVersion" "dnsHostName" "domain" "domainRole" "powerSaverMode" "deviceChainId" "totalOutlets" "numberOfPhases" "ratedInputVoltage" "panelBreakerRating" "breakerCount" "breakersPerPanel" "panelCount" "ratedCurrent" "ratedVoltage" "powerFactor" "ratedVa" "memoryTotalWidth" "portNumber" "commissionDate" "endOfLifeDate" "retirementDate" "boardSerialNumber" "memoryType" "streetAddress" "presence" "internalStatus" "bladeBmcMacAddress" "operatingSystemPlatformId" "operatingSystemSignature" "operatingSystemVendor" "operatingSystemServicePackMajorVersion" "operatingSystemServicePackMinorVersion" "operatingSystemEditionId" "toolsStatus" "linkState" "captureState" "simulatedCableState" "numberOfPoles" "breakerNumber" "panelNumber" "defaultMainPanelBreakerSize" "defaultBreakerSize" "latitude" "longitude" "controllerSerialNumber" "powerModuleSerialNumber" "fanSerialNumber" "assetPlacementDescription" "outletType" "locationDescription" "note" "snmpVersion" "rackTotalPowerSetting" "bayLocation" "itEnergySetting" "breakerStatus" "enclosureSerialNumber" "macOuiManufacturer" "assetTrackerTagSerialNumber" "assetTrackerModuleSerialNumber" "assetTrackerExpectedReportedRackUnits" "assetTrackerRackOffset" "rackDeltaTCalculationOrientation" "mediaType" "physicalConnectorType" "length" "portType" "portSide" "circuitType" "circuitProvisioningStatus" "smartViewLocationType" "smartViewLevelValue" "smartViewAccountNumber" "smartViewIbx" "locationAverageTemperatureSetting" "locationAverageHumiditySetting" "webPortalLaunchUrl" "biosVersion" "powerSupplyOutputRating" "powerSupplyInputRating" "powerSupplyType" "snmpPort" "businessEntityType" "streetAddressType"

A asset property key.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

AssetTrackerContainedAssets

Returns a list of AssetTracker assets or placeholder assets that are contained inside the given AssetTracker parent.

Authorizations:
oauth2
query Parameters
parentId
string <uuid>

A parent asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AssetTrackerMasterModuleData

Retrieves all AssetTracker master module data.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes an AssetTracker master module data.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>
header Parameters
api-version
string

Responses

AssetTree

Returns information about a particular asset for rendering it inside a tree view on the application client.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "assetTypeId": "unknown",
  • "displayName": "string",
  • "tabDelimitedPath": "string",
  • "ancestorIds": [
    ],
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7"
}

AssetTypeCount

Returns a list of asset type count.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AssetTypeDashboardSettings

Updates an asset type dashboard override setting and returns the updated dashboard override setting.

Authorizations:
oauth2
path Parameters
assetType
required
string (AssetTypeEnum)
Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"

An asset type.

header Parameters
api-version
string
Request Body schema:

A asset type dashboard override setting.

assetTypeId
string (AssetTypeEnum)
Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"
assetTypeDashboardOverrideSetting
any or null

Responses

Request samples

Content type
{
  • "assetTypeId": "unknown",
  • "assetTypeDashboardOverrideSetting": null
}

Response samples

Content type
application/json
{
  • "assetTypeId": "unknown",
  • "assetTypeDashboardOverrideSetting": null
}

Deletes an asset type dashboard override setting.

Authorizations:
oauth2
path Parameters
assetType
required
string (AssetTypeEnum)
Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"

An asset type.

header Parameters
api-version
string

Responses

Assets

Returns a list of assets.

Authorizations:
oauth2
query Parameters
assetType
Array of strings (AssetTypeEnum)
Items Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"

An optional list of asset types to filter what assets are returned.

includeDimensions
boolean
Default: false

An optional flag for including dimensional properties.

(after)
integer
Default: 0

Return records after the specified number of records.

(limit)
integer
Default: 25

Number of records to return.

(sort)
string
Default: "+Id"

Sort order. Format: "+|-fieldName".

(filter)
string

Cross field filter. Filters results that have the given value.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an asset and returns its ID.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An asset object.

id
string or null <uuid>
name
string or null
status
string (Status)
Enum: "normal" "warning" "critical"
assetTypeId
string (AssetTypeEnum)
Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"
assetTypeCategory
string (AssetTypeCategory)
Enum: "device" "rack" "container" "component" "virtualComponent" "rackAddOnContainer" "networkComponent" "physicalNetwork" "physicalNetworkComponent" "businessEntityCategory" "businessEntityComponent"
parentId
string or null <uuid>
parentName
string or null
productId
string or null <uuid>
productName
string or null
manufacturerId
string or null <uuid>
manufacturerName
string or null
object (DimensionDto)
assetLifecycleState
string (AssetLifecycleState)
Enum: "active" "planned" "procurement" "staging" "retired" "inventory"
discoveryState
string (DiscoveryState)
Enum: "manuallyCreated" "discovered" "applicationCreated"
monitoringState
string (MonitoringState)
Enum: "off" "on"
sensorMonitoringProfileType
string (SensorMonitoringProfileType)
Enum: "discovered" "manualOnly" "bacnetIp" "modbusTcp"
hasChildren
boolean
object (LocationDataDto)
baseInformationLastUpdated
string <date-time>
accessState
string (AccessState)
Enum: "full" "ancestorPlaceholder" "containedAssetPlaceholder" "floorPlanLayoutAssetPlaceholder" "powerPathAssetPlaceholder" "consumingPowerAssetPlaceholder" "sensorIndirectParentPlaceholder" "workOrderAssetStatusPlaceholder" "connectionAssetPlaceholder" "connectionTerminationAssetPlaceholder" "circuitSideAssetPlaceholder" "businessEntityAssetPlaceHolder"
tabDelimitedPath
string or null
accessPolicyId
string <uuid>
businessEntityId
string or null <uuid>
businessEntityDisplayName
string or null
businessEntityAccessState
string (AccessState)
Enum: "full" "ancestorPlaceholder" "containedAssetPlaceholder" "floorPlanLayoutAssetPlaceholder" "powerPathAssetPlaceholder" "consumingPowerAssetPlaceholder" "sensorIndirectParentPlaceholder" "workOrderAssetStatusPlaceholder" "connectionAssetPlaceholder" "connectionTerminationAssetPlaceholder" "circuitSideAssetPlaceholder" "businessEntityAssetPlaceHolder"
Array of objects or null (CreatableAssetPropertyDto)
Array of objects or null (AssetCreationGenericDataDto)
object (SensorMonitoringProfileDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "normal",
  • "assetTypeId": "unknown",
  • "assetTypeCategory": "device",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "parentName": "string",
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "productName": "string",
  • "manufacturerId": "9ffb4bad-5601-46bd-b5e1-ad29632f5942",
  • "manufacturerName": "string",
  • "dimension": {
    },
  • "assetLifecycleState": "active",
  • "discoveryState": "manuallyCreated",
  • "monitoringState": "off",
  • "sensorMonitoringProfileType": "discovered",
  • "hasChildren": true,
  • "locationData": {
    },
  • "baseInformationLastUpdated": "2019-08-24T14:15:22Z",
  • "accessState": "full",
  • "tabDelimitedPath": "string",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8",
  • "businessEntityDisplayName": "string",
  • "businessEntityAccessState": "full",
  • "creatableAssetProperties": [
    ],
  • "assetCreationGenericDataCollection": [
    ],
  • "sensorMonitoringProfile": {
    }
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Returns an individual asset.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "normal",
  • "assetTypeId": "unknown",
  • "assetTypeCategory": "device",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "parentName": "string",
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "productName": "string",
  • "manufacturerId": "9ffb4bad-5601-46bd-b5e1-ad29632f5942",
  • "manufacturerName": "string",
  • "dimension": {
    },
  • "assetLifecycleState": "active",
  • "discoveryState": "manuallyCreated",
  • "monitoringState": "off",
  • "sensorMonitoringProfileType": "discovered",
  • "hasChildren": true,
  • "locationData": {
    },
  • "baseInformationLastUpdated": "2019-08-24T14:15:22Z",
  • "accessState": "full",
  • "tabDelimitedPath": "string",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8",
  • "businessEntityDisplayName": "string",
  • "businessEntityAccessState": "full"
}

Updates an asset and returns the updated asset.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

header Parameters
api-version
string
Request Body schema: application/json

An asset object. Must contain Id, Name, ParentId, ProductId, AssetLifecycleState

id
string or null <uuid>
name
string or null
status
string (Status)
Enum: "normal" "warning" "critical"
assetTypeId
string (AssetTypeEnum)
Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"
assetTypeCategory
string (AssetTypeCategory)
Enum: "device" "rack" "container" "component" "virtualComponent" "rackAddOnContainer" "networkComponent" "physicalNetwork" "physicalNetworkComponent" "businessEntityCategory" "businessEntityComponent"
parentId
string or null <uuid>
parentName
string or null
productId
string or null <uuid>
productName
string or null
manufacturerId
string or null <uuid>
manufacturerName
string or null
object (DimensionDto)
assetLifecycleState
string (AssetLifecycleState)
Enum: "active" "planned" "procurement" "staging" "retired" "inventory"
discoveryState
string (DiscoveryState)
Enum: "manuallyCreated" "discovered" "applicationCreated"
monitoringState
string (MonitoringState)
Enum: "off" "on"
sensorMonitoringProfileType
string (SensorMonitoringProfileType)
Enum: "discovered" "manualOnly" "bacnetIp" "modbusTcp"
hasChildren
boolean
object (LocationDataDto)
baseInformationLastUpdated
string <date-time>
accessState
string (AccessState)
Enum: "full" "ancestorPlaceholder" "containedAssetPlaceholder" "floorPlanLayoutAssetPlaceholder" "powerPathAssetPlaceholder" "consumingPowerAssetPlaceholder" "sensorIndirectParentPlaceholder" "workOrderAssetStatusPlaceholder" "connectionAssetPlaceholder" "connectionTerminationAssetPlaceholder" "circuitSideAssetPlaceholder" "businessEntityAssetPlaceHolder"
tabDelimitedPath
string or null
accessPolicyId
string <uuid>
businessEntityId
string or null <uuid>
businessEntityDisplayName
string or null
businessEntityAccessState
string (AccessState)
Enum: "full" "ancestorPlaceholder" "containedAssetPlaceholder" "floorPlanLayoutAssetPlaceholder" "powerPathAssetPlaceholder" "consumingPowerAssetPlaceholder" "sensorIndirectParentPlaceholder" "workOrderAssetStatusPlaceholder" "connectionAssetPlaceholder" "connectionTerminationAssetPlaceholder" "circuitSideAssetPlaceholder" "businessEntityAssetPlaceHolder"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "normal",
  • "assetTypeId": "unknown",
  • "assetTypeCategory": "device",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "parentName": "string",
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "productName": "string",
  • "manufacturerId": "9ffb4bad-5601-46bd-b5e1-ad29632f5942",
  • "manufacturerName": "string",
  • "dimension": {
    },
  • "assetLifecycleState": "active",
  • "discoveryState": "manuallyCreated",
  • "monitoringState": "off",
  • "sensorMonitoringProfileType": "discovered",
  • "hasChildren": true,
  • "locationData": {
    },
  • "baseInformationLastUpdated": "2019-08-24T14:15:22Z",
  • "accessState": "full",
  • "tabDelimitedPath": "string",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8",
  • "businessEntityDisplayName": "string",
  • "businessEntityAccessState": "full"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "status": "normal",
  • "assetTypeId": "unknown",
  • "assetTypeCategory": "device",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "parentName": "string",
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "productName": "string",
  • "manufacturerId": "9ffb4bad-5601-46bd-b5e1-ad29632f5942",
  • "manufacturerName": "string",
  • "dimension": {
    },
  • "assetLifecycleState": "active",
  • "discoveryState": "manuallyCreated",
  • "monitoringState": "off",
  • "sensorMonitoringProfileType": "discovered",
  • "hasChildren": true,
  • "locationData": {
    },
  • "baseInformationLastUpdated": "2019-08-24T14:15:22Z",
  • "accessState": "full",
  • "tabDelimitedPath": "string",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8",
  • "businessEntityDisplayName": "string",
  • "businessEntityAccessState": "full"
}

Deletes an asset.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

AvailableFirmwareVersions

Returns a list of all firmware versions available for the given asset.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AvailablePowerSources

Returns available outlets for a given asset ID.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns available PDU breakers.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns available busway tap offs.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AvailableRackSpace

Returns available rack space

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A rack id.

query Parameters
assetId
string <uuid>

An asset ID to ignore if it is in the given rack.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns an array of what space there is available in a rack to place a sensor.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A rack id.

sensorId
required
string <uuid>

A sensor id.

query Parameters
rackSide
required
string (RackSide)
Enum: "unknown" "front" "rear"

A flag to indicate which side of the rack to get grab sensors from.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

BackgroundImages

Returns information for each layout background image as a list.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Uploads a layout background image and its descriptive data.

Authorizations:
oauth2
query Parameters
layoutBackgroundImageName
string

Name for a image file.

header Parameters
api-version
string
Request Body schema: multipart/form-data
uploadedFile
string <binary>

Responses

Response samples

Content type
No sample

Returns background image.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A layout background image ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
"string"

Deletes a layout background image.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A layout background image ID.

header Parameters
api-version
string

Responses

BacnetIpDefinitions

Returns a collection of BACnet/IP definitions.

Authorizations:
oauth2
query Parameters
assetType
string (AssetTypeEnum)
Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"

An optional asset type to filter the results.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a BACnet/IP definition.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

A BACnet/IP definition.

id
string or null <uuid>
assetType
string (AssetTypeEnum)
Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"
name
string or null
associatedAssets
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "assetType": "unknown",
  • "name": "string",
  • "associatedAssets": 0
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Returns a BACnet/IP definition.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "assetType": "unknown",
  • "name": "string",
  • "associatedAssets": 0
}

Deletes a BACnet/IP definition.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

header Parameters
api-version
string

Responses

Updates a BACnet/IP definition.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

header Parameters
api-version
string
Request Body schema: application/json

A BACnet/IP definition.

id
string or null <uuid>
assetType
string (AssetTypeEnum)
Enum: "unknown" "location" "server" "rack" "rackPdu" "bladeEnclosure" "ups" "networkStorage" "transferSwitch" "bladeServer" "smallUps" "powerMeter" "camera" "busway" "chiller" "crac" "crah" "environmental" "fireControlPanel" "generator" "inRowCooling" "kvmSwitch" "bladeStorage" "monitor" "networkDevice" "otherDevice" "patchPanel" "pduAndRpp" "bladeNetwork" "utilityBreaker" "virtualServer" "processor" "memory" "pduRppBreaker" "nic" "operatingSystem" "powerSupply" "physicalStorage" "ipAddress" "application" "outlet" "rackShelf" "cable" "transceiver" "buswayTapOff" "nodeServer" "lineCardSwitchModule" "physicalConnection" "physicalPort" "circuit" "tapeDrive" "businessEntity" "businessEntityAddress" "businessEntityContact"
name
string or null
associatedAssets
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "assetType": "unknown",
  • "name": "string",
  • "associatedAssets": 0
}

BacnetIpNonNumericSensors

Returns a collection of BACnet/IP non-numeric sensors.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a BACnet/IP non-numeric sensor.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

header Parameters
api-version
string
Request Body schema: application/json

A BACnet/IP non-numeric sensor.

id
string or null <uuid>
objectInstance
integer <int32>
objectType
string (BacnetIpObjectType)
Enum: "analogValue" "analogInput" "binaryValue" "binaryInput" "multiStateInput"
sensorTypeId
string <uuid>
sensorType
string or null
name
string or null
Array of objects or null (ValueMappingDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "objectInstance": 0,
  • "objectType": "analogValue",
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "string",
  • "name": "string",
  • "valueMapping": [
    ]
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Updates a BACnet/IP non-numeric sensor.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

bacnetIpNonNumericSensorId
required
string <uuid>

A BACnet/IP definition non-numeric sensor ID.

header Parameters
api-version
string
Request Body schema: application/json

A BACnet/IP numeric non-sensor.

id
string or null <uuid>
objectInstance
integer <int32>
objectType
string (BacnetIpObjectType)
Enum: "analogValue" "analogInput" "binaryValue" "binaryInput" "multiStateInput"
sensorTypeId
string <uuid>
sensorType
string or null
name
string or null
Array of objects or null (ValueMappingDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "objectInstance": 0,
  • "objectType": "analogValue",
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "string",
  • "name": "string",
  • "valueMapping": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "objectInstance": 0,
  • "objectType": "analogValue",
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "string",
  • "name": "string",
  • "valueMapping": [
    ]
}

Deletes a BACnet/IP non-numeric sensor.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

bacnetIpNonNumericSensorId
required
string <uuid>

A BACnet/IP non-numeric sensor ID.

header Parameters
api-version
string

Responses

BacnetIpNumericSensors

Returns a collection of BACnet/IP numeric sensors.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a BACnet/IP numeric sensor.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

header Parameters
api-version
string
Request Body schema: application/json

A BACnet/IP numeric sensor.

id
string or null <uuid>
objectInstance
integer <int32>
objectType
string (BacnetIpObjectType)
Enum: "analogValue" "analogInput" "binaryValue" "binaryInput" "multiStateInput"
sensorTypeId
string <uuid>
sensorType
string or null
name
string or null
unitId
string or null <uuid>
unit
string or null
multiplier
number <double>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "objectInstance": 0,
  • "objectType": "analogValue",
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "string",
  • "name": "string",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "unit": "string",
  • "multiplier": 0.1
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Updates a BACnet/IP numeric sensor.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

bacnetIpNumericSensorId
required
string <uuid>

A BACnet/IP definition numeric sensor ID.

header Parameters
api-version
string
Request Body schema: application/json

A BACnet/IP numeric sensor.

id
string or null <uuid>
objectInstance
integer <int32>
objectType
string (BacnetIpObjectType)
Enum: "analogValue" "analogInput" "binaryValue" "binaryInput" "multiStateInput"
sensorTypeId
string <uuid>
sensorType
string or null
name
string or null
unitId
string or null <uuid>
unit
string or null
multiplier
number <double>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "objectInstance": 0,
  • "objectType": "analogValue",
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "string",
  • "name": "string",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "unit": "string",
  • "multiplier": 0.1
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "objectInstance": 0,
  • "objectType": "analogValue",
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "string",
  • "name": "string",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "unit": "string",
  • "multiplier": 0.1
}

Deletes a BACnet/IP numeric sensor.

Authorizations:
oauth2
path Parameters
bacnetIpDefinitionId
required
string <uuid>

A BACnet/IP definition ID.

bacnetIpNumericSensorId
required
string <uuid>

A BACnet/IP numeric sensor ID.

header Parameters
api-version
string

Responses

Bulk

Deletes a set of assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of the assets to delete and whether or not the current user should receive a notification when the deletion job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true
}

Add associations between a single document and many assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of the assets to associate with the document ID, and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean
documentId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true,
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052"
}

Remove associations between a single document and many assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of the assets associated with the document ID, and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean
documentId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true,
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052"
}

Creates asset notification recipients between the requesting user and many assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of assets to be watched by the current user and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true
}

Remove asset notification recipients between the requesting user and many assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of assets to be unwatched by the current user and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true
}

Disable monitoring for a set of assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of assets to disable monitoring and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true
}

Enable monitoring for a set of assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of assets to enable monitoring and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true
}

Updates a custom property for a set of assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of assets to be updated with a new custom property value and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean
customAssetPropertyKeyId
string <uuid>
dataType
string (PropertyValueType)
Enum: "string" "integer" "decimal" "dateTime" "enum" "ipAddress" "macAddress" "boolean" "base" "guid" "long"
value
any or null

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true,
  • "customAssetPropertyKeyId": "aa483fa6-0a32-4d76-a7f8-d722bcee1bcf",
  • "dataType": "string",
  • "value": null
}

Updates the associations between a control credential and many assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of assets to either remove or update the association with the control credential ID and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean
controlCredentialId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true,
  • "controlCredentialId": "ae9dbf37-cbe9-4181-a5bd-95801dc3525e"
}

Updates life cycle properties for a set of assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of assets to be updated with new life cycle property values and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean
lifecycleState
string (AssetLifecycleState)
Enum: "active" "planned" "procurement" "staging" "retired" "inventory"
commissionDate
string or null <date-time>
retirementDate
string or null <date-time>
endOfLifeDate
string or null <date-time>
shouldUpdateLifecycleState
boolean
shouldUpdateCommissionDate
boolean
shouldUpdateRetirementDate
boolean
shouldUpdateEndOfLifeDate
boolean

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true,
  • "lifecycleState": "active",
  • "commissionDate": "2019-08-24T14:15:22Z",
  • "retirementDate": "2019-08-24T14:15:22Z",
  • "endOfLifeDate": "2019-08-24T14:15:22Z",
  • "shouldUpdateLifecycleState": true,
  • "shouldUpdateCommissionDate": true,
  • "shouldUpdateRetirementDate": true,
  • "shouldUpdateEndOfLifeDate": true
}

Updates associations between a single access policy and many assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of the assets to associate with the access policy ID, and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean
accessPolicyId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true,
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7"
}

Updates associations between a single product and many assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of the assets to associate with the product ID, and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean
productId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true,
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113"
}

Updates an asset property for a set of assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of assets to be updated with a new asset property value and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean
assetPropertyKeyId
string (AssetPropertyKeyEnum)
Enum: "buswayTapOffNumber" "serialNumber" "ipAddressValue" "macAddress" "costPerRack" "locationType" "desiredRackTemperature" "contactName" "emailAddress" "phoneNumberOne" "phoneNumberTwo" "costPerKiloWattHour" "designValue" "rackDesign" "assetTag" "width" "height" "depth" "weight" "consumedRackUnits" "providedRackUnits" "ratedPower" "description" "guid" "manufacturer" "model" "name" "objectId" "outletNumber" "contact" "componentManufacturer" "componentModel" "internalDeviceId" "technology" "size" "operationalStatus" "listIndex" "networkInterfaceIndex" "highSpeed" "designatedRoot" "designatedBridge" "designatedPort" "speed" "nicHostSystemId" "isNicPartOfADeviceChain" "hostName" "currentClockSpeed" "maxClockSpeed" "enabledCoresCount" "processorFamily" "powerManagementSupported" "gatewayIpAddress" "ipAddressEnabled" "isBmcIpAddress" "applicationId" "applicationVersion" "applicationCaption" "installDate" "physicalStorageType" "blockSize" "blockCount" "buildNumber" "buildType" "operatingSystemVersion" "operatingSystemMajorVersion" "operatingSystemMinorVersion" "architecture" "pduBreakerRating" "outletPhase" "outletBank" "hardwareVersion" "firmwareVersion" "dnsHostName" "domain" "domainRole" "powerSaverMode" "deviceChainId" "totalOutlets" "numberOfPhases" "ratedInputVoltage" "panelBreakerRating" "breakerCount" "breakersPerPanel" "panelCount" "ratedCurrent" "ratedVoltage" "powerFactor" "ratedVa" "memoryTotalWidth" "portNumber" "commissionDate" "endOfLifeDate" "retirementDate" "boardSerialNumber" "memoryType" "streetAddress" "presence" "internalStatus" "bladeBmcMacAddress" "operatingSystemPlatformId" "operatingSystemSignature" "operatingSystemVendor" "operatingSystemServicePackMajorVersion" "operatingSystemServicePackMinorVersion" "operatingSystemEditionId" "toolsStatus" "linkState" "captureState" "simulatedCableState" "numberOfPoles" "breakerNumber" "panelNumber" "defaultMainPanelBreakerSize" "defaultBreakerSize" "latitude" "longitude" "controllerSerialNumber" "powerModuleSerialNumber" "fanSerialNumber" "assetPlacementDescription" "outletType" "locationDescription" "note" "snmpVersion" "rackTotalPowerSetting" "bayLocation" "itEnergySetting" "breakerStatus" "enclosureSerialNumber" "macOuiManufacturer" "assetTrackerTagSerialNumber" "assetTrackerModuleSerialNumber" "assetTrackerExpectedReportedRackUnits" "assetTrackerRackOffset" "rackDeltaTCalculationOrientation" "mediaType" "physicalConnectorType" "length" "portType" "portSide" "circuitType" "circuitProvisioningStatus" "smartViewLocationType" "smartViewLevelValue" "smartViewAccountNumber" "smartViewIbx" "locationAverageTemperatureSetting" "locationAverageHumiditySetting" "webPortalLaunchUrl" "biosVersion" "powerSupplyOutputRating" "powerSupplyInputRating" "powerSupplyType" "snmpPort" "businessEntityType" "streetAddressType"
value
any or null

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true,
  • "assetPropertyKeyId": "buswayTapOffNumber",
  • "value": null
}

Updates the associations between a firmware credential and many assets.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: application/json

An object containing the IDs of assets to either remove or update the association with the firmware credential ID and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid>
shouldReceiveResultNotification
boolean