Streaming Subscription API (1.0)
Download OpenAPI specification:Download
IBX SmartView's subscription API allows users to subscribe to near real-time message feeds for events occurring within an IBX. Users can specify the types of messages to receive for each IBX. Users are able to view all subscriptions within their organization and update any subscription to modify the message feed being received.
Get all subscription endpoint
The endpoint allows users to fetch details for all streaming subscriptions for a given organization.
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
id | string | ||||||||||||
status | string Enum: "PENDING" "ACTIVE" "FAILED" "DELETE_IN_PROGRESS" "DELETED" | ||||||||||||
object (MessageType) Message type for a given subscription | |||||||||||||
| |||||||||||||
object (Channel) Subscription can be created using one channel. | |||||||||||||
| |||||||||||||
orgId | string | ||||||||||||
createdBy | string | ||||||||||||
createdDateTime | string <date-time> | ||||||||||||
updatedBy | string | ||||||||||||
updatedDateTime | string <date-time> |
Response samples
- 200
[- {
- "id": "string",
- "status": "PENDING",
- "messageType": {
- "asset": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "assetClassification": [
- "MECHANICAL"
], - "assetId": [
- "string"
]
}
], - "environmental": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "level": [
- "ZONE"
]
}
], - "power": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
]
}
], - "meteredPower": [
- {
- "streamId": "IBX.CBM-B1-4-1:kilowattHour",
- "ibx": "IBX",
- "asset": {
- "id": "IBX.CBM-B1-4-1",
- "type": "Customer Billing Meter"
}, - "cage": "IBX:02:021305",
- "cageSerialNo": "021305-20604711",
- "accountNumber": "123456",
- "tag": {
- "id": "IBX.CBM-B1-4-1:kilowattHour",
- "displayName": "kilowattHour"
}, - "reading": {
- "value": "412568.125",
- "unit": "kWh"
}, - "readingTime": "2023-10-03T13:09:32",
- "dataQuality": "Good"
}
], - "systemAlert": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
]
}
], - "customAlert": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "user": "string"
}
]
}, - "channel": {
- "channelType": "AWS_IOT_CORE",
- "awsIotCoreChannelConfiguration": {
}, - "webhookChannelConfiguration": {
- "sslCertificate": "ZkFzZLY1IGRpY31kZXI=",
- "numberOfRetries": 1,
- "numberOfConcurrentCalls": 20,
- "batchSize": 5
}, - "azureChannelConfiguration": {
- "numberOfRetries": 1,
- "numberOfConcurrentCalls": 20,
- "batchSize": 5
}
}, - "orgId": "string",
- "createdBy": "string",
- "createdDateTime": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDateTime": "2019-08-24T14:15:22Z"
}
]
Create subscription endpoint
The endpoint allows users to define and create a new streaming subscription for a given organization.
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/json
object (MessageType) Message type for a given subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Channel) Subscription can be created using one channel. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Location | string Location of created subscription. For Example: /smartview/v2/streaming/subscriptions/607460b4e4a78360425bca56 |
Request samples
- Payload
{- "messageType": {
- "asset": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "assetClassification": [
- "MECHANICAL"
], - "assetId": [
- "string"
]
}
], - "environmental": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "level": [
- "ZONE"
]
}
], - "power": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
]
}
], - "meteredPower": [
- {
- "streamId": "IBX.CBM-B1-4-1:kilowattHour",
- "ibx": "IBX",
- "asset": {
- "id": "IBX.CBM-B1-4-1",
- "type": "Customer Billing Meter"
}, - "cage": "IBX:02:021305",
- "cageSerialNo": "021305-20604711",
- "accountNumber": "123456",
- "tag": {
- "id": "IBX.CBM-B1-4-1:kilowattHour",
- "displayName": "kilowattHour"
}, - "reading": {
- "value": "412568.125",
- "unit": "kWh"
}, - "readingTime": "2023-10-03T13:09:32",
- "dataQuality": "Good"
}
], - "systemAlert": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
]
}
], - "customAlert": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "user": "string"
}
]
}, - "channel": {
- "channelType": "AWS_IOT_CORE",
- "awsIotCoreChannelConfiguration": {
}, - "webhookChannelConfiguration": {
- "sslCertificate": "ZkFzZLY1IGRpY31kZXI=",
- "numberOfRetries": 1,
- "numberOfConcurrentCalls": 20,
- "batchSize": 5
}, - "azureChannelConfiguration": {
- "numberOfRetries": 1,
- "numberOfConcurrentCalls": 20,
- "batchSize": 5
}
}
}
Response samples
- 422
{- "errorCode": "EQIX-ES-5000422",
- "errorMessage": "Unprocessable Entity",
- "correlationId": "06ce37f6-12af-4f47-9d15-e4f8fc77e1c5",
- "details": "The submitted payload does not meet validation criteria.",
- "help": " ",
- "additionalInfo": {
- "constraintCode": "IbxesMustExistOnPaidView",
- "reason": "the [PA8] have no access to paid view"
}
}
Get subscription endpoint
The endpoint allows users to fetch details for a given streaming subscription for a given organization.
path Parameters
id required | string |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "PENDING" "ACTIVE" "FAILED" "DELETE_IN_PROGRESS" "DELETED" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (MessageType) Message type for a given subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Channel) Subscription can be created using one channel. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orgId | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdBy | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdDateTime | string <date-time> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedBy | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updatedDateTime | string <date-time> |
Response samples
- 200
{- "id": "string",
- "status": "PENDING",
- "messageType": {
- "asset": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "assetClassification": [
- "MECHANICAL"
], - "assetId": [
- "string"
]
}
], - "environmental": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "level": [
- "ZONE"
]
}
], - "power": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
]
}
], - "meteredPower": [
- {
- "streamId": "IBX.CBM-B1-4-1:kilowattHour",
- "ibx": "IBX",
- "asset": {
- "id": "IBX.CBM-B1-4-1",
- "type": "Customer Billing Meter"
}, - "cage": "IBX:02:021305",
- "cageSerialNo": "021305-20604711",
- "accountNumber": "123456",
- "tag": {
- "id": "IBX.CBM-B1-4-1:kilowattHour",
- "displayName": "kilowattHour"
}, - "reading": {
- "value": "412568.125",
- "unit": "kWh"
}, - "readingTime": "2023-10-03T13:09:32",
- "dataQuality": "Good"
}
], - "systemAlert": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
]
}
], - "customAlert": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "user": "string"
}
]
}, - "channel": {
- "channelType": "AWS_IOT_CORE",
- "awsIotCoreChannelConfiguration": {
}, - "webhookChannelConfiguration": {
- "sslCertificate": "ZkFzZLY1IGRpY31kZXI=",
- "numberOfRetries": 1,
- "numberOfConcurrentCalls": 20,
- "batchSize": 5
}, - "azureChannelConfiguration": {
- "numberOfRetries": 1,
- "numberOfConcurrentCalls": 20,
- "batchSize": 5
}
}, - "orgId": "string",
- "createdBy": "string",
- "createdDateTime": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDateTime": "2019-08-24T14:15:22Z"
}
Update subscription endpoint
The endpoint allows users to modify and update an existing streaming subscription for a given organization. Request payload replaces current subscription.
path Parameters
id required | string |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Request Body schema: application/json
object (MessageType) Message type for a given subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Channel) Subscription can be created using one channel. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "messageType": {
- "asset": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "assetClassification": [
- "MECHANICAL"
], - "assetId": [
- "string"
]
}
], - "environmental": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "level": [
- "ZONE"
]
}
], - "power": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
]
}
], - "meteredPower": [
- {
- "streamId": "IBX.CBM-B1-4-1:kilowattHour",
- "ibx": "IBX",
- "asset": {
- "id": "IBX.CBM-B1-4-1",
- "type": "Customer Billing Meter"
}, - "cage": "IBX:02:021305",
- "cageSerialNo": "021305-20604711",
- "accountNumber": "123456",
- "tag": {
- "id": "IBX.CBM-B1-4-1:kilowattHour",
- "displayName": "kilowattHour"
}, - "reading": {
- "value": "412568.125",
- "unit": "kWh"
}, - "readingTime": "2023-10-03T13:09:32",
- "dataQuality": "Good"
}
], - "systemAlert": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
]
}
], - "customAlert": [
- {
- "accountNumber": "135888",
- "ibx": [
- "string"
], - "user": "string"
}
]
}, - "channel": {
- "channelType": "AWS_IOT_CORE",
- "awsIotCoreChannelConfiguration": {
}, - "webhookChannelConfiguration": {
- "sslCertificate": "ZkFzZLY1IGRpY31kZXI=",
- "numberOfRetries": 1,
- "numberOfConcurrentCalls": 20,
- "batchSize": 5
}, - "azureChannelConfiguration": {
- "numberOfRetries": 1,
- "numberOfConcurrentCalls": 20,
- "batchSize": 5
}
}
}
Response samples
- 422
{- "errorCode": "EQIX-ES-5000422",
- "errorMessage": "Unprocessable Entity",
- "correlationId": "06ce37f6-12af-4f47-9d15-e4f8fc77e1c5",
- "details": "The submitted payload does not meet validation criteria.",
- "help": " ",
- "additionalInfo": {
- "constraintCode": "IbxesMustExistOnPaidView",
- "reason": "the [PA8] have no access to paid view"
}
}
Get subscription data via REST
obtain API+ near real time data via a simple REST endpoint by employing subscription ID alongside other specified criteria, enabling a comprehensive and targeted approach to data retrieval. Subscription data endpoint works for all channels and not just REST channel.
path Parameters
subscriptionId required | string Subscription ID |
query Parameters
ibxs | Array of strings Filter, set of IBXs |
messageTypes | Array of strings Items Enum: "ALARM" "ALERT" "ENVIRONMENTAL" "METERED_POWER" "POWER" "TAG_POINT" Filter, set of message types |
streamIds | Array of strings Filter, set of stream IDs |
offset | integer <int32> Default: 0 Pagination, offset of the first item |
limit | integer <int32> Default: 250 Pagination, limit of items returned |
header Parameters
Authorization required | string The OAuth Bearer token. Please add the prefix 'Bearer ' before the token. |
Responses
Response Schema: application/json
Array of objects (AlarmMessageData) alarm message data | |||||||||||
Array
| |||||||||||
Array of objects (AlertMessageData) alert message data | |||||||||||
Array
| |||||||||||
Array of objects (EnvironmentMessageData) environment message data | |||||||||||
Array
| |||||||||||
Array of objects (MeteredPowerMessageData) metered-power message data | |||||||||||
Array
| |||||||||||
Array of objects (PowerMessageData) power message data | |||||||||||
Array
| |||||||||||
Array of objects (TagPointMessageData) tag-point message data | |||||||||||
Array
| |||||||||||
object (Pagination) pagination | |||||||||||
|
Response samples
- 200
{- "alarmMessageData": [
- {
- "type": "system-alert",
- "data": {
- "streamId": "IBX.CRAH-EQ1-04:dirtyfilter#ABSOLUTE:HIGH",
- "ibx": "IBX",
- "region": "EMEA",
- "metro": "metro",
- "country": "FR",
- "conditionName": "High",
- "severity": 900,
- "type": "Absolute",
- "heartbeat": true,
- "triggerRule": "RULE:123:1",
- "definitionId": "IBX.CRAH-EQ1-04:dirtyfilter#ABSOLUTE:HIGH",
- "currentValue": {
- "unit": "%",
- "value": "35.023",
- "type": "Float"
}, - "asset": {
- "id": "IBX.CRAH-EQ1-04",
- "type": "CRAH",
- "classification": "Mechanical"
}, - "tag": {
- "id": "IBX.CRAH-EQ1-04:dirtyfilter",
- "displayName": "Temperature7"
}, - "status": {
- "acknowledged": false,
- "acknowledgementTime": "2023-10-03T13:09:32",
- "cleared": false,
- "active": true
}, - "threshold": {
- "unit": "%",
- "stateLimit": "20",
- "message": "NA"
}, - "triggeredTime": "2023-10-03T13:09:32",
- "processedTime": "2023-10-03T13:09:32",
- "normalProcessedTime": "2023-10-03T13:09:32",
- "normalTriggeredTime": "2023-10-03T13:09:32",
- "dataQuality": "Good"
}
}
], - "alertMessageData": [
- {
- "type": "custom-alert",
- "data": {
- "streamId": "IBX.685306-15843739015670.6640131967865078",
- "ibx": "IBX",
- "region": "APAC",
- "id": "IBX.685306-15843739015670.6640131967865078",
- "type": "power",
- "typeId": "drawAmpFalls",
- "conditional": "N",
- "eventType": "Falls below",
- "heartbeat": true,
- "asset": {
- "id": "1.20849261E7",
- "type": "CIRCUIT",
- "classification": "Electrical"
}, - "tag": {
- "id": "IBX.CIRCUIT-EQ1-04:dirtyfilter"
}, - "threshold": {
- "unit": "Amp",
- "maxValue": "5",
- "minValue": "1",
- "value": "10"
}, - "triggeredTime": "2023-10-03T13:09:32",
- "dataQuality": "Good"
}
}
], - "environmentMessageData": [
- {
- "type": "environmental",
- "data": {
- "streamId": "IBX.IBX:humidity",
- "ibx": "IBX",
- "asset": {
- "id": "IBX",
- "level": "IBX"
}, - "reading": {
- "value": "50.045",
- "unit": "PERCENT"
}, - "tag": {
- "id": "humidity",
- "displayName": "Humidity"
}, - "readingTime": "2023-10-03T13:09:32",
- "dataQuality": "Good"
}
}
], - "meteredPowerMessageData": [
- {
- "type": "metered-power",
- "data": {
- "streamId": "IBX.CBM-B1-4-1:kilowattHour",
- "ibx": "IBX",
- "asset": {
- "id": "IBX.CBM-B1-4-1",
- "type": "Customer Billing Meter"
}, - "cage": "IBX:02:021305",
- "cageSerialNo": "021305-20604711",
- "accountNumber": "123456",
- "tag": {
- "id": "IBX.CBM-B1-4-1:kilowattHour",
- "displayName": "kilowattHour"
}, - "reading": {
- "value": "412568.125",
- "unit": "kWh"
}, - "readingTime": "2023-10-03T13:09:32",
- "dataQuality": "Good"
}
}
], - "powerMessageData": [
- {
- "type": "power",
- "data": {
- "streamId": "IBX:140838",
- "ibx": "IBX",
- "asset": {
- "id": "IBX:140838",
- "type": "CIRCUIT"
}, - "cage": "IBX:02:021305",
- "cabinet": "IBX:01:000Z4Z:0102",
- "accountNumber": "123456",
- "description": "32-amp 230v Single Phase Primary AC Power",
- "oid": "1.3.6.1.2.1.299.36.10.1099",
- "circuitType": "PRIMARY",
- "realPower": {
- "value": "0.0",
- "unit": "kW"
}, - "apparentPower": {
- "value": "7.36",
- "unit": "kVA"
}, - "contractualPower": {
- "value": "0.0",
- "unit": "kVA"
}, - "current": {
- "value": "7.36",
- "unit": "A"
}, - "powerFactor": {
- "value": "0.0",
- "unit": "pf"
}, - "soldCurrent": {
- "value": "7.36",
- "unit": "A"
}, - "soldPower": {
- "value": "68.125",
- "unit": "kVA"
}, - "powerConsumptionToContractual": {
- "value": "68.125",
- "unit": "PERCENT"
}, - "cabinetRating": {
- "value": "8.125",
- "unit": "kVA"
}, - "peakLastSevenDays": {
- "value": "7.36",
- "unit": "kVA"
}, - "peakLastSevenDaysRatio": {
- "value": "48.125",
- "unit": "PERCENT"
}, - "peakLastSevenDaysContractualPower": {
- "value": "0.0",
- "unit": "kVA"
}, - "peakLastSevenDaysTime": "2023-10-03T13:09:32",
- "lastUpdated": "2023-10-03T13:09:32",
- "readingTime": "2023-10-03T13:09:32"
}
}
], - "tagPointMessageData": [
- {
- "type": "tag-point",
- "data": {
- "streamId": "IBX.ATS-M1-04:outputvoltageca",
- "ibx": "IBX",
- "tag": {
- "id": "IBX.ATS-M1-04:outputvoltageca",
- "displayName": "Output Voltage CA"
}, - "reading": {
- "value": "50.045",
- "unit": "V"
}, - "readingTime": "2023-10-03T13:09:32",
- "dataQuality": "Good"
}
}
], - "pagination": {
- "offset": 100,
- "limit": 100,
- "total": 500,
- "next": "?offset=200&limit=100",
- "previous": "?offset=0&limit=100"
}
}