API docs by Redocly

Hyperview API 5.0 (5.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> [ items <uuid > ]
allowedGroups
Array of strings or null <uuid> [ items <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> [ items <uuid > ]
allowedGroups
Array of strings or null <uuid> [ items <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> [ items <uuid > ]
groups
Array of strings or null <uuid> [ items <uuid > ]
notificationChannels
Array of strings or null <uuid> [ items <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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
filteredCategories
Array of strings or null (AlarmEventCategory)
Enum: "snmpTrap" "unknownTrap" "hostUnreachable" "sensorThresholdCheck" "dataCollectorStatus" "assetTrackerStatus" "firmwareStatus"

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": [
    ],
  • "filteredCategories": [
    ]
}

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> [ items <uuid > ]
groups
Array of strings or null <uuid> [ items <uuid > ]
notificationChannels
Array of strings or null <uuid> [ items <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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
filteredCategories
Array of strings or null (AlarmEventCategory)
Enum: "snmpTrap" "unknownTrap" "hostUnreachable" "sensorThresholdCheck" "dataCollectorStatus" "assetTrackerStatus" "firmwareStatus"

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": [
    ],
  • "filteredCategories": [
    ]
}

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": [
    ],
  • "filteredCategories": [
    ]
}

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

Response samples

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

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"

Response samples

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

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> [ items <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> [ items <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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"
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" "mqtt"
assetPropertyDisplayCategory
string or null
isEditable
boolean
isDeletable
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,
  • "isDeletable": 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,
  • "isDeletable": 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

Returns an asset property for an asset.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"

An asset property key.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "buswayTapOffNumber",
  • "value": null,
  • "dataType": "string"
}

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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"
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" "mqtt"
assetPropertyDisplayCategory
string or null
isEditable
boolean
isDeletable
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,
  • "isDeletable": 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,
  • "isDeletable": 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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
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"
object (MuteAlarmEventNotificationsSettingDto)
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",
  • "muteAlarmEventNotificationsSetting": {
    },
  • "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",
  • "muteAlarmEventNotificationsSetting": {
    },
  • "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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
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"
object (MuteAlarmEventNotificationsSettingDto)
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",
  • "muteAlarmEventNotificationsSetting": {
    },
  • "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",
  • "muteAlarmEventNotificationsSetting": {
    },
  • "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.

rackSide
string (RackSide)
Enum: "unknown" "front" "rear"

A flag to indicate which side of the rack to get available rack space from.

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>

Image file to upload.

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
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" "multiStateValue"
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" "multiStateValue"
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" "multiStateValue"
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" "multiStateValue"
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> [ items <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> [ items <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> [ items <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> [ items <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> [ items <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> [ items <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> [ items <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> [ items <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> [ items <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> [ items <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> [ items <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> [ items <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> [ items <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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"
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> [ items <uuid > ]
shouldReceiveResultNotification
boolean
controlCredentialId
string or null <uuid>
isSecure
boolean
portOverride
integer or null <int32>

Responses

Request samples

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

Updates control operations data collector associations 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 data collector ID for control operations and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid> [ items <uuid > ]
shouldReceiveResultNotification
boolean
dataCollectorId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true,
  • "dataCollectorId": "ed6095f1-9032-4457-ab96-10f2eea0eb20"
}

Updates the access policy for an asset's descendants.

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

An object containing asset id and access policy id for updating the asset descendants' access policies and whether the current user should receive a notification when the job is done.

assetId
string <uuid>
accessPolicyId
string <uuid>
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "shouldReceiveResultNotification": true
}

Updates physical network port names.

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

An object containing the IDs of assets to have their physical ports updated and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid> [ items <uuid > ]
shouldReceiveResultNotification
boolean
portNameTemplate
string or null

Responses

Request samples

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

Adds multiple physical network ports to multiple assets.

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

An object containing the IDs of assets to have new physical ports added and whether or not the current user should receive a notification when the job is done.

physicalPortCount
integer <int32>
portTypeValueId
string or null <uuid>
portSideValueId
string or null <uuid>
portNameTemplate
string or null
assetIds
Array of strings or null <uuid> [ items <uuid > ]
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "physicalPortCount": 0,
  • "portTypeValueId": "fdd0022b-43d1-449d-b439-23d0ce6fe7d9",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "portNameTemplate": "string",
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true
}

Adds a single physical network port to multiple assets.

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

An object containing the IDs of assets to have a new physical port added and whether or not the current user should receive a notification when the job is done.

name
string or null
portNumber
integer <int32>
portTypeValueId
string or null <uuid>
portSideValueId
string or null <uuid>
assetIds
Array of strings or null <uuid> [ items <uuid > ]
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "portNumber": 0,
  • "portTypeValueId": "fdd0022b-43d1-449d-b439-23d0ce6fe7d9",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true
}

Adds multiple physical network ports to multiple patch panels.

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

An object containing the IDs of patch panels to have new physical ports added and whether or not the current user should receive a notification when the job is done.

portSideValueId
string <uuid>
connectorTypeValueId
string or null <uuid>
physicalPortCount
integer <int32>
portNameTemplate
string or null
assetIds
Array of strings or null <uuid> [ items <uuid > ]
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5",
  • "physicalPortCount": 0,
  • "portNameTemplate": "string",
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true
}

Adds a single physical network port to multiple patch panels.

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

An object containing the IDs of patch panels to have a new physical port added and whether or not the current user should receive a notification when the job is done.

parentId
string <uuid>
portSideValueId
string <uuid>
connectorTypeValueId
string or null <uuid>
id
string or null <uuid>
name
string or null
portNumber
integer <int32>
assetIds
Array of strings or null <uuid> [ items <uuid > ]
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "portNumber": 0,
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true
}

Updates business entity association for many assets.

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

An object containing the IDs of assets and the id of a business entity, and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid> [ items <uuid > ]
shouldReceiveResultNotification
boolean
businessEntityId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true,
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8"
}

Mutes alarm event notifications for many assets.

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

An object containing the IDs of assets and a start and end time, and whether or not the current user should receive a notification when the job is done.

startTime
string <date-time>

This value is assumed to be in UTC format.

endTime
string <date-time>

This value is assumed to be in UTC format.

assetIds
Array of strings or null <uuid> [ items <uuid > ]
shouldReceiveResultNotification
boolean

Responses

Request samples

Content type
application/json
{
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "assetIds": [
    ],
  • "shouldReceiveResultNotification": true
}

Cancels muted alarm event notifications for many assets.

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

An object containing the IDs of assets to cancel muted notification for, and whether or not the current user should receive a notification when the job is done.

assetIds
Array of strings or null <uuid> [ items <uuid > ]
shouldReceiveResultNotification
boolean

Responses

Request samples

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

BusinessEntities

Creates a business entity and returns its ID.

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

A business entity object.

id
string or null <uuid>
name
string or null
businessEntityTypeValueId
string <uuid>
accessPolicyId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "businessEntityTypeValueId": "54dc5229-4b97-4412-bbdb-ad7c7d16156a",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7"
}

Response samples

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

Updates a business entity.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A business entity ID.

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

A business entity object.

id
string or null <uuid>
name
string or null
businessEntityTypeValueId
string <uuid>
accessPolicyId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "businessEntityTypeValueId": "54dc5229-4b97-4412-bbdb-ad7c7d16156a",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "businessEntityTypeValueId": "54dc5229-4b97-4412-bbdb-ad7c7d16156a",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7"
}

Returns an individual business entity.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A business entity ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "businessEntityTypeValueId": "54dc5229-4b97-4412-bbdb-ad7c7d16156a",
  • "businessEntityTypeValue": "string",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7"
}

Deletes a business entity.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A business entity ID.

header Parameters
api-version
string

Responses

BusinessEntityAddresses

Returns a list of addresses for a given Business Entity.

Authorizations:
oauth2
path Parameters
businessEntityId
required
string <uuid>

A Business Entity ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a business entity address and returns its ID.

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

A business entity address object.

id
string or null <uuid>
parentId
string <uuid>
description
string or null
streetAddressValue
string or null
streetAddressTypeValueId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "description": "string",
  • "streetAddressValue": "string",
  • "streetAddressTypeValueId": "99348556-a521-48d5-9493-2c116cfaed22"
}

Response samples

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

Updates a business entity address.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A business entity address ID.

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

A business entity address object.

id
string or null <uuid>
parentId
string <uuid>
description
string or null
streetAddressValue
string or null
streetAddressTypeValueId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "description": "string",
  • "streetAddressValue": "string",
  • "streetAddressTypeValueId": "99348556-a521-48d5-9493-2c116cfaed22"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "description": "string",
  • "streetAddressValue": "string",
  • "streetAddressTypeValueId": "99348556-a521-48d5-9493-2c116cfaed22"
}

Deletes a business entity address.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A business entity address ID.

header Parameters
api-version
string

Responses

BusinessEntityAssociations

Removes a business entity association from an asset.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

BusinessEntityContacts

Returns a list of contacts for a given Business Entity.

Authorizations:
oauth2
path Parameters
businessEntityId
required
string <uuid>

A Business Entity ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a business entity contact and returns its ID.

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

A business entity contact object.

id
string or null <uuid>
parentId
string <uuid>
name
string or null
phoneNumberOne
string or null
phoneNumberTwo
string or null
emailAddress
string or null
note
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "name": "string",
  • "phoneNumberOne": "string",
  • "phoneNumberTwo": "string",
  • "emailAddress": "string",
  • "note": "string"
}

Response samples

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

Updates a business entity contact.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A business entity contact ID.

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

A business entity contact object.

id
string or null <uuid>
parentId
string <uuid>
name
string or null
phoneNumberOne
string or null
phoneNumberTwo
string or null
emailAddress
string or null
note
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "name": "string",
  • "phoneNumberOne": "string",
  • "phoneNumberTwo": "string",
  • "emailAddress": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "name": "string",
  • "phoneNumberOne": "string",
  • "phoneNumberTwo": "string",
  • "emailAddress": "string",
  • "note": "string"
}

Deletes a business entity contact.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A business entity contact ID.

header Parameters
api-version
string

Responses

BuswayTapOff

Returns a list of busway tap offs.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new busway tap off.

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

The busway tap off to be created.

tapOffNumber
integer <int32>
name
string or null
outletTypeEnumId
string <uuid>
parentAssetId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "tapOffNumber": 0,
  • "name": "string",
  • "outletTypeEnumId": "a589e944-1848-450b-9b27-ce6b4f311523",
  • "parentAssetId": "393bf9f5-484e-4036-a332-e8890cfb10d2"
}

Response samples

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

Deletes a new busway tap off.

Authorizations:
oauth2
path Parameters
buswayTapOffId
required
string <uuid>

A busway tap off ID.

header Parameters
api-version
string

Responses

Updates a busway tap off.

Authorizations:
oauth2
path Parameters
buswayTapOffId
required
string <uuid>

A busway tap off ID.

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

A busway tap off to be edited.

tapOffNumber
integer <int32>
name
string or null
outletTypeEnumId
string <uuid>
id
string <uuid>
parentAssetId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "tapOffNumber": 0,
  • "name": "string",
  • "outletTypeEnumId": "a589e944-1848-450b-9b27-ce6b4f311523",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentAssetId": "393bf9f5-484e-4036-a332-e8890cfb10d2"
}

Response samples

Content type
application/json
{
  • "tapOffNumber": 0,
  • "name": "string",
  • "outletTypeEnumId": "a589e944-1848-450b-9b27-ce6b4f311523",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentAssetId": "393bf9f5-484e-4036-a332-e8890cfb10d2"
}

CircuitConnections

Returns all physical connections associated with a circuit.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A circuit ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds physical connections to a circuit.

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

An object containing a circuit ID and physical connection IDs.

circuitId
string <uuid>
connectionIds
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "circuitId": "589883b2-8362-4fbd-8aee-205717a1a660",
  • "connectionIds": [
    ]
}

Response samples

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

Removes a connection from a circuit.

Authorizations:
oauth2
path Parameters
circuitId
required
string <uuid>

ID of the circuit.

connectionId
required
string <uuid>

ID of the connection.

header Parameters
api-version
string

Responses

Circuits

Creates a circuit and returns its ID.

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

A circuit object.

id
string or null <uuid>
circuitId
string or null
name
string or null
circuitType
string or null
provisioningStatus
string or null
sideAConnectionId
string or null <uuid>
sideZConnectionId
string or null <uuid>
accessPolicyId
string <uuid>
Array of objects or null (ModifiableCustomAssetPropertyDto)
connectionAssetIds
Array of strings or null <uuid> [ items <uuid > ]
businessEntityId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "circuitId": "string",
  • "name": "string",
  • "circuitType": "string",
  • "provisioningStatus": "string",
  • "sideAConnectionId": "f7f6c874-384c-4050-aecc-cbb596028720",
  • "sideZConnectionId": "7416ae34-976c-42d8-b652-5b411fee4f73",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "customPropertyValues": [
    ],
  • "connectionAssetIds": [
    ],
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8"
}

Response samples

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

Updates a circuit.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A circuit ID.

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

A circuit object.

id
string or null <uuid>
circuitId
string or null
name
string or null
circuitType
string or null
provisioningStatus
string or null
sideAConnectionId
string or null <uuid>
sideZConnectionId
string or null <uuid>
accessPolicyId
string <uuid>
Array of objects or null (ModifiableCustomAssetPropertyDto)
connectionAssetIds
Array of strings or null <uuid> [ items <uuid > ]
businessEntityId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "circuitId": "string",
  • "name": "string",
  • "circuitType": "string",
  • "provisioningStatus": "string",
  • "sideAConnectionId": "f7f6c874-384c-4050-aecc-cbb596028720",
  • "sideZConnectionId": "7416ae34-976c-42d8-b652-5b411fee4f73",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "customPropertyValues": [
    ],
  • "connectionAssetIds": [
    ],
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "circuitId": "string",
  • "name": "string",
  • "circuitType": "string",
  • "provisioningStatus": "string",
  • "sideAConnectionId": "f7f6c874-384c-4050-aecc-cbb596028720",
  • "sideZConnectionId": "7416ae34-976c-42d8-b652-5b411fee4f73",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "customPropertyValues": [
    ],
  • "connectionAssetIds": [
    ],
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8"
}

