IBX SmartView System Alert APIs (2.0.1)

Download OpenAPI specification:Download

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

Empower yourself with IBX SmartView System Alert APIs to access information on the alarms, now known as system alerts. Given a multiple criteria, this API retrieves all the system alerts. We recommend customers utilize the POST call, however both calls are supported and functional.

DCIM System Alert

Access System Alert Information

system alerts search

Returns all system alerts in a paginated way allows narrowing returned results by submitting additional search filters.

Allowed search filters.

Authorizations:

BearerAuth

query Parameters

limit required	integer Example: limit=100 Number of records to retrieve per request.
offset required	integer Example: offset=0 Record Number you want start to retrieve from (0..N)
status	string Example: status=ACTIVE Alert status: ACTIVE or INACTIVE
assetClassification	string Example: assetClassification=Mechanical The class of assets this asset belongs to: Mechanical/Electrical/Environmental
edgeCollectedOn	string Example: edgeCollectedOn=2023-11-30T05:08:39.345Z Returns the alarms after the passed time

Responses

Response Schema: application/json

Array of objects (AlertReadModel)

Array of the alerts.

Array

id	integer <int64> database ID
alertUid	string alert unique ID
traceUid	string alert trace unique ID related to status change
assetTagUid	string asset tag point unique id
assetTagDisplayName	string asset tag point display name
status	string Enum: "ACTIVE" "INACTIVE" alert status
	object (ValueReadModel)
	object (AssetReadModel)
	object (ConfigurationReadModel)
	object (ProcessingTimeReadModel)
	object (ProcessingTimeReadModel)

object (Pagination)

offset	integer <int64> Starting index of an item. First item is offset 0. Default value for offset is 0.
limit	integer <int64> The maximum number of items to return starting from the index denotes by the offset item. Default value for limit is 20. Upper limit is 1000
total	integer <int64> Total number of available items
next	string Offset for next page of the data. If there is no next value (i.e., reached the last item), then this property should not be present in the response.
previous	string Offset for previous page of the data. If there is no previous page (i.e., first page is returned in the current response), then this property should not be present in the response.

Response samples

Content type

application/json

{"data": [{"id": 420,
"alertUid": "PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM",
"traceUid": "1652686263561/PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM",
"assetTagUid": "PA8A.CB-CRITICAL-DB2:tripped",
"assetTagDisplayName": "Tripped",
"status": "INACTIVE",
"value": {"alertTagValue": "1",
"alertTagValueDisplayName": "NORMAL",
"activeAlertTagValueDisplayName": "ALARM",
"currentTagValue": "NORMAL"
},
"asset": {"ibx": "PA8A",
"assetUid": "PA8A.CB-CRITICAL-DB2",
"assetType": "Circuit Breaker with Metering",
"assetClassification": "Electrical",
"assetRegion": "EMEA",
"assetUnderMaintenance": false
},
"configuration": {"thresholdValue": "0",
"thresholdValueDisplayName": "ALARM",
"unitOfMeasurement": "i.e °C",
"thresholdType": "DIGITAL",
"conditionName": "ALARM",
"customerVisible": false,
"configurationVersion": "1.0"
},
"activeProcessing": {"edgeCollectedOn": "2023-01-11T16:06:10.082Z",
"tagCalculationJobProcessedOn": "2023-01-11T16:06:10.082Z",
"processingStartOn": "2023-01-11T16:06:10.082Z",
"processingEndOn": "2023-01-11T16:06:10.082Z",
"publishedOn": "2023-01-11T16:06:10.082Z"
},
"inactiveProcessing": {"edgeCollectedOn": "2023-01-11T16:06:10.082Z",
"tagCalculationJobProcessedOn": "2023-01-11T16:06:10.082Z",
"processingStartOn": "2023-01-11T16:06:10.082Z",
"processingEndOn": "2023-01-11T16:06:10.082Z",
"publishedOn": "2023-01-11T16:06:10.082Z"
}
}
],
"pagination": {"offset": 20,
"limit": 10,
"total": 500,
"next": "30",
"previous": "10"
}
}

system alerts search

Returns all system alerts in a paginated way allows narrowing returned results by submitting additional search filters.

Allowed search filters

Property	Operator	Description
/status	=, IN	Alert status, INACTIVE or ACTIVE
/assetTagUid	=, IN	Asset tag point unique id, example: PA8A.CB-CRITICAL-DB2:tripped
/assetTagDisplayName	=, IN	Active tag reading display value, example: ALARM
/configuration/thresholdType	=, IN	Example: DIGITAL
/configuration/conditionName	=, IN	Name given to the alarm condition. Example: ALARM
/asset/ibx	=, IN	Name of the IBX for which data is being requested, example: PA8A
/asset/assetUid	=, IN, LIKE	Asset unique ID, example: PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM
/activeProcessing/edgeCollectedOn	=, >=, <=	When tag reading was collected on source, example: 2022-09-23T13:40:53.449276Z
/asset/assetUnderMaintenance	=, IN	Asset was under maintenance during alert processing, example: false
/asset/assetType	=, IN	Indicates the template name for the asset, example: Circuit Breaker with Metering
/asset/assetClassification	=, IN	The class of assets this asset belongs to. Asset classification is electrical or mechanical, example: Electrical

Allowed search request sort options:

/status
/assetTagUid
/assetTagDisplayName
/configuration/thresholdType
/configuration/conditionName
/asset/ibx
/asset/assetUid
/activeProcessing/edgeCollectedOn
/asset/assetUnderMaintenance
/asset/assetType
/asset/assetClassification

Authorizations:

BearerAuth

Request Body schema: application/json
required

object (SearchFilter)

Array of objects (SearchCondition)

