Skip to main content
Index

Asset APIs

GET Asset List

GET /asset/v1/list

 Method  GET
 URL or End Point  /asset/v1/list
 Headers  Authorization, Content-Type
 Query Parameters  accountNo, ibx, classification cages
 Body  Not applicable

 

Given an account number, IBX code, cage and asset classification (Electrical, Mechanical), returns information about asset in a hierarchical structure comprising of the category, template and asset. Given a category and a template, a list of assets is returned. The response includes the assetId, IBX, alarmStatus, resiliencyStatus, alarmLastTriggeredTime, alarmLastClearedTime information for each asset.

 

If you are unaware of how to obtain an authorization key, refer Requesting Access and Refresh tokens under Getting Started.

 

The following screenshots show a sample curl request to get the assets list for account number 1 and a JSON response containing the result. 

 

curl -X 

GET "https://api.equinix.com/asset/v1/list?accountNo=1&ibx=CH1&classification=Mechanical"

-H "content-type: application/json"

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2' 

 

The description of the query parameters is as follows:

 

Query Parameter Name Mandatory Type Example Applicable values Description
accountNo Y string 1234   Customer account number
ibx Y string AB2  

Name of the IBX for which data is being requested.

classification Y string Electrical Electrical, Mechanical Enum value indication the asset classification for which to fetch the list.
cages N Array(string)

CH1:05:000550

 

An array of 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.

 