Deletes a circuit.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A circuit ID.

header Parameters
api-version
string

Responses

Returns an individual circuit.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A circuit ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "circuitId": "string",
  • "name": "string",
  • "circuitType": "string",
  • "provisioningStatus": "string",
  • "sideAConnectionAssetId": "6da5f339-bfb7-4579-8d69-fb572f6eeb6d",
  • "sideAConnectionAssetDisplayName": "string",
  • "sideAConnectionAssetAccessState": "full",
  • "sideZConnectionAssetId": "cb084422-16b9-43fa-8818-e431bf95770e",
  • "sideZConnectionAssetDisplayName": "string",
  • "sideZConnectionAssetAccessState": "full",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "accessPolicyName": "string",
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8",
  • "businessEntityDisplayName": "string",
  • "businessEntityAccessState": "full"
}

ComponentAssets

Returns a list of component assets for a given parent asset.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

query Parameters
includeAssetTypes
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

Optional list of included asset types.

excludeAssetTypes
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

Optional list of excluded asset types.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of virtual component assets for a given parent asset.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

query Parameters
includeAssetTypes
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

Optional list of included asset types.

excludeAssetTypes
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

Optional list of excluded asset types.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of network component assets for a given parent asset.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

query Parameters
includeAssetTypes
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

Optional list of included asset types.

excludeAssetTypes
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

Optional list of excluded asset types.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ContainedAssets

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

Authorizations:
oauth2
path Parameters
parentId
required
string <uuid>

A parent asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Control

Controls the electronic lock of a rack door.

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

An object containing rack ID, rack side and rack door operation.

rackId
string <uuid>
rackSide
string (RackSide)
Enum: "unknown" "front" "rear"
rackDoorOperation
string (RackDoorOperation)
Enum: "unlock" "lock"
workOrderName
string or null

Responses

Request samples

Content type
application/json
{
  • "rackId": "6b594d5c-dec3-4d92-9068-c47ab010a3f3",
  • "rackSide": "unknown",
  • "rackDoorOperation": "unlock",
  • "workOrderName": "string"
}

ControlDataCollector

Returns an asset's control operation data collector ID.

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"

ControlOperations

Returns an asset's control operation settings.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update asset's control operations settings.

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

An object containing the asset, control credential, and data collector ID to be associated.

assetId
string <uuid>
dataCollectorId
string <uuid>
snmpControlCredentialId
string or null <uuid>
firmwareCredentialId
string or null <uuid>
firmwareIsSecure
boolean
firmwarePortOverride
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "dataCollectorId": "ed6095f1-9032-4457-ab96-10f2eea0eb20",
  • "snmpControlCredentialId": "9692ab1e-49ae-4b4d-81f9-e6dd9aa73115",
  • "firmwareCredentialId": "01cfc075-dada-403a-86fc-3aff04ffca50",
  • "firmwareIsSecure": true,
  • "firmwarePortOverride": 0
}

Credentials

Returns an array of protocol credentials.

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 a Credential.

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

Credential data.

id
string or null <uuid>
protocol
string (DataSource)
Enum: "application" "ribcl" "ipmi" "snmp" "ssh" "ucs" "vmware" "wbem" "wmi" "bacnetIp" "modbusTcp" "basicHttpAndHttps" "ntp" "tcp" "rimp" "arp" "racadm" "user" "dns" "ixos" "smartView" "mqtt"
domain
string or null
username
string or null
description
string or null
object (SnmpV3CredentialDto)
Array of objects or null (AssociatedCredentialMapDto)
Array of objects or null (AssociatedCredentialMapDto)
password
string or null
snmpPrivacyPassword
string or null
object (SshCertificateCredentialDto)
shouldEditPassword
boolean
shouldEditSnmpPrivacyPassword
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "protocol": "application",
  • "domain": "string",
  • "username": "string",
  • "description": "string",
  • "snmpV3Credential": {
    },
  • "associatedDiscoveries": [
    ],
  • "associatedControlOperations": [
    ],
  • "password": "string",
  • "snmpPrivacyPassword": "string",
  • "sshCertificateCredential": {
    },
  • "shouldEditPassword": true,
  • "shouldEditSnmpPrivacyPassword": true
}

Response samples

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

Returns an individual credential.

Authorizations:
oauth2
path Parameters
credentialId
required
string <uuid>

A credential ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "protocol": "application",
  • "domain": "string",
  • "username": "string",
  • "description": "string",
  • "snmpV3Credential": {
    },
  • "associatedDiscoveries": [
    ],
  • "associatedControlOperations": [
    ]
}

Updates a Credential.

Authorizations:
oauth2
path Parameters
credentialId
required
string <uuid>

A credential ID.

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

Credential data.

id
string or null <uuid>
protocol
string (DataSource)
Enum: "application" "ribcl" "ipmi" "snmp" "ssh" "ucs" "vmware" "wbem" "wmi" "bacnetIp" "modbusTcp" "basicHttpAndHttps" "ntp" "tcp" "rimp" "arp" "racadm" "user" "dns" "ixos" "smartView" "mqtt"
domain
string or null
username
string or null
description
string or null
object (SnmpV3CredentialDto)
Array of objects or null (AssociatedCredentialMapDto)
Array of objects or null (AssociatedCredentialMapDto)
password
string or null
snmpPrivacyPassword
string or null
object (SshCertificateCredentialDto)
shouldEditPassword
boolean
shouldEditSnmpPrivacyPassword
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "protocol": "application",
  • "domain": "string",
  • "username": "string",
  • "description": "string",
  • "snmpV3Credential": {
    },
  • "associatedDiscoveries": [
    ],
  • "associatedControlOperations": [
    ],
  • "password": "string",
  • "snmpPrivacyPassword": "string",
  • "sshCertificateCredential": {
    },
  • "shouldEditPassword": true,
  • "shouldEditSnmpPrivacyPassword": true
}

Deletes a Credential.

Authorizations:
oauth2
path Parameters
credentialId
required
string <uuid>

A credential ID.

header Parameters
api-version
string

Responses

Returns credential passwords.

Authorizations:
oauth2
path Parameters
credentialId
required
string <uuid>

A credential ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "password": "string",
  • "snmpPrivacyPassword": "string",
  • "sshKey": "string"
}

CustomAssetProperties

Returns a list of all custom 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
[
  • {
    }
]

Deletes a single custom asset property.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

ID of the custom asset property.

header Parameters
api-version
string

Responses

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

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

ID of the custom asset property to be updated.

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

The custom asset property to be updated.

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

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customAssetPropertyKeyId": "aa483fa6-0a32-4d76-a7f8-d722bcee1bcf",
  • "value": null,
  • "dataType": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customAssetPropertyKeyId": "aa483fa6-0a32-4d76-a7f8-d722bcee1bcf",
  • "customAssetPropertyGroupId": "cc5c419d-41f8-480e-9e40-66f322955423",
  • "value": null,
  • "dataType": "string",
  • "name": "string",
  • "groupName": "string",
  • "dataSource": "application",
  • "updatedDateTime": "2019-08-24T14:15:22Z",
  • "unit": "string"
}

CustomComponents

Returns a list of asset property value strings.

Authorizations:
oauth2
query 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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"

An asset property key.

searchValue
required
string

A search value.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Creates a custom component and returns its ID.

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

A custom component.

id
string or null <uuid>
parentId
string <uuid>
type
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
name
string or null
modelName
string or null
manufacturerName
string or null
serialNumber
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "type": "unknown",
  • "name": "string",
  • "modelName": "string",
  • "manufacturerName": "string",
  • "serialNumber": "string"
}

Response samples

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

Updates a custom component and returns the updated custom component.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A custom component ID.

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

A custom component.

id
string or null <uuid>
parentId
string <uuid>
type
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
name
string or null
modelName
string or null
manufacturerName
string or null
serialNumber
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "type": "unknown",
  • "name": "string",
  • "modelName": "string",
  • "manufacturerName": "string",
  • "serialNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "type": "unknown",
  • "name": "string",
  • "modelName": "string",
  • "manufacturerName": "string",
  • "serialNumber": "string"
}

Deletes a custom component.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A custom component ID.

header Parameters
api-version
string

Responses

CustomPropertyGroup

Creates a custom property group and returns its ID.

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

A custom property group object.

id
string or null <uuid>
name
string or null

Responses

Request samples

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

Response samples

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

Get a list of custom property groups.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update custom property group for group ID.

Authorizations:
oauth2
path Parameters
customPropertyGroupId
required
string <uuid>

A custom property group ID.

header Parameters
api-version
string
Request Body schema:

A custom property group object.

id
string or null <uuid>
name
string or null

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

Response samples

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

Deletes a single custom property group.

Authorizations:
oauth2
path Parameters
customPropertyGroupId
required
string <uuid>

ID of custom property group.

header Parameters
api-version
string

Responses

CustomPropertySetting

Creates a custom property setting and returns its ID.

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

A custom property setting object.

id
string or null <uuid>
name
string or null
customAssetPropertyGroupId
string <uuid>
customAssetPropertyGroupName
string or null
propertyValueType
string (PropertyValueType)
Enum: "string" "integer" "decimal" "dateTime" "enum" "ipAddress" "macAddress" "boolean" "base" "guid" "long"
assetTypes
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
unit
string or null
Array of objects or null (CustomAssetPropertyEnumValueDto)
defaultValue
any or null
allAssetTypes
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "customAssetPropertyGroupId": "cc5c419d-41f8-480e-9e40-66f322955423",
  • "customAssetPropertyGroupName": "string",
  • "propertyValueType": "string",
  • "assetTypes": [
    ],
  • "unit": "string",
  • "choices": [
    ],
  • "defaultValue": null,
  • "allAssetTypes": true
}

Response samples

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

Get a list of custom property settings.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update custom property setting for setting ID.

Authorizations:
oauth2
path Parameters
customPropertySettingId
required
string <uuid>

A custom property setting ID.

header Parameters
api-version
string
Request Body schema:

A custom property setting object.

id
string or null <uuid>
name
string or null
customAssetPropertyGroupId
string <uuid>
customAssetPropertyGroupName
string or null
propertyValueType
string (PropertyValueType)
Enum: "string" "integer" "decimal" "dateTime" "enum" "ipAddress" "macAddress" "boolean" "base" "guid" "long"
assetTypes
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
unit
string or null
Array of objects or null (CustomAssetPropertyEnumValueDto)
defaultValue
any or null
allAssetTypes
boolean

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "customAssetPropertyGroupId": "cc5c419d-41f8-480e-9e40-66f322955423",
  • "customAssetPropertyGroupName": "string",
  • "propertyValueType": "string",
  • "assetTypes": [
    ],
  • "unit": "string",
  • "choices": [
    ],
  • "defaultValue": null,
  • "allAssetTypes": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "customAssetPropertyGroupId": "cc5c419d-41f8-480e-9e40-66f322955423",
  • "customAssetPropertyGroupName": "string",
  • "propertyValueType": "string",
  • "assetTypes": [
    ],
  • "unit": "string",
  • "choices": [
    ],
  • "defaultValue": null,
  • "allAssetTypes": true
}

Deletes a single custom property setting.

Authorizations:
oauth2
path Parameters
customPropertySettingId
required
string <uuid>

ID of custom property setting.

header Parameters
api-version
string

Responses

DataCollector

Retrieve a list of Data Collectors.

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
[
  • {
    }
]

Retires a Data Collector and transfer responsibilities to an active Data Collector.

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

An object containing the active and retired Data Collector IDs.

activeDataCollectorId
string <uuid>
retiredDataCollectorId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "activeDataCollectorId": "71cce470-b24f-4e68-921e-e2b291dc64cd",
  • "retiredDataCollectorId": "633e35ab-99ff-46a4-8b55-e8ae05a6a0df"
}

DataCollectorToken

Saves registration token to database.

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

Token to save.

string <uuid>

Responses

Request samples

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

Response samples

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

DataCollectors

Returns an asset's associated data collectors.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Discoveries

Returns a collection of discovery settings.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a discovery setting.

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

Discovery setting data.

id
string or null <uuid>
dataCollectorId
string <uuid>
name
string or null
dataCollectorName
string or null
startTime
string or null <date-time>
endTime
string or null <date-time>
defaultPhysicalGroupId
string <uuid>
defaultPhysicalGroupName
string or null
status
string (DiscoveryRunningStatus)
Enum: "none" "beginDiscovery" "beginHostDiscovery" "beginProtocolDiscovery" "endProtocolDiscovery" "discoveryException" "aborting" "aborted" "notCompleted"
elapsedTime
string or null
scheduleType
string (ScheduleType)
Enum: "none" "daily" "weekly" "monthly" "now"
scheduleCron
string or null
currentDiscoveryDeviceTotal
integer <int32>
monitorDiscoveredAssets
boolean
discoveryType
string (DiscoveryType)
Enum: "general" "vmware" "ixos"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dataCollectorId": "ed6095f1-9032-4457-ab96-10f2eea0eb20",
  • "name": "string",
  • "dataCollectorName": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "defaultPhysicalGroupId": "614e12e2-843c-458d-bdc2-2edd3bbf8af1",
  • "defaultPhysicalGroupName": "string",
  • "status": "none",
  • "elapsedTime": "string",
  • "scheduleType": "none",
  • "scheduleCron": "string",
  • "currentDiscoveryDeviceTotal": 0,
  • "monitorDiscoveredAssets": true,
  • "discoveryType": "general"
}