Array of search conditions.

Array

property required	string Field name
operator required	string Enum: "<=" ">=" "LIKE" "IN" "=" "!=" Condition used to compare the property and the value(s).
values required	Array of strings [ 1 .. 2147483647 ] items Array of values to be compared with the field.

Array of objects (SearchCondition)

Array of search conditions.

Array

property required	string Field name
operator required	string Enum: "<=" ">=" "LIKE" "IN" "=" "!=" Condition used to compare the property and the value(s).
values required	Array of strings [ 1 .. 2147483647 ] items Array of values to be compared with the field.

object (SearchPagination)

offset required	integer <int64> >= 0 Starting index of an item. First item is offset 0. Default value for offset is 0.
limit required	integer <int32> The maximum number of items to return starting from the index denotes by the offset item. Default value for limit is 20. Upper limit is 1000

Array of objects (SearchSort)

Array of sorting conditions.

Array

direction	string Enum: "ASC" "DESC" Direction of sorting. Default is ASC.
property required	string Property used for sorting the data.

Responses

Response Schema: application/json

Array of objects (AlertReadModel)

Array of the alerts.

Array

id	integer <int64> database ID
alertUid	string alert unique ID
traceUid	string alert trace unique ID related to status change
assetTagUid	string asset tag point unique id
assetTagDisplayName	string asset tag point display name
status	string Enum: "ACTIVE" "INACTIVE" alert status
	object (ValueReadModel)
	object (AssetReadModel)
	object (ConfigurationReadModel)
	object (ProcessingTimeReadModel)
	object (ProcessingTimeReadModel)

object (Pagination)

offset	integer <int64> Starting index of an item. First item is offset 0. Default value for offset is 0.
limit	integer <int64> The maximum number of items to return starting from the index denotes by the offset item. Default value for limit is 20. Upper limit is 1000
total	integer <int64> Total number of available items
next	string Offset for next page of the data. If there is no next value (i.e., reached the last item), then this property should not be present in the response.
previous	string Offset for previous page of the data. If there is no previous page (i.e., first page is returned in the current response), then this property should not be present in the response.

Request samples

Payload

Content type

application/json

{"filter": {"and": [{"property": "/status",
"operator": "=",
"values": ["ACTIVE"
]
},
{"property": "/asset/ibx",
"operator": "IN",
"values": ["MI1",
"NY1",
"WAW2"
]
},
{"property": "/asset/assetUid",
"operator": "=",
"values": ["MI1.arc-reactor"
]
},
{"property": "/assetTagUid",
"operator": "=",
"values": ["MI1.arc-reactor:alarm"
]
},
{"property": "/assetTagDisplayName",
"operator": "=",
"values": ["Arc Reactor Alarm"
]
},
{"property": "/asset/assetType",
"operator": "=",
"values": ["Arc Reactor"
]
},
{"property": "/asset/assetClassification",
"operator": "=",
"values": ["Mechanical"
]
},
{"property": "/asset/assetUnderMaintenance",
"operator": "=",
"values": ["false"
]
},
{"property": "/state",
"operator": "=",
"values": ["OPEN"
]
},
{"property": "/configuration/thresholdType",
"operator": "=",
"values": ["DIGITAL"
]
},
{"property": "/configuration/conditionName",
"operator": "=",
"values": ["ALARM"
]
},
{"property": "activeProcessing.edgeCollectedOn",
"operator": ">=",
"values": ["2000-03-25T04:03:06.000Z"
]
}
]
},
"pagination": {"offset": 0,
"limit": 50
}
}

Response samples

Content type

application/json

{"data": [{"id": 420,
"alertUid": "PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM",
"traceUid": "1652686263561/PA8A.CB-CRITICAL-DB2:tripped#DIGITAL:ALARM",
"assetTagUid": "PA8A.CB-CRITICAL-DB2:tripped",
"assetTagDisplayName": "Tripped",
"status": "INACTIVE",
"value": {"alertTagValue": "1",
"alertTagValueDisplayName": "NORMAL",
"activeAlertTagValueDisplayName": "ALARM",
"currentTagValue": "NORMAL"
},
"asset": {"ibx": "PA8A",
"assetUid": "PA8A.CB-CRITICAL-DB2",
"assetType": "Circuit Breaker with Metering",
"assetClassification": "Electrical",
"assetRegion": "EMEA",
"assetUnderMaintenance": false
},
"configuration": {"thresholdValue": "0",
"thresholdValueDisplayName": "ALARM",
"unitOfMeasurement": "i.e °C",
"thresholdType": "DIGITAL",
"conditionName": "ALARM",
"customerVisible": false,
"configurationVersion": "1.0"
},
"activeProcessing": {"edgeCollectedOn": "2023-01-11T16:06:10.082Z",
"tagCalculationJobProcessedOn": "2023-01-11T16:06:10.082Z",
"processingStartOn": "2023-01-11T16:06:10.082Z",
"processingEndOn": "2023-01-11T16:06:10.082Z",
"publishedOn": "2023-01-11T16:06:10.082Z"
},
"inactiveProcessing": {"edgeCollectedOn": "2023-01-11T16:06:10.082Z",
"tagCalculationJobProcessedOn": "2023-01-11T16:06:10.082Z",
"processingStartOn": "2023-01-11T16:06:10.082Z",
"processingEndOn": "2023-01-11T16:06:10.082Z",
"publishedOn": "2023-01-11T16:06:10.082Z"
}
}
],
"pagination": {"offset": 20,
"limit": 10,
"total": 500,
"next": "30",
"previous": "10"
}
}

IBX SmartView System Alert APIs (2.0.1)

DCIM System Alert

system alerts search

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

system alerts search

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Request Body schema: application/json
required