{
    "payLoad": {
        "classification": "Mechanical",
        "categories": [
            {
                "templates": [
                    {
                        "assets": [
                            {
                                "assetId": "CH1.FC 2",
                                "ibx": "CH1",
                                "alarmStatus": "OK",
                                "resiliencyStatus": "Resiliency Not Configured",
                                "alarmLastTriggeredTime": null,
                                "alarmLastClearedTime": null
                            }
                        ],
                        "templateId": "Fan Coil"
                    },
                    {
                        "assets": [],
                        "templateId": "Fans"
                    },
                    {
                        "assets": [],
                        "templateId": "Humidifier"
                    },
                    {
                        "assets": [],
                        "templateId": "RAH with Chilled Water"
                    }
                ],
                "categoryName": "Air Handling"
            },
            {
                "templates": [
                    {
                        "assets": [],
                        "templateId": "Chiller Air Cooled"
                    },
                    {
                        "assets": [
                            {
                                "assetId": "CH1.Lead Chilled Water Manager",
                                "ibx": "CH1",
                                "alarmStatus": "NOT OK",
                                "resiliencyStatus": "Resiliency Not Configured",
                                "alarmLastTriggeredTime": "Feb 15,2019 02:59 AM",
                                "alarmLastClearedTime": "Currently Active"
                            }
                        ],
                        "templateId": "Cooling Plant"
                    }
                ],
                "categoryName": "Cooling"
            },
            {
                "templates": [
                    {
                        "assets": [
                            {
                                "assetId": "CH1.VESDA",
                                "ibx": "CH1",
                                "alarmStatus": "OK",
                                "resiliencyStatus": "Resiliency Not Configured",
                                "alarmLastTriggeredTime": "Aug 21,2018 10:52 AM",
                                "alarmLastClearedTime": "Aug 21,2018 01:52 PM"
                            }
                        ],
                        "templateId": "Early Smoke Detection"
                    },
                    {
                        "assets": [
                            {
                                "assetId": "CH1.Fire Alarm System",
                                "ibx": "CH1",
                                "alarmStatus": "OK",
                                "resiliencyStatus": "Resiliency Not Configured",
                                "alarmLastTriggeredTime": "Feb 01,2019 11:25 AM",
                                "alarmLastClearedTime": "Feb 01,2019 12:25 PM"
                            }
                        ],
                        "templateId": "Fire Alarm"
                    }
                ],
                "categoryName": "Fire, Smoke Detection"
            },
            {
                "templates": [
                    {
                        "assets": [],
                        "templateId": "Leak Detection"
                    }
                ],
                "categoryName": "Leak Detection"
            }
        ]
    },
    "status": {
        "type": "INFO",
        "statuscode": "1000",
        "msg": "OK"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
 classification string Electrical, Mechanical Indicates the asset classification for Electrical and mechanical assets.
categories an array of a category object   Indicates the category of the specified asset classification.
templates array of a category object   The template specifies the blueprint of an asset.
categoryName string Air Handling, Cooling, Fire smoke detection, Leak detection Indicates the category name of the specified asset classification.
assets array of a category object    
templateId string Fans, Fan coil, Humidifier Unique identifier for the template
assetId string CH1.FC2 Unique identifier for the template
ibx string CH1 IBX code for the IBX in which the asset is located.
alarmStatus string OK

Alarm status for the asset.

assets.resiliencyStatus string Resiliency not configured Resiliency status for the asset.
assets.alarmLastTriggeredTime string null, "Feb 15,2019 02:59 AM" Date-time when the latest alarm on the asset was triggered.
assets.alarmLastClearedTime string null, "Currently active", "Feb 15,2019 02:59 AM" Date-time when the latest alarm on the asset was cleared.

 

If you get the “Access Denied” error, contact your local Equinix Service Desk for Equinix IBX SmartView Portal access.

GET Asset Details

GET /asset/v1/details

 Method  GET
 URL or End Point  /asset/v1/details
 Headers  Authorization, Content-Type
 Query Parameters  accountNo, ibx, classification assetId
 Body  Not applicable

 

Given an account number, IBX code, asset classification (Electrical, Mechanical), and assetId asset details including tag points list. The response includes the assetId, IBX, alarmStatus, resiliencyStatus, alarmLastTriggeredTime, alarmLastClearedTime information for each asset.

 

If you are unaware of how to obtain an authorization key, refer Requesting Access and Refresh tokens under Getting Started.

 

The following screenshots show a sample curl request to get assets details for the account number 1 and a JSON response containing result. 

 

curl -X 

GET "https://api.equinix.com/asset/v1/details?accountNo=1&ibx=CH1&assetId=CH1.FC%202&classification=Mechanical"     

-H "content-type: application/json"

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2' 

 

The description of the query parameters is as follows:

 

Query Parameter Name Mandatory Type Example Applicable values Description
accountNo Y string 1234   Customer account number
ibx Y string AB2  

Name of the IBX for which data is being requested.

classification Y string Mechanical Electical, Mechanical Enum value indication the asset classification for which to fetch the list for.
assetId Y string AB2.FC1   Unique identifier for the asset.

 

{
    "payLoad": {
        "assetId": "CH1.FC 2",
        "assetType": "",
        "userPrefTimeZone": "America/New_York",
        "tags": [],
        "lastMaintenanceDate": "Dec 19,2018",
        "manufacturerName": "",
        "equipmentModelNumber": "",
        "equipmentSerialNumber": "",
        "alarmLastTriggeredTime": null,
        "alarmLastProcessedTime": null
    },
    "status": {
        "type": "INFO",
        "statuscode": "1000",
        "msg": "OK"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
 assetId string CH1.FC2 Indicates the unique identifier for the asset.
assetType string

cooling  

Indicates the template name for the asset.
userPrefTimeZone string "America/New_York" Timezone for the user.
tags array of tag object   Specifies the list of tag points for the asset.
value string 4.9 The current data value for the tag point.
tagId string CH1.Chiller1:evapleavingwatertemperature Unique identifier for the tag point.
tagDisplayName string Evaporator leaving water temperature The display name for the tag point.
uom string oC Unit of measure for the tag point data value.
alarmStatus string OK

Alarm status for the tag point.

readingTime string

20170907060449

Date-time when the tag point value was read from the device.
lastMaintenanceDate string "Dec 19,2018" Date-time when the asset had its last maintenance.
manufacturerName string SMARDT Asset manufacturer name.
equipmentModelNumber string

SACAC110-3EXX-2A1-16A-010

Equipment model number.
equipmentSerialNumber string

FF0010I233Q1276

Equipment serial number.
alarmLastTriggeredTime string Aug 21,2017 04:38 AM Date-time when the latest alarm was triggered on the asset.
alarmLastProcessedTime string

Aug 21,2017 05:52 AM

Date-time when the latest alarm was processed on the asset.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix IBX SmartView Portal access.

POST Asset Details

POST /asset/v1/details

 Method  POST
 URL or End Point  /asset/v1/details
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  accountNo, ibx, classification, assetId list

 

Given an account number, IBX code, asset classification (Electrical, Mechanical), and assetId list, return the asset details including tag points list for each asset. The response includes the assetId, IBX, alarmStatus, resiliencyStatus, alarmLastTriggeredTime, alarmLastClearedTime information for each asset. 

 

If you are unaware of how to obtain an authorization key, refer Requesting Access and Refresh tokens under Getting Started.

 

The following screenshots show a sample curl request to get assets details for the account number 1 and a JSON response containing result. 

 

curl -X 

POST "https://api.equinix.com/asset/v1/details -H 'Authorization: Bearer 21T65PfrRgJK5guVYceyLnSLRl1s" 
-H "content-type: application/json"

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2' 

-d '{
  "accountNo": "1",
  "ibx": "CH1",
  "assetIds": [
    "CH1.FC 2",
    "CH1.Lead Chilled Water Manager"
  ],
  "classification":"Mechanical"
}'

 

The description of the request payload is as follows:

 

Body Parameter Name Mandatory Type Example Applicable values Description
accountNo Y string 1234   Customer account number
ibx Y string AB2  

Name of the IBX for which data is being requested.

classification Y string Mechanical Electical, Mechanical Enum value indication the asset classification for which to fetch the list for.
assetIds Y array of assetid's AB2.FC1   Unique identifier for the asset.

 

{
    "payLoad": {
        "totalCount": 2,
        "assetDetails": [
            {
                "assetId": "CH1.FC 2",
                "assetType": "",
                "userPrefTimeZone": "America/New_York",
                "tags": [],
                "lastMaintenanceDate": "Dec 19,2018",
                "manufacturerName": "",
                "equipmentModelNumber": "",
                "equipmentSerialNumber": "",
                "alarmLastTriggeredTime": null,
                "alarmLastProcessedTime": null
            },
            {
                "assetId": "CH1.Lead Chilled Water Manager",
                "assetType": "",
                "userPrefTimeZone": "America/New_York",
                "tags": [
                    {
                        "value": "42.26",
                        "tagId": "CH1.Lead Chilled Water Manager:primarychilledwatersupplytemperature",
                        "tagDisplayName": "Primary Chilled Water Supply Temperature",
                        "uom": "°F",
                        "alarmStatus": "NOT OK",
                        "readingTime": "20190218205638"
                    }
                ],
                "lastMaintenanceDate": "",
                "manufacturerName": "",
                "equipmentModelNumber": "",
                "equipmentSerialNumber": "",
                "alarmLastTriggeredTime": "Dec 31,1969 07:00 PM",
                "alarmLastProcessedTime": "Currently Active"
            }
        ]
    },
    "status": {
        "type": "INFO",
        "statuscode": "1000",
        "msg": "OK"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
totalCount number 2 Total number of assets that match the request.
assetDetails array of assetdetails object   Asset details, including the tag points with data for the asset.
 assetId string CH1.FC2 Indicates the unique identifier for the asset.
assetType string

cooling  

Indicates the template name for the asset.
userPrefTimeZone string "America/New_York" Timezone for the user.
tags array of tag object   Specifies the list of tag points for the asset.
tags.value string 4.9 Current data value for the tag point.
tags.tagId string CH1.Chiller1:evapleavingwatertemperature Unique identifier for the tag point.
tags.tagDisplayName string Evaporator leaving water temperature Display name for the tag point.
tags.uom string oC Unit of measure for the tag point data value.
tags.alarmStatus string OK

Alarm status for the tag point.

tags.readingTime string

20170907060449

Date-time when the tag point value was read from the device.
lastMaintenanceDate string "Dec 19,2018" Date-time when the asset had its last maintenance.
manufacturerName string SMARDT Asset manufacturer name.
equipmentModelNumber string

SACAC110-3EXX-2A1-16A-010

Equipment model number.
equipmentSerialNumber string

FF0010I233Q1276

Equipment serial number.
alarmLastTriggeredTime string Aug 21,2017 04:38 AM Date-time when the latest alarm was triggered on the asset.
alarmLastProcessedTime string

Aug 21,2017 05:52 AM

Date-time when the latest alarm was processed on the asset.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix IBX SmartView Portal access.

GET Affected Locations For a Given Asset

GET /asset/v1/tagpoint/affected-assets

 Method  GET
 URL or End Point  /asset/v1/tagpoint/affected-assets
 Headers  Authorization, Content-Type
 Query Parameters  accountNo, ibx, classification assetId
 Body  Not applicable

 

Given an account number, IBX code, and an assetId, return the corresponding locations hierarchy of related assets.

 

If you are unaware of how to obtain an authorization key, refer Requesting Access and Refresh tokens under Getting Started.

 

The following screenshots show a sample curl request to get assets location hierarchy details for the account number 1 and a JSON response containing result. 

 

curl -X 

GET "https://api.equinix.com/asset/v1/tagpoint/affected-assets?accountNo=1&ibx=CH1&classification=Electrical&assetId=CH1.PDU-1-2A"     

-H "content-type: application/json"

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2' 

 

The description of the query parameters is as follows:

 

Query Parameter Name Mandatory Type Example Applicable values Description
accountNo Y string 1234   Customer account number
ibx Y string AB2  

Name of the IBX for which data is being requested.

classification Y string Mechanical Electical, Mechanical Enum value indication the asset classification for which to fetch the list for.
assetId Y string AB2.FC1   Unique identifier for the asset.

 

{
    "payLoad": {
        "cages": [
            {
                "name": "CH1:05:FE00021",
                "type": "cage",
                "cabinets": [
                    {
                        "name": "CH1:05:FE00021:0101",
                        "type": "cabinet",
                        "circuits": [
                            {
                                "name": "20744057",
                                "type": "circuit"
                            }
                        ]
                    }
                ],
                "circuits": null
            },
            {
                "name": "CH1:05:BCM000",
                "type": "cage",
                "cabinets": [
                    {
                        "name": "CH1:05:BCM000:9999",
                        "type": "cabinet",
                        "circuits": [
                            {
                                "name": "15137957",
                                "type": "circuit"
                            },
                            {
                                "name": "20679433",
                                "type": "circuit"
                            },
                            {
                                "name": "20626057",
                                "type": "circuit"
                            }
                        ]
                    }
                ],
                "circuits": null
            }
        ]
    },
    "status": {
        "type": "INFO",
        "statuscode": "1000",
        "msg": "OK"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
cages array of Cages object    
name string CH1:05:FE00021 Cage unique space identifier.
type string cage Type of the space asset.
cabinets array of Cabinet objects    
cabinets.name string CH1:05:FE00021.0101 Cabinet name.
cabinets.type string cabinet Type of the space asset.
cabinets.circuits array of Circuits objects    
cabinets.circuits.name string 15137957

Circuit name.

cabinets.circuits.type string circuit Type of the space asset.
circuits array of CircuitsMapWithCage object    
circuits.name string 877484 Circuit name.
circuits.type string

circuit

Type of the space asset.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix IBX SmartView Portal access.

GET Asset Tag Point

GET /asset/v1/tagpoint/current

 Method  GET
 URL or End Point  /asset/v1/tagpoint/current
 Headers  Authorization, Content-Type
 Query Parameters  accountNo, ibx, tagId
 Body  Not applicable

 

Given an account number, IBX code, and asset tag point, return its latest value.

 

If you are unaware of how to obtain an authorization key, refer Requesting Access and Refresh tokens under Getting Started.

 

The following screenshots show a sample curl request to get asset tagpoint and a JSON response containing result. 

 

curl -X 

GET "https://api.equinix.com/asset/v1/tagpoint/current?accountNo=1&ibx=CH1&tagId=CH1.Lead%20Chilled%20Water%20Manager:primarychilledwatersupplytemperature"     

-H "content-type: application/json"

-H "authorization: Bearer asxQMSbBwcNzI2fCCNwSwTh3phV2' 

 

The description of the query parameters is as follows:

 

Query Parameter Name Mandatory Type Example Applicable values Description
accountNo Y string 1234   Customer account number
ibx Y string CH1  

Name of the IBX for which data is being requested.

tagId Y string CH1.Lead Chilled Water Manager:primarychilledwatersupplytemperature   Unique identifier for the tagpoint.

 

{
    "payLoad": [
        {
            "value": "5.7",
            "tagId": "CH1.Lead Chilled Water Manager:primarychilledwatersupplytemperature",
            "tagDisplayName": "Primary Chilled Water Supply Temperature",
            "uom": "°C",
            "readingTime": "20190218225701"
        }
    ],
    "status": {
        "type": "INFO",
        "statuscode": "1000",
        "msg": "OK"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
value string 4.9 Current data value for the tag point.
tagId string CH1.Chiller1:evapleavingwatertemperature Unique identifier for the tag point.
tagDisplayName string Evaporator leaving water temperature Display name for the tag point.
uom string oC Unit of measure for the tag point data value.
alarmStatus string OK

Alarm status for the tag point.

readingTime string

20170907060449

Date-time when the tag point value was read from the device.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix IBX SmartView Portal access.

POST Asset Tag Points

POST /asset/v1/tagpoint/current

 Method  POST
 URL or End Point  /asset/v1/tagpoint/current
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  accountNo, ibx, tagId

 

Given an account number, IBX code, and asset tag point, return its latest value.

 

If you are unaware of how to obtain an authorization key, refer Requesting Access and Refresh tokens under Getting Started.

 

The following screenshots show a sample curl request to get asset tagpoint and a JSON response containing result. 

 

curl -X 

POST https://api.equinix.com/asset/v1/tagpoint/current

-H 'content-type: application/json' 

-H 'authorization: Bearer jBilbaA9AAdePnHhQLC29ZK7fj5b' 

-d '{
  "accountNo": "1",
  "tagIds": [
    "CH1.Lead Chilled Water Manager:primarychilledwatersupplytemperature",
    "CH1.UPS-5:batterytimeremaining"
  ],
  "ibx": "CH1"
}'

 

The description of the request payload is as follows:

 

Body Parameter Name Mandatory Type Example Applicable values Description
accountNo Y string 1234   Customer account number
ibx Y string CH1  

Name of the IBX for which data is being requested.

tagIds Y string CH1.Lead Chilled Water Manager:primarychilledwatersupplytemperature, CH1.UPS-5:batterytimeremaining   Unique identifier list for the tagpoints.

 

{
    "payLoad": [
        {
            "value": "AVAILABLE DURING DISCHARGE",
            "tagId": "CH1.UPS-5:batterytimeremaining",
            "tagDisplayName": "Battery Time Remaining",
            "uom": "",
            "readingTime": "20190218233515"
        },
        {
            "value": "5.7",
            "tagId": "CH1.Lead Chilled Water Manager:primarychilledwatersupplytemperature",
            "tagDisplayName": "Primary Chilled Water Supply Temperature",
            "uom": "°C",
            "readingTime": "20190218225701"
        }
    ],
    "status": {
        "type": "INFO",
        "statuscode": "1000",
        "msg": "OK"
    }
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
value string 4.9 Current data value for the tag point.
tagId string CH1.Chiller1:evapleavingwatertemperature Unique identifier for the tag point.
tagDisplayName string Evaporator leaving water temperature Display name for the tag point.
uom string oC Unit of measure for the tag point data value.
alarmStatus string OK

Alarm status for the tag point.

readingTime string

20170907060449

Date-time when the tag point value was read from the device.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix IBX SmartView Portal access.