Response samples

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

Returns a discovery setting.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A discovery setting Id.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dataCollectorId": "ed6095f1-9032-4457-ab96-10f2eea0eb20",
  • "name": "string",
  • "dataCollectorName": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "defaultPhysicalGroupId": "614e12e2-843c-458d-bdc2-2edd3bbf8af1",
  • "defaultPhysicalGroupName": "string",
  • "status": "none",
  • "elapsedTime": "string",
  • "scheduleType": "none",
  • "scheduleCron": "string",
  • "currentDiscoveryDeviceTotal": 0,
  • "monitorDiscoveredAssets": true,
  • "discoveryType": "general"
}

Updates a discovery setting.

Authorizations:
oauth2
path Parameters
discoveryId
required
string <uuid>

A discovery ID.

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

Discovery setting data.

id
string or null <uuid>
dataCollectorId
string <uuid>
name
string or null
dataCollectorName
string or null
startTime
string or null <date-time>
endTime
string or null <date-time>
defaultPhysicalGroupId
string <uuid>
defaultPhysicalGroupName
string or null
status
string (DiscoveryRunningStatus)
Enum: "none" "beginDiscovery" "beginHostDiscovery" "beginProtocolDiscovery" "endProtocolDiscovery" "discoveryException" "aborting" "aborted" "notCompleted"
elapsedTime
string or null
scheduleType
string (ScheduleType)
Enum: "none" "daily" "weekly" "monthly" "now"
scheduleCron
string or null
currentDiscoveryDeviceTotal
integer <int32>
monitorDiscoveredAssets
boolean
discoveryType
string (DiscoveryType)
Enum: "general" "vmware" "ixos"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dataCollectorId": "ed6095f1-9032-4457-ab96-10f2eea0eb20",
  • "name": "string",
  • "dataCollectorName": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "defaultPhysicalGroupId": "614e12e2-843c-458d-bdc2-2edd3bbf8af1",
  • "defaultPhysicalGroupName": "string",
  • "status": "none",
  • "elapsedTime": "string",
  • "scheduleType": "none",
  • "scheduleCron": "string",
  • "currentDiscoveryDeviceTotal": 0,
  • "monitorDiscoveredAssets": true,
  • "discoveryType": "general"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "dataCollectorId": "ed6095f1-9032-4457-ab96-10f2eea0eb20",
  • "name": "string",
  • "dataCollectorName": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "defaultPhysicalGroupId": "614e12e2-843c-458d-bdc2-2edd3bbf8af1",
  • "defaultPhysicalGroupName": "string",
  • "status": "none",
  • "elapsedTime": "string",
  • "scheduleType": "none",
  • "scheduleCron": "string",
  • "currentDiscoveryDeviceTotal": 0,
  • "monitorDiscoveredAssets": true,
  • "discoveryType": "general"
}

Deletes a discovery setting.

Authorizations:
oauth2
path Parameters
discoveryId
required
string <uuid>

A discovery ID.

header Parameters
api-version
string

Responses

Returns an individual discovery schedule.

Authorizations:
oauth2
path Parameters
discoveryId
required
string <uuid>

A discovery ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "description": "string",
  • "scheduleType": "none",
  • "cronExpression": "string",
  • "lastRun": "2019-08-24T14:15:22Z"
}

DiscoveryAssetHistories

Returns a collection of summaries about discovered assets for a given discovery history.

Authorizations:
oauth2
path Parameters
discoveryHistoryId
required
string <uuid>
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
[
  • {
    }
]

DiscoveryHistories

Returns a collection history of ran discoveries.

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
[
  • {
    }
]

Returns the details of a ran discovery.

Authorizations:
oauth2
path Parameters
discoveryHistoryId
required
string <uuid>

A discovery history ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "status": "none",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "elapsedTime": "string",
  • "discoveryName": "string",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "locationName": "string",
  • "newDeviceCount": 0,
  • "changedDeviceCount": 0,
  • "unknownDeviceCount": 0,
  • "unchangedDeviceCount": 0,
  • "failedHostDeviceErrorIdentifiers": [
    ]
}

DiscoveryProtocolSettings

Returns a list of ports for a specific discovery protocol.

Authorizations:
oauth2
query Parameters
discoveryId
required
string <uuid>

A discovery ID.

protocolId
required
string (DataSource)
Enum: "application" "ribcl" "ipmi" "snmp" "ssh" "ucs" "vmware" "wbem" "wmi" "bacnetIp" "modbusTcp" "basicHttpAndHttps" "ntp" "tcp" "rimp" "arp" "racadm" "user" "dns" "ixos" "smartView" "mqtt"

A protocol ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a protocol port.

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

Protocol port data.

id
string or null <uuid>
protocolId
string (DataSource)
Enum: "application" "ribcl" "ipmi" "snmp" "ssh" "ucs" "vmware" "wbem" "wmi" "bacnetIp" "modbusTcp" "basicHttpAndHttps" "ntp" "tcp" "rimp" "arp" "racadm" "user" "dns" "ixos" "smartView" "mqtt"
discoveryId
string <uuid>
port
integer <int32>
isEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "protocolId": "application",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "port": 0,
  • "isEnabled": true
}

Response samples

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

Deletes a discovery protocol port.

Authorizations:
oauth2
path Parameters
portId
required
string <uuid>

A protocol port ID.

header Parameters
api-version
string

Responses

Creates a protocol credential and associates it with a discovery.

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

A new discovery protocol credential.

discoveryId
string <uuid>
object (ModifiableCredentialDto)

Responses

Request samples

Content type
application/json
{
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "credential": {
    }
}

Response samples

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

Retrieves a collection of credentials for a given discovery protocol.

Authorizations:
oauth2
query Parameters
discoveryId
required
string <uuid>

A discovery ID.

protocolId
required
string (DataSource)
Enum: "application" "ribcl" "ipmi" "snmp" "ssh" "ucs" "vmware" "wbem" "wmi" "bacnetIp" "modbusTcp" "basicHttpAndHttps" "ntp" "tcp" "rimp" "arp" "racadm" "user" "dns" "ixos" "smartView" "mqtt"

A protocol ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Associates a protocol credential with a discovery.

Authorizations:
oauth2
path Parameters
protocolCredentialId
required
string <uuid>

A protocol credential ID.

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

A discovery ID.

string <uuid>

Responses

Request samples

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

Response samples

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

Removes a protocol credential from a discovery.

Authorizations:
oauth2
path Parameters
protocolCredentialId
required
string <uuid>

A protocol credential ID.

query Parameters
discoveryId
required
string <uuid>

A discovery ID.

header Parameters
api-version
string

Responses

Retrieves a collection of protocols for a given discovery.

Authorizations:
oauth2
query Parameters
discoveryId
required
string <uuid>

A discovery ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a protocol for a discovery.

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

Discovery protocol data.

id
string (DataSource)
Enum: "application" "ribcl" "ipmi" "snmp" "ssh" "ucs" "vmware" "wbem" "wmi" "bacnetIp" "modbusTcp" "basicHttpAndHttps" "ntp" "tcp" "rimp" "arp" "racadm" "user" "dns" "ixos" "smartView" "mqtt"
discoveryId
string <uuid>
name
string or null
isEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "application",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "name": "string",
  • "isEnabled": true
}

Response samples

Content type
application/json
{
  • "id": "application",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "name": "string",
  • "isEnabled": true
}

Retrieves a protocol.

Authorizations:
oauth2
path Parameters
protocolId
required
string (DataSource)
Enum: "application" "ribcl" "ipmi" "snmp" "ssh" "ucs" "vmware" "wbem" "wmi" "bacnetIp" "modbusTcp" "basicHttpAndHttps" "ntp" "tcp" "rimp" "arp" "racadm" "user" "dns" "ixos" "smartView" "mqtt"

A protocol ID.

query Parameters
discoveryId
required
string <uuid>

A discovery ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "application",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "name": "string",
  • "isEnabled": true
}

DiscoveryRanges

Saves a discovery range.

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

Discovery range data.

id
string or null <uuid>
discoveryId
string <uuid>
start
string or null
end
string or null
ipRangeType
string (RangeType)
Enum: "singleAddress" "specificRange" "addressList" "cidr"
isExclusiveRange
boolean
ipAddressList
Array of strings or null
description
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "start": "string",
  • "end": "string",
  • "ipRangeType": "singleAddress",
  • "isExclusiveRange": true,
  • "ipAddressList": [
    ],
  • "description": "string"
}

Response samples

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

Retrieves a collection of network ranges for discovery.

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
[
  • {
    }
]

Updates a discovery range.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A discovery range ID.

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

Discovery range data.

id
string or null <uuid>
discoveryId
string <uuid>
start
string or null
end
string or null
ipRangeType
string (RangeType)
Enum: "singleAddress" "specificRange" "addressList" "cidr"
isExclusiveRange
boolean
ipAddressList
Array of strings or null
description
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "start": "string",
  • "end": "string",
  • "ipRangeType": "singleAddress",
  • "isExclusiveRange": true,
  • "ipAddressList": [
    ],
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "start": "string",
  • "end": "string",
  • "ipRangeType": "singleAddress",
  • "isExclusiveRange": true,
  • "ipAddressList": [
    ],
  • "description": "string"
}

Deletes a discovery range.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A discovery range ID.

header Parameters
api-version
string

Responses

DiscoveryReport

Returns Asset Discovery Report.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DiscoveryRunner

Schedules a discovery to run immediately.

Authorizations:
oauth2
path Parameters
discoveryId
required
string <uuid>

A discovery's ID.

header Parameters
api-version
string

Responses

Aborts a running discovery.

Authorizations:
oauth2
path Parameters
discoveryId
required
string <uuid>

A discovery's ID.

header Parameters
api-version
string

Responses

DiscoverySchedules

Saves a discovery schedule.

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

Discovery schedule data.

id
string or null <uuid>
discoveryId
string <uuid>
description
string or null
scheduleType
string (ScheduleType)
Enum: "none" "daily" "weekly" "monthly" "now"
cronExpression
string or null
lastRun
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "description": "string",
  • "scheduleType": "none",
  • "cronExpression": "string",
  • "lastRun": "2019-08-24T14:15:22Z"
}

Response samples

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

Updates a discovery schedule.

Authorizations:
oauth2
path Parameters
discoveryScheduleId
required
string <uuid>

A discovery schedule ID.

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

Discovery schedule data.

id
string or null <uuid>
discoveryId
string <uuid>
description
string or null
scheduleType
string (ScheduleType)
Enum: "none" "daily" "weekly" "monthly" "now"
cronExpression
string or null
lastRun
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "discoveryId": "a79b5518-f49c-4479-b143-82d9f0f6b285",
  • "description": "string",
  • "scheduleType": "none",
  • "cronExpression": "string",
  • "lastRun": "2019-08-24T14:15:22Z"
}

Deletes a discovery schedule.

Authorizations:
oauth2
path Parameters
discoveryScheduleId
required
string <uuid>

Discovery schedule ID.

header Parameters
api-version
string

Responses

DocumentAccessPolicies

Returns the access policy ID associated with a document.

Authorizations:
oauth2
path Parameters
documentId
required
string <uuid>

A document ID.

header Parameters
api-version
string

Responses

Response samples

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

Updates and returns a document access policy.

Authorizations:
oauth2
path Parameters
documentId
required
string <uuid>

A document 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"

DocumentAssociations

Creates an association between an asset and a document.

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

An object containing the asset and document to be associated.

assetId
string <uuid>
documentDetailId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "documentDetailId": "44eda194-fe93-40aa-9f93-c376d955f13d"
}

Response samples

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

Removes an association between an asset and a document.

Authorizations:
oauth2
path Parameters
assetDocumentAssociationId
required
string <uuid>

Asset Document Association ID.

header Parameters
api-version
string

Responses

Returns a collection of associated document details for 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
[
  • {
    }
]

Returns a list of associated assets for a document.

Authorizations:
oauth2
path Parameters
documentId
required
string <uuid>

A document ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DocumentDetails

Returns details for a single document.

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

Responses

Response samples

Content type
application/json
{
  • "documentType": "image",
  • "linkAddress": "string",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "fileSize": 0,
  • "fileExtension": "pdf",
  • "numberOfAssociations": 0
}

Returns a collection of document details.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Documents

Downloads a document.

Authorizations:
oauth2
path Parameters
documentId
required
string <uuid>

A document ID.

header Parameters
api-version
string

Responses

Updates a document.

Authorizations:
oauth2
path Parameters
documentId
required
string <uuid>
header Parameters
api-version
string
Request Body schema: multipart/form-data
DocumentDetails.Id
string <uuid>
DocumentDetails.Name
string
DocumentDetails.AccessPolicyId
string <uuid>
DocumentDetails.DocumentType
string (DocumentType)
Enum: "image" "generalDocument" "pdf" "link" "notification"
DocumentDetails.LinkAddress
string
DocumentDetails.Description
string
Document
string <binary>

Responses

Deletes a document.

Authorizations:
oauth2
path Parameters
documentId
required
string <uuid>

A document ID.

header Parameters
api-version
string

Responses

Uploads a document and saves its details.

Authorizations:
oauth2
header Parameters
api-version
string
Request Body schema: multipart/form-data
DocumentDetails.Id
string <uuid>
DocumentDetails.Name
string
DocumentDetails.AccessPolicyId
string <uuid>
DocumentDetails.DocumentType
string (DocumentType)
Enum: "image" "generalDocument" "pdf" "link" "notification"
DocumentDetails.LinkAddress
string
DocumentDetails.Description
string
Document
string <binary>

Responses

Response samples

Content type
No sample

EnumAssetProperties

Returns a list of all enum values for a given enum ID.

Authorizations:
oauth2
path Parameters
id
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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"

