Skip to main content
API docs by Redocly

Smart View Assets APIs (1.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

Empower yourself with Smart View Assets API. These provide the ability to consumers to list infra asset, fetch infra asset details, get affected customer assets based on asset id. Given an account number, IBX code, cage and asset classification (Electrical, Mechanical), information about the asset in a hierarchical structure comprising of the category, template and asset is returned. Given a category and a template, a list of assets is returned.

Smart View Assets

Access Asset Information

get assets list information

This endpoint returns information about asset in a hierarchical structure ( category / template / asset ) based on the input account number, IBX code, cage and asset classification (Electrical, Mechanical).

query Parameters
accountNo
required
string

customer account number

ibx
required
string

ibx code

classification
required
string
Enum: "Electrical" "Mechanical"

asset classification (Electrical, Mechanical)

cages
Array of strings

cage unique space id to be used to filter the assets list assumed to be all cage unique space id if no value is sent.

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Responses

Response Schema: application/json
object
classification
string

asset classification for the Electrical and Mechanical

Array of objects (Category)
Array
Array of objects (Template)
categoryName
string
object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

get details for an asset.

This endpoint returns information about asset details including tag points lists for a given asset identifier.

query Parameters
accountNo
required
string

customer account number

ibx
required
string

ibx code

classification
required
string

asset classification (Electrical, Mechanical)

assetId
required
string

asset id

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Responses

Response Schema: application/json
object
assetId
string

asset id for the Asset

assetType
string

Template Name for the asset

userPrefTimeZone
string

Time zone for the user

Array of objects (TagPointDataArray)

List of tag points for the Asset

Array
value
string

Current data value for the tag point

tagId
string

ID for the tagPoint - Unique Identifier for the Tag Point

tagDisplayName
string

Generic label for the tag point

uom
string

Unit of measure for the data value for the tag point

alarmStatus
string

Generic label for the tag point

readingTime
string

date time when the tag point value was read from the device.

lastMaintenanceDate
string

Datetime when the machine had its last maintenance

manufacturerName
string

Manufacturer name for the Asset

equipmentModelNumber
string

Equipment Model Number

equipmentSerialNumber
string

Equipment Serial Number

alarmLastTriggeredTime
string

Datetime when the latest alarm was triggered on the asset

alarmLastProcessedTime
string

Datetime when the latest alarm was processed on the asset

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

get asset details

This endpoint returns information about assets details including the assets tag points list for the given multiple asset identifiers.

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Request Body schema: application/json

request schema

accountNo
string

customer account number

ibx
string

ibx code

classification
string

asset classification

assetIds
Array of strings

Responses

Response Schema: application/json
object
totalCount
integer

total number of assets that match the request filters

Array of objects (AssetDetails)
Array
assetId
string

asset id for the Asset

assetType
string

Template Name for the asset

userPrefTimeZone
string

Time zone for the user

Array of objects (TagPointDataArray)

List of tag points for the Asset

lastMaintenanceDate
string

Datetime when the machine had its last maintenance

manufacturerName
string

Manufacturer name for the Asset

equipmentModelNumber
string

Equipment Model Number

equipmentSerialNumber
string

Equipment Serial Number

alarmLastTriggeredTime
string

Datetime when the latest alarm was triggered on the asset

alarmLastProcessedTime
string

Datetime when the latest alarm was processed on the asset

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages

Request samples

Content type
application/json
{
  • "accountNo": "string",
  • "ibx": "string",
  • "classification": "string",
  • "assetIds": [
    ]
}

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

get affected customers assets hierarchy

The endpoint returns information regarding the affected assets of customers for a given asset identifier

query Parameters
accountNo
required
string

customer account number

ibx
required
string

ibx code

assetId
required
string

asset id

classification
required
string
Enum: "Electrical" "Mechanical"

asset classification(Electrical, Mechanical)

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Responses

Response Schema: application/json
object
Array of objects (Cages)
Array
name
string

Cage Unique Space Id

type
string

type of the asset

Array of objects (Cabinets)
Array of objects (CircuitsMapWithCage)
Array
name
string
Value: 877483
type
string
Value: "circuit"
object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

Search for Assets matching identifiers

This endpoint is used to search for assets using wild card search patterns matching the asset identifier.

query Parameters
accountNo
required
string

Customer Account Number

ibx
required
string

IBX Code

searchString
required
string

Search String

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Responses

Response Schema: application/json
object
totalCount
integer
Array of objects (AssetsArray)
Array
assetId
string

The assetid is the circuit number, sensor id, asset id, asset id for type circuit, sensor, electrical and mechanical resp.

type
string
assetLabel
string

Asset Label is the Circuit display label, Sensor ID, and Asset ID for types circuit, sensor, electrical and mechanical resp.

assetClassification
string

Asset classification is electrical or mechanical

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the possible messages possible messages

Response samples

Content type
application/json
{
  • "payLoad": {
    },
  • "status": {
    }
}

obtain latest tag point data

This endpoint fetches and provides the most recent tag point information for a given tag identifier.

query Parameters
accountNo
required
string

customer account number

ibx
required
string

ibx code

tagid
required
string

tag id is the unique identifier for the tag point

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Responses

Response Schema: application/json
Array of objects (TagPointDataArrayCurrent)
Array
value
string

Current data value for the tag point

tagId
string

ID for the tagPoint - Unique Identifier for the Tag Point

tagDisplayName
string

Generic label for the tag point

uom
string

Unit of measure for the data value for the tag point

readingTime
string

date time when the tag point value was read from the device.

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the

Response samples

Content type
application/json
{
  • "payLoad": [
    ],
  • "status": {
    }
}

get current tag points data

This endpoint fetches the latest read values for given tag points using given tag identifiers.

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Request Body schema: application/json
accountNo
string

customer account number

tagIds
Array of strings <= 1000 characters
ibx
string

ibx code

Responses

Response Schema: application/json
Array of objects (TagPointDataArrayCurrent)
Array
value
string

Current data value for the tag point

tagId
string

ID for the tagPoint - Unique Identifier for the Tag Point

tagDisplayName
string

Generic label for the tag point

uom
string

Unit of measure for the data value for the tag point

readingTime
string

date time when the tag point value was read from the device.

object
type
string
Value: "INFO"

[INFO|ERROR] are the possible values

statuscode
number

[1000|3001|3002|3003|4000] are the possible status codes

msg
string

[Ok|Permission Denied|Invalid Account number|Invalid IBX|Invalid LevelType|Invalid LevelValue|Invalid Interval|Invalid From/To Date|INVALID_SESSION|INVALID_SESSION_IBX|INTERNAL_ERROR] are the

Request samples

Content type
application/json
{
  • "accountNo": "string",
  • "tagIds": [
    ],
  • "ibx": "string"
}

Response samples

Content type
application/json
{
  • "payLoad": [
    ],
  • "status": {
    }
}