Smart View Environment APIs (1.0)

Download OpenAPI specification:Download

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

Empower yourself with Smart View Environment APIs. Use these APIs to fetch current and trending environmental data (humidity and temperature). Given an account number, IBX code, get current and trending environment data for a level value. The environment info (temperature and humidity) is returned for input IBX, zone, cage and sensor.

Smart View Environment

Access Environment Information

Get current environmental data

The endpoint returns environment information on temperature and humidity from inputs (ibx, zone, cage, sensor)

query Parameters

accountNo required	string Customer Account Number
ibx required	string IBX Code
levelType required	string Enum: "IBX" "ZONE" "CAGE" "SENSOR" Level Type
levelValue required	string Level Value is ibxCode, zoneUsID, cageUsID, sensorid for levelType ibx, zone, cage, sensor resp.

header Parameters

Authorization

required

string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json

object

ibx	string ibx code
accountNo	string account number
zone	string zone unique space id
cage	string cage unique space id
cabinet	string cabinet unique space id
sensor	string sensor id
temperature	string current temperature
humidity	string current humidity
timestamp	string epoch timestamp when the current reading was read
temperatureUom	string unit of measure for temperature values
humidityUom	string unit of measure for humidity

object

type	string Value: "INFO" [INFO\|ERROR] are the possible values
statuscode	number [1000\|3001\|3002\|3003\|3004\|3005\|4000\|5000\|6001] are the possible status codes
msg	string [Ok\|Invalid Level Type\|Invalid Level Value\|Invalid Account Details Or User is not Entitled\|User Preference is not set as expected in the account\|Invalid IBX\|Invalid Account number\|User is not entitled to the ibx\|INVALID_SESSION\|INVALID_SESSION_IBX\|INTERNAL_ERROR\|NO_DATA\|UNAUTHORISZED_ACCESS] are the possible messages

Response samples

200
default

Content type

application/json

{"payLoad": {"ibx": "CH1",
"accountNo": "1",
"zone": "CH1:1:05:ColoArea:2",
"cage": "CH1:05:000550",
"cabinet": "CH1:05:000550:0105",
"sensor": "CH1.Colo.CH1_05_000550_0105",
"temperature": "20.0",
"humidity": "43.00",
"timestamp": "1506665106579",
"temperatureUom": "°C",
"humidityUom": "%"
},
"status": {"type": "INFO",
"statuscode": "1000",
"msg": "OK"
}
}

Fetch list of environmental data

The GET endpoint returns environment info ( humidity and temperature ) for all the values for input level type IBX, ZONE, CAGE, SENSOR

query Parameters

accountNo required	string Customer Account Number
ibx required	string IBX Code
levelType required	string Enum: "IBX" "ZONE" "CAGE" "SENSOR" Level Type

header Parameters

Authorization

required

string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json

object

totalCount

integer

total number of data values

Array of objects (EnvironmentDataForArray)

Array

ibx	string ibx code
accountNo	string account number
zone	string zone unique space id
cage	string cage unique space id
cabinet	string cabinet unique space id
sensor	string sensor id
temperature	string current temperature
humidity	string current humidity
timestamp	string epoch timestamp when the current reading was read
temperatureUom	string unit of measure for temperature values
humidityUom	string unit of measure for humidity

object

type	string Value: "INFO" [INFO\|ERROR] are the possible values
statuscode	number [1000\|3001\|3002\|3003\|3004\|3005\|4000\|5000\|6001] are the possible status codes
msg	string [Ok\|Invalid Level Type\|Invalid Level Value\|Invalid Account Details Or User is not Entitled\|User Preference is not set as expected in the account\|Invalid IBX\|Invalid Account number\|User is not entitled to the ibx\|INVALID_SESSION\|INVALID_SESSION_IBX\|INTERNAL_ERROR\|NO_DATA\|UNAUTHORISZED_ACCESS] are the possible messages

Response samples

200
default

Content type

application/json

{"payLoad": {"totalCount": 1,
"data": [{"ibx": "CH1",
"accountNo": "1",
"zone": "CH1:1:05:ColoArea:2",
"cage": "CH1:05:000550",
"cabinet": "CH1:05:000550:0105",
"sensor": "CH1.Colo.CH1_05_000550_0105",
"temperature": "20.0",
"humidity": "43.00",
"timestamp": "1506665106579",
"temperatureUom": "°C",
"humidityUom": "%"
}
]
},
"status": {"type": "INFO",
"statuscode": "1000",
"msg": "OK"
}
}

Fetch trending environmental data

The endpoint returns trending environment information (temperature and humidity) for input ibx, zone, cage, sensor

query Parameters

accountNo required	string Customer Account Number
ibx required	number IBX Code
dataPoint required	string Enum: "temperature" "humidity" data point
levelType required	string Enum: "IBX" "ZONE" "CAGE" "SENSOR" Level Type
levelValue required	string Level Value is ibxCode, zone, cage, sensorid for levelType ibx, zone, cage, sensor resp.
interval required	string Enum: "reading" "1h" "1d"
fromDate required	string <date-time> date in long
toDate required	string <date-time> date in long

header Parameters

Authorization

required

string

The OAuth Bearer token. Please add the prefix 'Bearer ' before the token.

Responses

Response Schema: application/json

object

ibx

string

ibx code

accountNo

string

customer account num

interval

string

interval

datapoint

string

data point for which the timeseries data is fetched

uom

string

unit of measure used for the datapoint

Array of objects (DataValue)

Time series data for the data point

Array

value	string reading value for the datapoint
modifiers	Array of strings modifiers applicable for the reading value
datetime	string timestamp since epoch. reading timestamp

Response samples

200
default

Content type

application/json

{"payLoad": {"ibx": "CH1",
"accountNo": "1",
"interval": "reading",
"datapoint": "temperature",
"uom": "°C",
"series": [{"value": "21.11",
"modifiers": ["recorded"
],
"datetime": "1483977600000"
}
]
}
}