The ID of an enum.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

EnumCustomAssetProperties

Returns a list of all enum values for a given enum ID.

Authorizations:
oauth2
path Parameters
customAssetPropertyKeyId
required
string <uuid>

The custom asset property key ID of an enum value.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

EquinixSmartViewConfiguration

Returns the Equinix Smart View integration configuration.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "sensorPollingRateSeconds": 0
}

Saves the Smart View integration configuration changes.

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

The Smart View integration configuration to be saved.

clientId
string or null
clientSecret
string or null
sensorPollingRateSeconds
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "sensorPollingRateSeconds": 0
}

Response samples

Content type
application/json
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "sensorPollingRateSeconds": 0
}

Verifies the Smart View integration authentication configuration.

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

The Smart View integration authentication details to be tested.

clientId
string or null
clientSecret
string or null
sensorPollingRateSeconds
integer or null <int32>

Responses

Request samples

Content type
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "sensorPollingRateSeconds": 0
}

EquinixSmartViewIbxConfigurations

Returns a collection of Equinix Smart View IBX configurations.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an Equinix Smart View IBX configuration.

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

The Smart View IBX configuration to be saved.

id
string or null <uuid>
accountNumber
string or null
ibx
string or null
defaultParentLocationAssetId
string <uuid>
defaultRackProductId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "accountNumber": "string",
  • "ibx": "string",
  • "defaultParentLocationAssetId": "c220b614-f7a3-4033-9de7-96394718f247",
  • "defaultRackProductId": "eca73647-7591-4a4d-afed-04cf0f818a59"
}

Response samples

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

Deletes an Equinix Smart View IBX configuration.

Authorizations:
oauth2
path Parameters
configurationId
required
string <uuid>

An Equinix Smart View IBX configuration ID.

header Parameters
api-version
string

Responses

Updates an Equinix Smart View IBX configuration.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

The Smart View IBX configuration ID.

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

The Smart View IBX configuration to be saved.

id
string or null <uuid>
accountNumber
string or null
ibx
string or null
defaultParentLocationAssetId
string <uuid>
defaultRackProductId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "accountNumber": "string",
  • "ibx": "string",
  • "defaultParentLocationAssetId": "c220b614-f7a3-4033-9de7-96394718f247",
  • "defaultRackProductId": "eca73647-7591-4a4d-afed-04cf0f818a59"
}

EquinixSmartViewIntegration

Initiates multiple Equinix Smart View integration IBX syncs.

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

An object containing Equinix Smart View IBX configurations IDs and a Work Order name template.

ibxConfigurationIds
Array of strings or null <uuid> [ items <uuid > ]
workOrderNameTemplate
string or null

Responses

Request samples

Content type
{
  • "ibxConfigurationIds": [
    ],
  • "workOrderNameTemplate": "string"
}

EventNotificationRecipient

Retrieves an asset notification recipient for the requesting user and a 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
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Creates an asset notification recipient for the requesting user and a 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
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Remove an asset notification recipient for the requesting user and a given asset.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

FirmwareDownload

Downloads firmware of a specific version.

Authorizations:
oauth2
path Parameters
firmwareVersionId
required
string <uuid>

A firmware version ID.

header Parameters
api-version
string

Responses

Downloads firmware release note for a specific version.

Authorizations:
oauth2
path Parameters
firmwareVersionId
required
string <uuid>

A firmware version ID.

header Parameters
api-version
string

Responses

FirmwareVersions

Returns details for a single firmware version.

Authorizations:
oauth2
path Parameters
firmwareVersionId
required
string <uuid>

A firmware version ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firmwareId": "44bbc267-0d43-4d6e-8f0e-67a633a4574d",
  • "releaseDate": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "minimumCompatibleVersion": "string",
  • "fileSize": 0,
  • "description": "string"
}

Returns a list of firmware versions for a specific firmware.

Authorizations:
oauth2
path Parameters
firmwareId
required
string <uuid>

A firmware ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FloorPlanLayout

Returns an individual floor plan layout.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A layout ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "backgroundImageId": "be1a10ff-449b-4e5c-a192-13cc5cb54bb7",
  • "backgroundWidth": 0.1,
  • "backgroundHeight": 0.1,
  • "gridCorners": "string",
  • "width": 0.1,
  • "physicalWidth": 0.1,
  • "assets": [
    ],
  • "newRacks": [
    ],
  • "height": 0.1,
  • "physicalHeight": 0.1,
  • "scale": 0.1,
  • "shapes": [
    ],
  • "userLabels": [
    ],
  • "columnFormat": "string",
  • "startColumn": 0,
  • "numberOfColumns": 0,
  • "rowFormat": "string",
  • "columnOffset": 0.1,
  • "startRow": 0,
  • "numberOfRows": 0,
  • "rowOffset": 0.1,
  • "state": [
    ],
  • "placedIndirectSensors": [
    ],
  • "imageFormat": "unknown"
}

Returns a list of the state of the assets within the floor plan layout.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A layout ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create or update floor plan layout and returns a UUID.

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

Layout data.

id
string <uuid>
backgroundImageId
string or null <uuid>
backgroundWidth
number or null <double>
backgroundHeight
number or null <double>
gridCorners
string or null
width
number or null <float>
physicalWidth
number or null <float>
Array of objects or null (FloorPlanLayoutAssetDto)
Array of objects or null (NewRackDto)
height
number or null <float>
physicalHeight
number or null <float>
scale
number or null <float>
Array of objects or null (FloorPlanLayoutShapeDto)
Array of objects or null (FloorPlanLayoutUserLabelDto)
columnFormat
string or null
startColumn
integer or null <int32>
numberOfColumns
integer or null <int32>
rowFormat
string or null
columnOffset
number <double>
startRow
integer or null <int32>
numberOfRows
integer or null <int32>
rowOffset
number <double>
Array of objects or null (IAssetStateDto)
Array of objects or null (FloorPlanLayoutIndirectSensorDto)
imageFormat
string (ImageFormat)
Enum: "unknown" "png" "gif" "jpeg" "svg"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "backgroundImageId": "be1a10ff-449b-4e5c-a192-13cc5cb54bb7",
  • "backgroundWidth": 0.1,
  • "backgroundHeight": 0.1,
  • "gridCorners": "string",
  • "width": 0.1,
  • "physicalWidth": 0.1,
  • "assets": [
    ],
  • "newRacks": [
    ],
  • "height": 0.1,
  • "physicalHeight": 0.1,
  • "scale": 0.1,
  • "shapes": [
    ],
  • "userLabels": [
    ],
  • "columnFormat": "string",
  • "startColumn": 0,
  • "numberOfColumns": 0,
  • "rowFormat": "string",
  • "columnOffset": 0.1,
  • "startRow": 0,
  • "numberOfRows": 0,
  • "rowOffset": 0.1,
  • "state": [
    ],
  • "placedIndirectSensors": [
    ],
  • "imageFormat": "unknown"
}

Response samples

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

Returns a list of rack IDs that are in the given rack's row.

Authorizations:
oauth2
path Parameters
rackId
required
string <uuid>

A rack ID.

header Parameters
api-version
string

Responses

Response samples

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

FloorPlanLayoutGridInformation

Returns a information about the display labels of a given layout grid's rows and columns.

Authorizations:
oauth2
path Parameters
locationId
required
string <uuid>

A location ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "displayRowValues": [
    ],
  • "displayColumnValues": [
    ]
}

Hierarchy

Returns a list of assets that includes placeholder ancestor assets.

Authorizations:
oauth2
query Parameters
parentId
string <uuid>

A nullable parent asset ID.

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

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

hasChildrenAssetType
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

An optional list of asset types to filter what assets are used when determining if an asset has children.

includeDimensions
boolean
Default: false

An optional flag for including dimensional properties.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Image

Returns a product image.

Authorizations:
oauth2
query Parameters
productId
string <uuid>

A product ID.

imagePosition
string (ImagePosition)
Enum: "front" "rear" "top" "bottom" "leftSide" "rightSide"

A product image position.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
"string"

IndirectSensors

Creates an indirect sensor link and returns its ID.

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

An indirect sensor object.

id
string <uuid>
indirectParentAssetId
string <uuid>
rackULocation
integer or null <int32>
rackSide
string (RackSide)
Enum: "unknown" "front" "rear"
floorPlanLayoutGridRow
integer or null <int32>
floorPlanLayoutGridColumn
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "indirectParentAssetId": "2bbc9e1e-00e9-4cd0-a01c-c542275b5f8d",
  • "rackULocation": 0,
  • "rackSide": "unknown",
  • "floorPlanLayoutGridRow": 0,
  • "floorPlanLayoutGridColumn": 0
}

Response samples

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

Deletes an indirect sensor link.

Authorizations:
oauth2
path Parameters
sensorId
required
string <uuid>

ID of the sensor.

header Parameters
api-version
string

Responses

LayoutModeSetting

Returns layout mode setting.

Authorizations:
oauth2
path Parameters
locationId
required
string <uuid>

A location ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "layoutMode": "floorPlan"
}

Creates a layout mode setting.

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

A layout mode setting.

id
string <uuid>
layoutMode
string (LayoutMode)
Enum: "floorPlan" "map"

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "layoutMode": "floorPlan"
}

Response samples

Content type
No sample

Updates a layout mode setting.

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

A layout mode setting.

id
string <uuid>
layoutMode
string (LayoutMode)
Enum: "floorPlan" "map"

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "layoutMode": "floorPlan"
}

Response samples

Content type
No sample

License

Returns the license information.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "hostName": "string",
  • "thresholds": [
    ],
  • "thresholdValues": [
    ],
  • "additionalFeatures": [
    ],
  • "productVersion": "string",
  • "productDescription": "string",
  • "tenantId": "string",
  • "isValid": true
}

LifecycleProperties

Returns Asset Lifecycle Properties for Asset ID.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "assetLifecycleState": "active",
  • "commissionDate": "2019-08-24T14:15:22Z",
  • "retirementDate": "2019-08-24T14:15:22Z",
  • "endOfLifeDate": "2019-08-24T14:15:22Z"
}

Update Asset Lifecycle Properties for Asset ID.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string
Request Body schema:

Asset lifecycle Properties.

assetLifecycleState
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>

Responses

Request samples

Content type
{
  • "assetLifecycleState": "active",
  • "commissionDate": "2019-08-24T14:15:22Z",
  • "retirementDate": "2019-08-24T14:15:22Z",
  • "endOfLifeDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "assetLifecycleState": "active",
  • "commissionDate": "2019-08-24T14:15:22Z",
  • "retirementDate": "2019-08-24T14:15:22Z",
  • "endOfLifeDate": "2019-08-24T14:15:22Z"
}

Location

Updates the location of an asset.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

The ID of the asset that will be moved.

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

The new location data.

parentId
string <uuid>
rackULocation
integer or null <int32>
rackSide
string (RackSide)
Enum: "unknown" "front" "rear"
rackPosition
string (RackPosition)
Enum: "unknown" "left" "right" "top" "bottom" "above" "below"
locationAccessPolicyChangeStrategy
string (LocationAccessPolicyChangeStrategy)
Enum: "maintainAccessPolicy" "inheritDestinationAccessPolicy" "inheritDestinationAccessPolicyIncludingDescendants"

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "rackULocation": 0,
  • "rackSide": "unknown",
  • "rackPosition": "unknown",
  • "locationAccessPolicyChangeStrategy": "maintainAccessPolicy"
}

Response samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "rackULocation": 0,
  • "rackSide": "unknown",
  • "rackPosition": "unknown",
  • "updatedDateTime": "2019-08-24T14:15:22Z"
}

ManualSensors

Creates one or many manual sensors.

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

An object containing sensor type, asset IDs, etc.

sensorTypeId
string <uuid>
sensorName
string or null
assetIds
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorName": "string",
  • "assetIds": [
    ]
}

Response samples

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

Updates a numeric manual sensor value.

Authorizations:
oauth2
path Parameters
sensorId
required
string <uuid>

A numeric sensor ID.

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

A numeric sensor value.

number <double>

Responses

Request samples

Content type
application/json
0.1

Manufacturers

Returns a paged list of manufacturers.

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

An optional asset type 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
[
  • {
    }
]

Creates a new manufacturer.

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

A manufacturer.

id
string or null <uuid>
name
string or null

Responses

Request samples

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

Response samples

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

Returns a manufacturer.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A manufacturer ID.

header Parameters
api-version
string

Responses

Response samples

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

Deletes a manufacturer.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A manufacturer ID.

header Parameters
api-version
string

Responses

Updates a manufacturer and returns the updated manufacturer.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A manufacturer ID.

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

An manufacturer object.

id
string or null <uuid>
name
string or null

Responses

Request samples

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

Response samples

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

MapLocations

Returns a list map locations.

Authorizations:
oauth2
path Parameters
locationId
required
string <uuid>

A location ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Merge

Merges a source asset into a destination asset.

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

An object containing destination and source asset IDs.

destinationAssetId
string <uuid>
sourceAssetId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "destinationAssetId": "97552804-3719-415c-ae9c-e1a3cf80a537",
  • "sourceAssetId": "743b0d0f-b98c-451b-b5cd-f114631df1f1"
}

Response samples

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

ModbusTcpDefinitions

Returns a collection of Modbus TCP 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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

An optional asset type to filter the results.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a Modbus TCP definition.

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

A Modbus TCP 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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
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 Modbus TCP definition.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP 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 Modbus TCP definition.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP definition ID.

header Parameters
api-version
string

Responses

Updates a Modbus TCP definition.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP definition ID.

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

A Modbus TCP 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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
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
}

ModbusTcpNonNumericSensors

Returns a collection of Modbus TCP non-numeric sensors.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP definition ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a Modbus TCP non-numeric sensor.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP definition ID.

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

A Modbus TCP numeric sensor.

id
string or null <uuid>
address
integer <int32>
registerType
string (ModbusRegisterType)
Enum: "inputRegister" "holdingRegister" "coil" "discreteInput"
dataType
string (ModbusTcpDataSetting)
Enum: "uInteger16" "integer16" "uInteger32BigEndian" "uInteger32LittleEndian" "integer32BigEndian" "integer32LittleEndian" "float32BigEndian" "float32LittleEndian" "boolean"
name
string or null
startBit
integer <int32>
endBit
integer <int32>
sensorTypeId
string <uuid>
sensorType
string or null
Array of objects or null (ValueMappingDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "address": 0,
  • "registerType": "inputRegister",
  • "dataType": "uInteger16",
  • "name": "string",
  • "startBit": 0,
  • "endBit": 0,
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "string",
  • "valueMapping": [
    ]
}

Response samples

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

Updates a Modbus TCP non-numeric sensor.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP definition ID.

modbusTcpNonNumericSensorId
required
string <uuid>

A Modbus TCP non-numeric sensor ID.

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

A Modbus TCP non-numeric sensor.

id
string or null <uuid>
address
integer <int32>
registerType
string (ModbusRegisterType)
Enum: "inputRegister" "holdingRegister" "coil" "discreteInput"
dataType
string (ModbusTcpDataSetting)
Enum: "uInteger16" "integer16" "uInteger32BigEndian" "uInteger32LittleEndian" "integer32BigEndian" "integer32LittleEndian" "float32BigEndian" "float32LittleEndian" "boolean"
name
string or null
startBit
integer <int32>
endBit
integer <int32>
sensorTypeId
string <uuid>
sensorType
string or null
Array of objects or null (ValueMappingDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "address": 0,
  • "registerType": "inputRegister",
  • "dataType": "uInteger16",
  • "name": "string",
  • "startBit": 0,
  • "endBit": 0,
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "string",
  • "valueMapping": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "address": 0,
  • "registerType": "inputRegister",
  • "dataType": "uInteger16",
  • "name": "string",
  • "startBit": 0,
  • "endBit": 0,
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "string",
  • "valueMapping": [
    ]
}

Deletes a Modbus TCP non-numeric sensor.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP definition ID.

modbusTcpNonNumericSensorId
required
string <uuid>

A Modbus TCP non-numeric sensor ID.

header Parameters
api-version
string

Responses

ModbusTcpNumericSensors

Returns a collection of Modbus TCP numeric sensors.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP definition ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a Modbus TCP numeric sensor.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP definition ID.

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

A Modbus TCP numeric sensor.

id
string or null <uuid>
address
integer <int32>
registerType
string (ModbusRegisterType)
Enum: "inputRegister" "holdingRegister" "coil" "discreteInput"
dataSetting
string (ModbusTcpDataSetting)
Enum: "uInteger16" "integer16" "uInteger32BigEndian" "uInteger32LittleEndian" "integer32BigEndian" "integer32LittleEndian" "float32BigEndian" "float32LittleEndian" "boolean"
name
string or null
sensorTypeId
string <uuid>
sensorType
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",
  • "address": 0,
  • "registerType": "inputRegister",
  • "dataSetting": "uInteger16",
  • "name": "string",
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "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 Modbus TCP numeric sensor.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP definition ID.

modbusTcpNumericSensorId
required
string <uuid>

A Modbus TCP numeric sensor ID.

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

A Modbus TCP numeric sensor.

id
string or null <uuid>
address
integer <int32>
registerType
string (ModbusRegisterType)
Enum: "inputRegister" "holdingRegister" "coil" "discreteInput"
dataSetting
string (ModbusTcpDataSetting)
Enum: "uInteger16" "integer16" "uInteger32BigEndian" "uInteger32LittleEndian" "integer32BigEndian" "integer32LittleEndian" "float32BigEndian" "float32LittleEndian" "boolean"
name
string or null
sensorTypeId
string <uuid>
sensorType
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",
  • "address": 0,
  • "registerType": "inputRegister",
  • "dataSetting": "uInteger16",
  • "name": "string",
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "sensorType": "string",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "unit": "string",
  • "multiplier": 0.1
}

Response samples

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

Deletes a Modbus TCP numeric sensor.

Authorizations:
oauth2
path Parameters
modbusTcpDefinitionId
required
string <uuid>

A Modbus TCP definition ID.

modbusTcpNumericSensorId
required
string <uuid>

A Modbus TCP numeric sensor ID.

header Parameters
api-version
string

Responses

MonitorOnlyCommunicationSetting

Returns the monitoring profile for a 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
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sensorMonitoringProfileType": "discovered",
  • "monitoringState": "off",
  • "ipAddress": {
    },
  • "definitionId": "058563fe-6949-46e9-9fb3-06a0e3a11f6a",
  • "port": 0,
  • "dataCollectorId": "ed6095f1-9032-4457-ab96-10f2eea0eb20",
  • "modbusTcpNodeAddress": 0,
  • "bacnetIpDeviceInstance": 0,
  • "bacnetIpNetworkNumber": 0,
  • "bacnetIpHardwareAddress": 0,
  • "bacnetIpHardwareAddressLength": 0
}

Updates or creates the monitoring profile for an asset.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

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

The monitoring profile data.

id
string or null <uuid>
sensorMonitoringProfileType
string (SensorMonitoringProfileType)
Enum: "discovered" "manualOnly" "bacnetIp" "modbusTcp"
monitoringState
string (MonitoringState)
Enum: "off" "on"
object (IPAddress)
definitionId
string or null <uuid>
port
integer or null <int32>
dataCollectorId
string or null <uuid>
modbusTcpNodeAddress
integer or null <int32>
bacnetIpDeviceInstance
integer or null <int32>
bacnetIpNetworkNumber
integer or null <int32>
bacnetIpHardwareAddress
integer or null <int32>
bacnetIpHardwareAddressLength
integer or null <int32>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sensorMonitoringProfileType": "discovered",
  • "monitoringState": "off",
  • "ipAddress": {
    },
  • "definitionId": "058563fe-6949-46e9-9fb3-06a0e3a11f6a",
  • "port": 0,
  • "dataCollectorId": "ed6095f1-9032-4457-ab96-10f2eea0eb20",
  • "modbusTcpNodeAddress": 0,
  • "bacnetIpDeviceInstance": 0,
  • "bacnetIpNetworkNumber": 0,
  • "bacnetIpHardwareAddress": 0,
  • "bacnetIpHardwareAddressLength": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sensorMonitoringProfileType": "discovered",
  • "monitoringState": "off",
  • "ipAddress": {
    },
  • "definitionId": "058563fe-6949-46e9-9fb3-06a0e3a11f6a",
  • "port": 0,
  • "dataCollectorId": "ed6095f1-9032-4457-ab96-10f2eea0eb20",
  • "modbusTcpNodeAddress": 0,
  • "bacnetIpDeviceInstance": 0,
  • "bacnetIpNetworkNumber": 0,
  • "bacnetIpHardwareAddress": 0,
  • "bacnetIpHardwareAddressLength": 0
}

Refreshes the asset monitoring sensors for a given asset from "monitor only" definitions.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

MuteAlarmEventNotifications

Mutes alarm event notifications for a specific asset.

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

An object containing an asset ID and the start and end dates for muting alarm event notifications.

startTime
string <date-time>

This value is assumed to be in UTC format.

endTime
string <date-time>

This value is assumed to be in UTC format.

assetId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8"
}

Cancels a mute alarm event notification setting for a specific asset.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

NetworkHosts

Returns a collection of network host information.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NotificationChannels

Creates a notification channel and returns its ID.

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

Notification channel data.

name
string or null
webhookUri
string or null
notificationChannelType
string (NotificationChannelType)
Value: "microsoftTeams"
id
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "webhookUri": "string",
  • "notificationChannelType": "microsoftTeams",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response samples

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

Returns a collection of notification channels.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a notification channel.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A notification channel ID.

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

Notification channel data.

name
string or null
webhookUri
string or null
notificationChannelType
string (NotificationChannelType)
Value: "microsoftTeams"
id
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "webhookUri": "string",
  • "notificationChannelType": "microsoftTeams",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "webhookUri": "string",
  • "notificationChannelType": "microsoftTeams",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Deletes a notification channel.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A notification channel ID.

header Parameters
api-version
string

Responses

Verifies the notification channel webhook uri by attempting to send a test notification.

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

The notification channel details to be tested.

name
string or null
webhookUri
string or null
notificationChannelType
string (NotificationChannelType)
Value: "microsoftTeams"
id
string or null <uuid>

Responses

Request samples

Content type
{
  • "name": "string",
  • "webhookUri": "string",
  • "notificationChannelType": "microsoftTeams",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response samples

Content type
application/json
{
  • "httpStatusCode": 0,
  • "isSuccessStatusCode": true
}

Outlets

Gets a list of outlets.

Authorizations:
oauth2
query Parameters
assetId
string <uuid>

Asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

OutletsControl

Performs a bulk control operation on outlets.

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

Bulk outlet control parameter to be executed.

workOrderName
string or null
outletControlOperation
string (OutletControlOperation)
Enum: "powerOn" "powerOff" "powerCycle"
outletIds
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "workOrderName": "string",
  • "outletControlOperation": "powerOn",
  • "outletIds": [
    ]
}

PduBreakers

Gets a list of PDU breakers.

Authorizations:
oauth2
query Parameters
assetId
string <uuid>

Asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a PDU breaker

Authorizations:
oauth2
path Parameters
pduBreakerId
required
string <uuid>

PDU breaker ID

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

PDU breaker properties

id
string <uuid>
pduBreakerRating
number <double>
numberOfPoles
integer <int32>
breakerWhipOutletTypeEnumId
string or null <uuid>
breakerWhipOutletLocationDescription
string or null
breakerWhipOutletNote
string or null
breakerStatusEnumId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "pduBreakerRating": 0.1,
  • "numberOfPoles": 0,
  • "breakerWhipOutletTypeEnumId": "6525d6af-28e3-4d95-92ee-137a2b4865ba",
  • "breakerWhipOutletLocationDescription": "string",
  • "breakerWhipOutletNote": "string",
  • "breakerStatusEnumId": "752a1b2a-3a78-484c-9b1a-e3e8601099e2"
}

Updates a PDU breaker status.

Authorizations:
oauth2
path Parameters
pduBreakerId
required
string <uuid>

PDU breaker ID.

query Parameters
breakerStatusEnumId
string <uuid>

PDU breaker status property

header Parameters
api-version
string

Responses

Response samples

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

PhysicalConnections

Creates a physical connection and returns its ID.

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

A physical connection object.

id
string or null <uuid>
name
string or null
mediaTypeValueId
string <uuid>
connectorTypeValueId
string or null <uuid>
length
number or null <double>
terminationAId
string <uuid>
terminationBId
string <uuid>
accessPolicyId
string <uuid>
Array of objects or null (ModifiableCustomAssetPropertyDto)
businessEntityId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mediaTypeValueId": "a1e7b9c7-ee0e-4789-8013-9872bb6776e7",
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5",
  • "length": 0.1,
  • "terminationAId": "e1481fde-2096-45f2-8cfb-44c9c1fe607a",
  • "terminationBId": "df50071e-bbe4-4f4d-a08d-33b735c85337",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "customPropertyValues": [
    ],
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8"
}

Response samples

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

Updates a physical connection.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A physical connection ID.

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

A physical connection object.

id
string or null <uuid>
name
string or null
mediaTypeValueId
string <uuid>
connectorTypeValueId
string or null <uuid>
length
number or null <double>
terminationAId
string <uuid>
terminationBId
string <uuid>
accessPolicyId
string <uuid>
Array of objects or null (ModifiableCustomAssetPropertyDto)
businessEntityId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mediaTypeValueId": "a1e7b9c7-ee0e-4789-8013-9872bb6776e7",
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5",
  • "length": 0.1,
  • "terminationAId": "e1481fde-2096-45f2-8cfb-44c9c1fe607a",
  • "terminationBId": "df50071e-bbe4-4f4d-a08d-33b735c85337",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "customPropertyValues": [
    ],
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mediaTypeValueId": "a1e7b9c7-ee0e-4789-8013-9872bb6776e7",
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5",
  • "length": 0.1,
  • "terminationAId": "e1481fde-2096-45f2-8cfb-44c9c1fe607a",
  • "terminationBId": "df50071e-bbe4-4f4d-a08d-33b735c85337",
  • "accessPolicyId": "b968355d-4dbb-453c-8c65-8fcb2d303aa7",
  • "customPropertyValues": [
    ],
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8"
}

Returns an individual physical connection.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A physical connection ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "mediaTypeValueId": "a1e7b9c7-ee0e-4789-8013-9872bb6776e7",
  • "mediaTypeValue": "string",
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5",
  • "connectorTypeValue": "string",
  • "length": 0.1,
  • "terminationADeviceAssetId": "84dc8a06-4c36-4b7e-bd1d-6a310117a249",
  • "terminationADeviceAssetDisplayName": "string",
  • "terminationADeviceAssetTypeId": "unknown",
  • "terminationAPortSideValueId": "1ef84c13-f008-4d53-8992-5014f0d94c11",
  • "terminationAPortSideValue": "string",
  • "terminationAPortAssetId": "c3275d89-786a-4902-991f-06e00a1eff92",
  • "terminationAPortDisplayName": "string",
  • "terminationADeviceAssetAccessState": "full",
  • "terminationBDeviceAssetId": "0fe6ab89-672b-4f85-974a-178820d5642c",
  • "terminationBDeviceAssetDisplayName": "string",
  • "terminationBDeviceAssetTypeId": "unknown",
  • "terminationBPortSideValueId": "23d93c82-3e0a-4ea5-a8a5-4169a5a7954f",
  • "terminationBPortSideValue": "string",
  • "terminationBPortAssetId": "10ef4af3-8611-41c1-a21c-851e386f798f",
  • "terminationBPortDisplayName": "string",
  • "terminationBDeviceAssetAccessState": "full",
  • "businessEntityId": "1d886985-ee9b-4d8b-ac80-1a634f3f33e8",
  • "businessEntityDisplayName": "string",
  • "businessEntityAccessState": "full"
}

Deletes a physical connection.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A physical connection ID.

header Parameters
api-version
string

Responses

PhysicalPorts

Creates a physical port and returns its ID.

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

A physical port object.

name
string or null
portNumber
integer <int32>
portTypeValueId
string or null <uuid>
portSideValueId
string or null <uuid>
id
string or null <uuid>
parentId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "portNumber": 0,
  • "portTypeValueId": "fdd0022b-43d1-449d-b439-23d0ce6fe7d9",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}

Response samples

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

Creates a physical port for a patch panel and returns its ID.

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

A physical port object for a patch panel.

parentId
string <uuid>
portSideValueId
string <uuid>
connectorTypeValueId
string or null <uuid>
id
string or null <uuid>
name
string or null
portNumber
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "portNumber": 0
}

Response samples

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

Creates multiple physical ports.

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

An object describing physical port details and the total number of physical ports to generate.

physicalPortCount
integer <int32>
portTypeValueId
string or null <uuid>
portSideValueId
string or null <uuid>
portNameTemplate
string or null
parentId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "physicalPortCount": 0,
  • "portTypeValueId": "fdd0022b-43d1-449d-b439-23d0ce6fe7d9",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "portNameTemplate": "string",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}

Updates multiple physical ports for a given device.

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

A object containing details required for updating multiple physical ports on a specific device.

parentId
string <uuid>
physicalPortIds
Array of strings or null <uuid> [ items <uuid > ]
updatePortName
boolean
portNameTemplate
string or null
updatePortType
boolean
portTypeValueId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "physicalPortIds": [
    ],
  • "updatePortName": true,
  • "portNameTemplate": "string",
  • "updatePortType": true,
  • "portTypeValueId": "fdd0022b-43d1-449d-b439-23d0ce6fe7d9"
}

Response samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "physicalPortIds": [
    ],
  • "updatePortName": true,
  • "portNameTemplate": "string",
  • "updatePortType": true,
  • "portTypeValueId": "fdd0022b-43d1-449d-b439-23d0ce6fe7d9"
}

Deletes physical ports.

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

An object containing a list of physical port IDs.

physicalPortIds
Array of strings or null <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "physicalPortIds": [
    ]
}

Creates multiple physical ports for a patch panel.

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

An object describing patch panel physical port details and the total number of physical ports to generate.

parentId
string <uuid>
portSideValueId
string <uuid>
connectorTypeValueId
string or null <uuid>
physicalPortCount
integer <int32>
portNameTemplate
string or null

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5",
  • "physicalPortCount": 0,
  • "portNameTemplate": "string"
}

Updates multiple physical ports for a given patch panel.

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

A object containing details required for updating multiple physical ports on a specific patch panel.

parentId
string <uuid>
physicalPortIds
Array of strings or null <uuid> [ items <uuid > ]
updatePortName
boolean
portNameTemplate
string or null
updateConnectorType
boolean
connectorTypeValueId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "physicalPortIds": [
    ],
  • "updatePortName": true,
  • "portNameTemplate": "string",
  • "updateConnectorType": true,
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5"
}

Response samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "physicalPortIds": [
    ],
  • "updatePortName": true,
  • "portNameTemplate": "string",
  • "updateConnectorType": true,
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5"
}

Updates a physical port.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A physical port ID.

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

A physical port object.

name
string or null
portNumber
integer <int32>
portTypeValueId
string or null <uuid>
portSideValueId
string or null <uuid>
id
string or null <uuid>
parentId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "portNumber": 0,
  • "portTypeValueId": "fdd0022b-43d1-449d-b439-23d0ce6fe7d9",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "portNumber": 0,
  • "portTypeValueId": "fdd0022b-43d1-449d-b439-23d0ce6fe7d9",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43"
}

Deletes a physical port.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A physical port ID.

header Parameters
api-version
string

Responses

Returns a list of physical ports.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a patch panel physical port.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A patch panel physical port ID.

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

A patch panel physical port object.

parentId
string <uuid>
portSideValueId
string <uuid>
connectorTypeValueId
string or null <uuid>
id
string or null <uuid>
name
string or null
portNumber
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "portNumber": 0
}

Response samples

Content type
application/json
{
  • "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
  • "portSideValueId": "594da55c-c25a-457e-a92c-dcda05177c21",
  • "connectorTypeValueId": "2c2774fa-cb6d-4013-9234-c66642a2abe5",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "portNumber": 0
}

Returns a list of physical ports with connection information.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PowerPath

Returns a list of assets that are directly receiving power from 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
[
  • {
    }
]

Returns the power path ancestry of power providing assets and associations down to 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
{
  • "powerPathDeviceAssets": [
    ],
  • "powerPathDeviceAssociations": [
    ]
}

PowerSourceAssociations

Creates a new power source association.

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

The power source association to be created.

id
string or null <uuid>
providingSourceAssetId
string <uuid>
consumingDestinationAssetId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "providingSourceAssetId": "c0955ca6-90dc-4f42-b019-42d16cfc1653",
  • "consumingDestinationAssetId": "228a4337-cc42-46ab-b434-5b78441ebe44"
}

Response samples

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

Returns a list of power associations of a powered asset.

Authorizations:
oauth2
query Parameters
providingSourceAssetId
string <uuid>

An optional ID of the power providing asset.

consumingDestinationAssetId
string <uuid>

An optional ID of the power consuming asset.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a power association.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

ID of the power association.

header Parameters
api-version
string

Responses

ProductProperties

Returns a list of product properties.

Authorizations:
oauth2
path Parameters
productId
required
string <uuid>

A product ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new product property and returns the new property.

Authorizations:
oauth2
path Parameters
productId
required
string <uuid>

ID of the product which owns this property.

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

The product property to be created.

id
string or null <uuid>
productPropertyKeyId
string <uuid>
productPropertyKeyName
string or null
value
any or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "productPropertyKeyId": "c2ab4dbd-9a6f-4f13-a84b-49bcd9813933",
  • "productPropertyKeyName": "string",
  • "value": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "productPropertyKeyId": "c2ab4dbd-9a6f-4f13-a84b-49bcd9813933",
  • "productPropertyKeyName": "string",
  • "value": null
}

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

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

ID of the product property to be updated.

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

The product property to be updated.

id
string or null <uuid>
productPropertyKeyId
string <uuid>
productPropertyKeyName
string or null
value
any or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "productPropertyKeyId": "c2ab4dbd-9a6f-4f13-a84b-49bcd9813933",
  • "productPropertyKeyName": "string",
  • "value": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "productPropertyKeyId": "c2ab4dbd-9a6f-4f13-a84b-49bcd9813933",
  • "productPropertyKeyName": "string",
  • "value": null
}

Deletes a product property.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A product property ID.

header Parameters
api-version
string

Responses

ProductPropertyKeys

Returns a list of all property keys for a product type.

Authorizations:
oauth2
path Parameters
productTypeId
required
string <uuid>

A product type ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ProductTypes

Returns a list of product types.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Products

Returns a paged list of products.

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

An optional asset type ID.

contract
boolean
Default: false

An optional flag for getting product 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 a new product.

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

A product.

id
string or null <uuid>
name
string or null
manufacturerId
string <uuid>
productTypeId
string <uuid>
Array of objects or null (ProductPropertyDto)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "manufacturerId": "9ffb4bad-5601-46bd-b5e1-ad29632f5942",
  • "productTypeId": "5b816809-bc2f-427f-abf0-cfc28532f595",
  • "productPropertyValues": [
    ]
}

Response samples

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

Returns a product.

Authorizations:
oauth2
query Parameters
productName
required
string

A product's name.

manufacturerName
required
string

A manufacturer's name.

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

An asset type.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "manufacturerId": "9ffb4bad-5601-46bd-b5e1-ad29632f5942",
  • "manufacturerName": "string",
  • "dataSource": "productCloud"
}

Returns a product.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A product ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "manufacturerId": "9ffb4bad-5601-46bd-b5e1-ad29632f5942",
  • "productTypeId": "5b816809-bc2f-427f-abf0-cfc28532f595",
  • "manufacturerName": "string",
  • "productTypeName": "string",
  • "dataSource": "productCloud",
  • "productPropertyValues": [
    ],
  • "associatedAssetsCount": 0
}

Deletes a product.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A product ID.

header Parameters
api-version
string

Responses

Updates a product and returns the updated product.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A product ID.

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

A product.

id
string or null <uuid>
name
string or null
manufacturerId
string <uuid>
productTypeId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "manufacturerId": "9ffb4bad-5601-46bd-b5e1-ad29632f5942",
  • "productTypeId": "5b816809-bc2f-427f-abf0-cfc28532f595"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "manufacturerId": "9ffb4bad-5601-46bd-b5e1-ad29632f5942",
  • "productTypeId": "5b816809-bc2f-427f-abf0-cfc28532f595"
}

RackSearch

Returns a list of Rack IDs.

Authorizations:
oauth2
query Parameters
layoutId
string <uuid>

Layout ID.

displayName
string

Display name of the rack.

row
integer <int32>

Row location of the rack.

column
integer <int32>

Column location of the rack.

minimumContiguousSpaceAvailable
number <double>

Minimum available contiguous rack space.

header Parameters
api-version
string

Responses

Response samples

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

RackSecurity

Returns rack security sensors for the given rack.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

A rack ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns all rack security sensors contained in a specific location.

Authorizations:
oauth2
path Parameters
locationId
required
string <uuid>

A location ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

RackShelf

Updates an asset and returns the updated asset.

The asset object must contain an Id, Name, ParentId, Location Data, and Dimensions.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
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"
object (MuteAlarmEventNotificationsSettingDto)
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",
  • "muteAlarmEventNotificationsSetting": {
    },
  • "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",
  • "muteAlarmEventNotificationsSetting": {
    },
  • "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"
}

ReportPages

Returns a list of report pages of a section.

Authorizations:
oauth2
path Parameters
section
required
string (Section)
Enum: "carbonFootprint" "alarmEvents"

The report section.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SavedSearches

Returns a list of saved searches for the current user.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a saved search and returns its ID.

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

A saved search object.

id
string <uuid>
userId
string or null <uuid>
name
string or null
search
any or null
source
string (SavedSearchSource)
Enum: "application" "user"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "name": "string",
  • "search": null,
  • "source": "application"
}

Response samples

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

Returns a list of global saved searches.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a user saved search.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A saved search ID.

header Parameters
api-version
string

Responses

Deletes a global saved search.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A saved search ID.

header Parameters
api-version
string

Responses

Search

Returns a list of assets that meet the requested criteria.

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

An object containing the parameters for querying and filtering asset data.

indexUid
string or null
q
string or null
filter
any or null
attributesToRetrieve
Array of strings or null
attributesToCrop
Array of strings or null
attributesToSearchOn
Array of strings or null
cropLength
integer or null <int32>
attributesToHighlight
Array of strings or null
cropMarker
string or null
highlightPreTag
string or null
highlightPostTag
string or null
facets
Array of strings or null
showMatchesPosition
boolean or null
sort
Array of strings or null
matchingStrategy
string or null
showRankingScore
boolean or null
showRankingScoreDetails
boolean or null
offset
integer or null <int32>
limit
integer or null <int32>
hitsPerPage
integer or null <int32>
page
integer or null <int32>
distinct
string or null
rankingScoreThreshold
number or null <double>

Responses

Request samples

Content type
{
  • "indexUid": "string",
  • "q": "string",
  • "filter": null,
  • "attributesToRetrieve": [
    ],
  • "attributesToCrop": [
    ],
  • "attributesToSearchOn": [
    ],
  • "cropLength": 0,
  • "attributesToHighlight": [
    ],
  • "cropMarker": "string",
  • "highlightPreTag": "string",
  • "highlightPostTag": "string",
  • "facets": [
    ],
  • "showMatchesPosition": true,
  • "sort": [
    ],
  • "matchingStrategy": "string",
  • "showRankingScore": true,
  • "showRankingScoreDetails": true,
  • "offset": 0,
  • "limit": 0,
  • "hitsPerPage": 0,
  • "page": 0,
  • "distinct": "string",
  • "rankingScoreThreshold": 0.1
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

SensorThreshold

Retrieve a list of sensor threshold event settings.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an sensor threshold setting and returns its ID.

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

A sensor threshold.

id
string or null <uuid>
sensorTypeId
string <uuid>
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
sensorTypeDescription
string or null
unitId
string or null <uuid>
unit
string or null
comparisonType1
string (ThresholdComparisonType)
Enum: "compareToConstant" "compareToAssetPropertyValue" "compareToAssetPropertyValuePercentage"
comparisonOperator1
string (ThresholdComparisonOperator)
Enum: "equalTo" "notEqualTo" "greaterThan" "greaterThanOrEqualTo" "lessThan" "lessThanOrEqualTo"
comparisonConstant1
number or null <double>
comparisonAssetPropertyKey1
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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"
comparisonAssetPropertyPercentage1
number or null <double>
comparisonType2
string (ThresholdComparisonType)
Enum: "compareToConstant" "compareToAssetPropertyValue" "compareToAssetPropertyValuePercentage"
comparisonOperator2
string (ThresholdComparisonOperator)
Enum: "equalTo" "notEqualTo" "greaterThan" "greaterThanOrEqualTo" "lessThan" "lessThanOrEqualTo"
comparisonConstant2
number or null <double>
comparisonAssetPropertyKey2
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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"
comparisonAssetPropertyPercentage2
number or null <double>
severity
string (Severity)
Enum: "normal" "information" "warning" "critical"
thresholdSource
string (ThresholdSource)
Enum: "application" "user"
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "assetTypeId": "unknown",
  • "sensorTypeDescription": "string",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "unit": "string",
  • "comparisonType1": "compareToConstant",
  • "comparisonOperator1": "equalTo",
  • "comparisonConstant1": 0.1,
  • "comparisonAssetPropertyKey1": "buswayTapOffNumber",
  • "comparisonAssetPropertyPercentage1": 0.1,
  • "comparisonType2": "compareToConstant",
  • "comparisonOperator2": "equalTo",
  • "comparisonConstant2": 0.1,
  • "comparisonAssetPropertyKey2": "buswayTapOffNumber",
  • "comparisonAssetPropertyPercentage2": 0.1,
  • "severity": "normal",
  • "thresholdSource": "application",
  • "enabled": true
}

Response samples

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

Updates a sensor threshold setting.

Authorizations:
oauth2
path Parameters
sensorThresholdId
required
string <uuid>

A sensor threshold ID.

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

A sensor threshold.

id
string or null <uuid>
sensorTypeId
string <uuid>
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"
sensorTypeDescription
string or null
unitId
string or null <uuid>
unit
string or null
comparisonType1
string (ThresholdComparisonType)
Enum: "compareToConstant" "compareToAssetPropertyValue" "compareToAssetPropertyValuePercentage"
comparisonOperator1
string (ThresholdComparisonOperator)
Enum: "equalTo" "notEqualTo" "greaterThan" "greaterThanOrEqualTo" "lessThan" "lessThanOrEqualTo"
comparisonConstant1
number or null <double>
comparisonAssetPropertyKey1
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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"
comparisonAssetPropertyPercentage1
number or null <double>
comparisonType2
string (ThresholdComparisonType)
Enum: "compareToConstant" "compareToAssetPropertyValue" "compareToAssetPropertyValuePercentage"
comparisonOperator2
string (ThresholdComparisonOperator)
Enum: "equalTo" "notEqualTo" "greaterThan" "greaterThanOrEqualTo" "lessThan" "lessThanOrEqualTo"
comparisonConstant2
number or null <double>
comparisonAssetPropertyKey2
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" "averageScope2CarbonEmissionOffsetPercent" "workloadType" "pueSetting" "templatePower"
comparisonAssetPropertyPercentage2
number or null <double>
severity
string (Severity)
Enum: "normal" "information" "warning" "critical"
thresholdSource
string (ThresholdSource)
Enum: "application" "user"
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sensorTypeId": "fc6ee140-82e3-4074-9d96-af1730536b04",
  • "assetTypeId": "unknown",
  • "sensorTypeDescription": "string",
  • "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed",
  • "unit": "string",
  • "comparisonType1": "compareToConstant",
  • "comparisonOperator1": "equalTo",
  • "comparisonConstant1": 0.1,
  • "comparisonAssetPropertyKey1": "buswayTapOffNumber",
  • "comparisonAssetPropertyPercentage1": 0.1,
  • "comparisonType2": "compareToConstant",
  • "comparisonOperator2": "equalTo",
  • "comparisonConstant2": 0.1,
  • "comparisonAssetPropertyKey2": "buswayTapOffNumber",
  • "comparisonAssetPropertyPercentage2": 0.1,
  • "severity": "normal",
  • "thresholdSource": "application",
  • "enabled": true
}

Deletes a sensor threshold.

Authorizations:
oauth2
path Parameters
sensorThresholdId
required
string <uuid>

A sensor threshold ID.

header Parameters
api-version
string

Responses

Updates a threshold enabled status.

Authorizations:
oauth2
path Parameters
sensorThresholdId
required
string <uuid>

A sensor threshold ID.

query Parameters
enabled
boolean

A boolean indicating the sensor threshold enabled status.

header Parameters
api-version
string

Responses

SensorTypeAssetType

Returns a list of sensor types.

Authorizations:
oauth2
query Parameters
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

Optional asset type to filter what sensor type maps are returned.

sensorTypeId
string <uuid>

Optional sensor type ID to filter what sensor type maps are returned.

sensorTypeValueType
string (SensorTypeValueType)
Enum: "numeric" "enum"

Optional sensor type value to filter what sensor types are returned.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sensors

Returns a list of asset sensors.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

query Parameters
sensorTypeIds
Array of strings <uuid> [ items <uuid > ]

An optional list of sensor types to filter what sensors are returned.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a simple collection of direct asset sensors.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

query Parameters
sensorTypeIds
Array of strings <uuid> [ items <uuid > ]

An optional list of sensor types to filter what sensors are returned.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes a sensor.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A sensor ID.

header Parameters
api-version
string

Responses

SensorsDailySummaries

Returns a list of numeric sensor daily summaries for each provided sensor ID for a specific UTC time range.

Authorizations:
oauth2
query Parameters
sensorIds
required
Array of strings <uuid> [ items <uuid > ]

A list of sensor IDs.

startTime
string <date-time>

The start time.

endTime
string <date-time>

The end time.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of numeric sensor daily summaries for each provided sensor ID for a given time range option.

Authorizations:
oauth2
path Parameters
timeRange
required
string (SensorDailySummaryTimeRange)
Enum: "last7Days" "last30Days" "last3Months" "last6Months" "last12Months"

A time range for the data.

query Parameters
sensorIds
required
Array of strings <uuid> [ items <uuid > ]

A list of sensor IDs.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of string sensor daily summaries for each provided sensor ID for a specific UTC time range.

Authorizations:
oauth2
query Parameters
sensorIds
required
Array of strings <uuid> [ items <uuid > ]

A list of sensor IDs.

startTime
string <date-time>

The start time.

endTime
string <date-time>

The end time.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of string sensor daily summaries for each provided sensor ID for a given time range option.

Authorizations:
oauth2
path Parameters
timeRange
required
string (SensorDailySummaryTimeRange)
Enum: "last7Days" "last30Days" "last3Months" "last6Months" "last12Months"

A time range for the data.

query Parameters
sensorIds
required
Array of strings <uuid> [ items <uuid > ]

A list of sensor IDs.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SensorsDataPoints

Returns a list of numeric sensor data points for each provided sensor ID for a specific UTC time range.

Authorizations:
oauth2
query Parameters
sensorIds
required
Array of strings <uuid> [ items <uuid > ]

A list of sensor IDs.

startTime
string <date-time>

The start time.

endTime
string <date-time>

The end time.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of numeric sensor data points for each provided sensor ID for a given time range option.

Authorizations:
oauth2
path Parameters
timeRange
required
string (SensorDataPointTimeRange)
Enum: "lastHour" "last4Hours" "last12Hours" "last24Hours" "last48Hours" "last3Days"

A time range for the data.

query Parameters
sensorIds
required
Array of strings <uuid> [ items <uuid > ]

A list of sensor IDs.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of string sensor data points for each provided sensor ID for a specific UTC time range.

Authorizations:
oauth2
query Parameters
sensorIds
required
Array of strings <uuid> [ items <uuid > ]

A list of sensor IDs.

startTime
string <date-time>

The start time.

endTime
string <date-time>

The end time.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of string sensor data points for each provided sensor ID for a given time range option.

Authorizations:
oauth2
path Parameters
timeRange
required
string (SensorDataPointTimeRange)
Enum: "lastHour" "last4Hours" "last12Hours" "last24Hours" "last48Hours" "last3Days"

A time range for the data.

query Parameters
sensorIds
required
Array of strings <uuid> [ items <uuid > ]

A list of sensor IDs.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ServiceNowCmdbConfigurationOverview

Returns the ServiceNow configuration overview.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "username": "string",
  • "password": "string",
  • "tokenUri": "string",
  • "importSetUri": "string",
  • "lastSyncDate": "2019-08-24T14:15:22Z"
}

Saves the ServiceNow configuration overview changes.

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

The ServiceNow configuration overview to be created.

clientId
string or null
clientSecret
string or null
username
string or null
password
string or null
tokenUri
string or null
importSetUri
string or null
lastSyncDate
string or null <date-time>

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "username": "string",
  • "password": "string",
  • "tokenUri": "string",
  • "importSetUri": "string",
  • "lastSyncDate": "2019-08-24T14:15:22Z"
}

ServiceNowCmdbConfigurationSchedule

Returns the ServiceNow configuration schedule.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "scheduleType": "none",
  • "cronExpression": "string"
}

Saves the ServiceNow configuration schedule changes.

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

The ServiceNow configuration schedule to be created.

scheduleType
string (ScheduleType)
Enum: "none" "daily" "weekly" "monthly" "now"
cronExpression
string or null

Responses

Request samples

Content type
application/json
{
  • "scheduleType": "none",
  • "cronExpression": "string"
}

ServiceNowCmdbIntegration

Resets the ServiceNow integration last sync date.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Initiates a ServiceNow integration sync.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Verifies the ServiceNow CMDB integration authentication configuration.

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

The ServiceNow CMDB integration authentication details to be tested.

clientId
string or null
clientSecret
string or null
username
string or null
password
string or null
tokenUri
string or null

Responses

Request samples

Content type
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "username": "string",
  • "password": "string",
  • "tokenUri": "string"
}

ServiceNowCmdbIntegrationAssetType

Returns a collection of ServiceNow CMDB integration asset types.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "allAssetTypesSelected": true,
  • "assetTypeIds": [
    ]
}

Saves the ServiceNow CMDB integration asset types.

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

The ServiceNow CMDB integration asset types to be saved.

allAssetTypesSelected
boolean
assetTypeIds
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" "tool" "chassisComponent" "pciCard" "heatSink" "trackingHardware" "genericComponent"

Responses

Request samples

Content type
application/json
{
  • "allAssetTypesSelected": true,
  • "assetTypeIds": [
    ]
}

ServiceNowCmdbIntegrationFacts

Returns a collection of ServiceNow CMDB integration fact settings.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Saves the ServiceNow CMDB integration fact settings.

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

The ServiceNow CMDB integration fact settings to be saved.

Array
id
string <uuid>
integrationAssetFact
string (IntegrationAssetFact)
Enum: "assetType" "dnsHostName" "id" "lifecycleState" "locationPath" "manufacturer" "model" "name" "operatingSystem" "powerProvidingAssetIds" "powerProvidingAssets" "rackElevation" "rackLocation" "rackLocationId" "rackSide" "roomLocation" "roomLocationId" "serialNumber"
integrationName
string or null
integrationSimplifiedDataType
string (IntegrationSimplifiedDataType)
Enum: "jsonStringArray" "stringData" "number"
enabled
boolean
allowUserToDisable
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

ShelvedAssets

Returns a list of assets that are in shelves of a given rack.

Authorizations:
oauth2
path Parameters
rackId
required
string <uuid>

A rack ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Software

Retrieves all software for an asset.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

An asset ID.

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
[
  • {
    }
]

SystemSettings

Updates a list of system settings.

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

A list of system settings to be updated.

Array
id
string (SystemSettingEnum)
Enum: "unknown" "languageIso" "temperatureUnit" "weightUnit" "lengthUnit" "googleMapApiKey" "objectStoreHostLocation" "objectStoreDataCollectorsBucket" "googleGeocodeApiEndpoint" "assetIndexingRetryCountLimit" "lockedDiscoveredExistingAssetKeyExpiryTimeMs" "accuWeatherApiKey" "assetTrackerMasterModuleUnreachableTimeoutSeconds" "latestLinuxAmd64DataCollectorFilename" "latestLinuxSupportedDataCollectorVersion" "shareProductModelData" "heatMapSensorValueStaleThresholdMinutes" "latestLinuxArm64DataCollectorFilename" "serviceNowCmdbIntegrationHttpRetryCount" "serviceNowCmdbIntegrationAssetBatchSize" "serviceNowCmdbIntegrationRetrySleepIntervalInSeconds" "enableCatalogDataFeedback" "smartViewHttpRetryCount" "smartViewRetrySleepIntervalInSeconds" "volumeUnit" "diagnosticDataShareEnabled" "aiAssistantEnabled"
value
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of system settings.

Authorizations:
oauth2
query Parameters
systemSettings
Array of strings (SystemSettingEnum)
Items Enum: "unknown" "languageIso" "temperatureUnit" "weightUnit" "lengthUnit" "googleMapApiKey" "objectStoreHostLocation" "objectStoreDataCollectorsBucket" "googleGeocodeApiEndpoint" "assetIndexingRetryCountLimit" "lockedDiscoveredExistingAssetKeyExpiryTimeMs" "accuWeatherApiKey" "assetTrackerMasterModuleUnreachableTimeoutSeconds" "latestLinuxAmd64DataCollectorFilename" "latestLinuxSupportedDataCollectorVersion" "shareProductModelData" "heatMapSensorValueStaleThresholdMinutes" "latestLinuxArm64DataCollectorFilename" "serviceNowCmdbIntegrationHttpRetryCount" "serviceNowCmdbIntegrationAssetBatchSize" "serviceNowCmdbIntegrationRetrySleepIntervalInSeconds" "enableCatalogDataFeedback" "smartViewHttpRetryCount" "smartViewRetrySleepIntervalInSeconds" "volumeUnit" "diagnosticDataShareEnabled" "aiAssistantEnabled"

A list of system setting IDs.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a system setting.

Authorizations:
oauth2
path Parameters
systemSettingId
required
string (SystemSettingEnum)
Enum: "unknown" "languageIso" "temperatureUnit" "weightUnit" "lengthUnit" "googleMapApiKey" "objectStoreHostLocation" "objectStoreDataCollectorsBucket" "googleGeocodeApiEndpoint" "assetIndexingRetryCountLimit" "lockedDiscoveredExistingAssetKeyExpiryTimeMs" "accuWeatherApiKey" "assetTrackerMasterModuleUnreachableTimeoutSeconds" "latestLinuxAmd64DataCollectorFilename" "latestLinuxSupportedDataCollectorVersion" "shareProductModelData" "heatMapSensorValueStaleThresholdMinutes" "latestLinuxArm64DataCollectorFilename" "serviceNowCmdbIntegrationHttpRetryCount" "serviceNowCmdbIntegrationAssetBatchSize" "serviceNowCmdbIntegrationRetrySleepIntervalInSeconds" "enableCatalogDataFeedback" "smartViewHttpRetryCount" "smartViewRetrySleepIntervalInSeconds" "volumeUnit" "diagnosticDataShareEnabled" "aiAssistantEnabled"

ID of system setting.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "unknown",
  • "value": "string"
}

Returns a data collector setting.

Authorizations:
oauth2
path Parameters
dataCollectorSetting
required
string (DataCollectorSetting)
Enum: "threadCount" "signalRTraceLevel" "deviceTimeout" "oidsToCheck" "defaultConfiguration" "httpDiscoveryTimeout" "httpMonitoringTimeout" "ntpDiscoveryTimeout" "ntpMonitoringTimeout" "tcpDiscoveryTimeout" "tcpMonitoringTimeout" "rimpDiscoveryTimeout" "ribclDiscoveryTimeout" "ribclMonitoringTimeout" "ribclDiscoveryLibraryRequestTimeout" "ribclMonitoringLibraryRequestTimeout" "snmpDiscoveryTimeout" "snmpMonitoringTimeout" "snmpDiscoveryLibraryRequestTimeout" "snmpMonitoringLibraryRequestTimeout" "ipmiDiscoveryTimeout" "ipmiMonitoringGenericRequestTimeout" "ipmiDiscoveryLibraryRequestTimeout" "sshDiscoveryTimeout" "sshMonitoringTimeout" "sshDiscoveryLibraryRequestTimeout" "sshMonitoringLibraryRequestTimeout" "wbemDiscoveryTimeout" "wbemLibraryRequestTimeout" "wbemMonitoringTimeout" "wmiDiscoveryTimeout" "wmiMonitoringGenericRequestTimeout" "vmwareDiscoveryTimeout" "vmwareMonitoringTimeout" "bacnetIpMonitoringTimeout" "modbusTcpMonitoringTimeout" "upDownTcpMonitoringTimeout" "upDownMonitoringTimeout" "ucsMonitoringGenericRequestTimeout" "ucsDiscoveryTimeout" "ucsConcurrentRequest" "ucsConnectionLifetime" "maxNumberOfParallelMonitoring" "snmpRetries" "skipPortScanning" "useSocketConnectPortScanner" "maxTimeBetweenSensorMonitoring" "maxTimeBetweenUpDownMonitoring" "minTimeBetweenSensorMonitoring" "minTimeBetweenUpDownMonitoring" "numberOfMonitoredSensorsInList" "numberOfMonitoredDeviceInReachabilityCheckList" "ixosDiscoveryTimeout" "ixosDiscoveryLibraryRequestTimeout" "ixosMonitoringLibraryRequestTimeout" "ixosMonitoringTimeout" "maxControlMonitoringRequestBatchSize" "snmpSetRetry" "snmpSetTimeout" "controlMonitoringTimeout" "maxFirmwareMonitoringRequestBatchSize" "firmwareMonitoringTimeout"

Name of data collector setting.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "dataCollectorSetting": "threadCount",
  • "value": "string"
}

Updates a data collector setting for all data collectors.

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

A data collector setting data object.

dataCollectorSetting
string (DataCollectorSetting)
Enum: "threadCount" "signalRTraceLevel" "deviceTimeout" "oidsToCheck" "defaultConfiguration" "httpDiscoveryTimeout" "httpMonitoringTimeout" "ntpDiscoveryTimeout" "ntpMonitoringTimeout" "tcpDiscoveryTimeout" "tcpMonitoringTimeout" "rimpDiscoveryTimeout" "ribclDiscoveryTimeout" "ribclMonitoringTimeout" "ribclDiscoveryLibraryRequestTimeout" "ribclMonitoringLibraryRequestTimeout" "snmpDiscoveryTimeout" "snmpMonitoringTimeout" "snmpDiscoveryLibraryRequestTimeout" "snmpMonitoringLibraryRequestTimeout" "ipmiDiscoveryTimeout" "ipmiMonitoringGenericRequestTimeout" "ipmiDiscoveryLibraryRequestTimeout" "sshDiscoveryTimeout" "sshMonitoringTimeout" "sshDiscoveryLibraryRequestTimeout" "sshMonitoringLibraryRequestTimeout" "wbemDiscoveryTimeout" "wbemLibraryRequestTimeout" "wbemMonitoringTimeout" "wmiDiscoveryTimeout" "wmiMonitoringGenericRequestTimeout" "vmwareDiscoveryTimeout" "vmwareMonitoringTimeout" "bacnetIpMonitoringTimeout" "modbusTcpMonitoringTimeout" "upDownTcpMonitoringTimeout" "upDownMonitoringTimeout" "ucsMonitoringGenericRequestTimeout" "ucsDiscoveryTimeout" "ucsConcurrentRequest" "ucsConnectionLifetime" "maxNumberOfParallelMonitoring" "snmpRetries" "skipPortScanning" "useSocketConnectPortScanner" "maxTimeBetweenSensorMonitoring" "maxTimeBetweenUpDownMonitoring" "minTimeBetweenSensorMonitoring" "minTimeBetweenUpDownMonitoring" "numberOfMonitoredSensorsInList" "numberOfMonitoredDeviceInReachabilityCheckList" "ixosDiscoveryTimeout" "ixosDiscoveryLibraryRequestTimeout" "ixosMonitoringLibraryRequestTimeout" "ixosMonitoringTimeout" "maxControlMonitoringRequestBatchSize" "snmpSetRetry" "snmpSetTimeout" "controlMonitoringTimeout" "maxFirmwareMonitoringRequestBatchSize" "firmwareMonitoringTimeout"
value
string or null

Responses

Request samples

Content type
application/json
{
  • "dataCollectorSetting": "threadCount",
  • "value": "string"
}

UserConversationHistory

Returns the user conversation history.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes the entire user conversation history.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Creates a conversation history.

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

The user conversation history to create.

id
string or null <uuid>
name
string or null
messages
string or null

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "messages": "string"
}

Updates a conversation history.

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

The user conversation history to update.

id
string or null <uuid>
name
string or null
messages
string or null

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "messages": "string"
}

Deletes specific user conversation history item.

Authorizations:
oauth2
path Parameters
userConversationHistoryId
required
string <uuid>

The user search conversation history id to delete.

header Parameters
api-version
string

Responses

UserInboxNotifications

Returns the user inbox status.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "userInboxNotificationStatus": "allRead"
}

Update user inbox notifications to Read or Unread.

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

An object containing a list of user inbox notification IDs and a new NotificationStatus.

userInboxNotificationIds
Array of strings or null <uuid> [ items <uuid > ]
notificationStatus
string (NotificationStatus)
Enum: "unread" "read"

Responses

Request samples

Content type
application/json
{
  • "userInboxNotificationIds": [
    ],
  • "notificationStatus": "unread"
}

Deletes a set of user inbox notifications.

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

A list of user inbox notification IDs.

Array
string <uuid>

Responses

Request samples

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

Returns the user inbox notification content. Also updates the user inbox notification status to Read when markAsRead is true.

Authorizations:
oauth2
path Parameters
userInboxNotificationId
required
string <uuid>

A user inbox notification ID.

query Parameters
markAsRead
boolean
Default: true

An optional flag for updating user inbox notification status to Read.

header Parameters
api-version
string

Responses

UserProductImages

Returns product images as a list.

Authorizations:
oauth2
path Parameters
productId
required
string <uuid>

A product ID.

query Parameters
includeImageBase64String
boolean
Default: false

A optional flag to return the image base 64 string.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Uploads a product image and its associated data.

Authorizations:
oauth2
path Parameters
productId
required
string <uuid>

A product ID.

header Parameters
api-version
string
Request Body schema: multipart/form-data
productImagePosition
string (ProductImagePosition)
Enum: "front" "rear"
imageFile
string <binary>

Image file to upload.

Responses

Response samples

Content type
No sample

Deletes a product image.

Authorizations:
oauth2
path Parameters
id
required
string <uuid>

A product image ID.

header Parameters
api-version
string

Responses

UserSearchHistory

Returns the user search history.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes the entire search history.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Creates a search history item.

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

The search history to create.

id
string or null <uuid>
searchValue
string or null
searchType
string (SearchType)
Enum: "quick" "ai"

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "searchValue": "string",
  • "searchType": "quick"
}

Deletes search history items.

Authorizations:
oauth2
path Parameters
userSearchHistoryId
required
string <uuid>

The search history id to delete.

header Parameters
api-version
string

Responses

Users

Returns an array of users.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns an array of users associated with 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
[
  • {
    }
]

Returns an array of users associate with an access policy or associated to a group that is associated with an access policy. All users of Administrator role are included.

Authorizations:
oauth2
path Parameters
accessPolicyId
required
string <uuid>

An access policy ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WatchedAssets

Returns a list of user watched assets for notifications.

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
[
  • {
    }
]

WebInterfaceAddress

Returns the web interface address.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
"string"

Widget

Returns property names and values for the AssetPropertyListWidget.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns names and values for the AssetLifecycleWidget.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns names and values for the AssetsByTypeWidget.

Authorizations:
oauth2
path Parameters
locationId
required
string <uuid>

A location ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns status names and number of contained assets for the AssetStatusWidget.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a collection of network widget IP address information.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WorkNoteDocuments

Removes an association between a work note and document.

Authorizations:
oauth2
path Parameters
workNoteDocumentId
required
string <uuid>

A work note document ID.

header Parameters
api-version
string

Responses

WorkNotes

Returns a list of work notes for the given asset.

Authorizations:
oauth2
path Parameters
assetId
required
string <uuid>

An asset ID.

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
[
  • {
    }
]

Returns an individual work note.

Authorizations:
oauth2
path Parameters
workNoteId
required
string <uuid>

A work note ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "workNoteContent": null,
  • "importance": "low",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "userName": "string",
  • "workNoteDocuments": [
    ],
  • "createdDateTime": "2019-08-24T14:15:22Z",
  • "updatedDateTime": "2019-08-24T14:15:22Z"
}

Deletes a work note.

Authorizations:
oauth2
path Parameters
workNoteId
required
string <uuid>

A work note ID.

header Parameters
api-version
string

Responses

Updates a work note and returns the updated work note.

Authorizations:
oauth2
path Parameters
workNoteId
required
string <uuid>

A work note ID.

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

A work note.

id
string or null <uuid>
assetId
string <uuid>
workNoteContent
any or null
importance
string (Importance)
Enum: "low" "medium" "high"
documentDetailIds
Array of strings or null <uuid> [ items <uuid > ]
workNoteContentHtml
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "workNoteContent": null,
  • "importance": "low",
  • "documentDetailIds": [
    ],
  • "workNoteContentHtml": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "workNoteContent": null,
  • "importance": "low",
  • "documentDetailIds": [
    ],
  • "workNoteContentHtml": "string"
}

Creates a work note.

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

A work note.

id
string or null <uuid>
assetId
string <uuid>
workNoteContent
any or null
importance
string (Importance)
Enum: "low" "medium" "high"
documentDetailIds
Array of strings or null <uuid> [ items <uuid > ]
workNoteContentHtml
string or null

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "workNoteContent": null,
  • "importance": "low",
  • "documentDetailIds": [
    ],
  • "workNoteContentHtml": "string"
}

Response samples

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

WorkOrderItemStatuses

Manually completes work order items.

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

A list of work order item IDs.

Array
string <uuid>

Responses

Request samples

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

Response samples

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

WorkOrders

Returns a work order.

Authorizations:
oauth2
path Parameters
workOrderId
required
string <uuid>

A work order ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "workOrderTypeId": "firmwareUpdate",
  • "name": "string",
  • "username": "string",
  • "status": "completed",
  • "startTimestamp": "2019-08-24T14:15:22Z",
  • "endTimestamp": "2019-08-24T14:15:22Z",
  • "result": [
    ]
}

Deletes a work order.

Authorizations:
oauth2
path Parameters
workOrderId
required
string <uuid>

A work order ID.

header Parameters
api-version
string

Responses

Returns a ServiceNow CMDB sync now work order.

Authorizations:
oauth2
path Parameters
workOrderId
required
string <uuid>

A work order ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "workOrderTypeId": "firmwareUpdate",
  • "name": "string",
  • "username": "string",
  • "status": "completed",
  • "startTimestamp": "2019-08-24T14:15:22Z",
  • "endTimestamp": "2019-08-24T14:15:22Z",
  • "result": [
    ],
  • "serviceNowCmdbIntegrationWorkOrderStatus": "successfulAssetSync"
}

Returns a ServiceNow CMDB scheduled sync work order.

Authorizations:
oauth2
path Parameters
workOrderId
required
string <uuid>

A work order ID.

header Parameters
api-version
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "workOrderTypeId": "firmwareUpdate",
  • "name": "string",
  • "username": "string",
  • "status": "completed",
  • "startTimestamp": "2019-08-24T14:15:22Z",
  • "endTimestamp": "2019-08-24T14:15:22Z",
  • "result": [
    ],
  • "serviceNowCmdbIntegrationWorkOrderStatus": "successfulAssetSync"
}

Deletes all completed work orders.

Authorizations:
oauth2
header Parameters
api-version
string

Responses

Manually completes a work order.

Authorizations:
oauth2
path Parameters
workOrderId
required
string <uuid>

a work order ID.

header Parameters
api-version
string

Responses