Skip to content
/
Get Alarms

Events and Alarms API (v0.0.3-3151-SNAPSHOT)

Download OpenAPI description
Download PDF
Languages
Servers
Generated server url

http://localhost/

Alarm

Alarm List API

Operations

Get Alarms

Request

Returns the set of alarms. Added the support for MSP tenant. For MSP tenant need to pass tenant ids and sort order.

Body
required
fieldsArray of stringsunique
sortFieldstring
sortOrderstring
pageinteger(int32)
pageSizeinteger(int32)
filtersobject
mspEcTenantsArray of strings
{
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageSize": 0,
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mspEcTenants": [
    "string"
  ]
}

Responses

successful operation

Body
requestIdstring
errorobject(Error)
errorsArray of objects(Error)
dataArray of objects

Alarm information.

fieldsArray of strings

Relevant fields

totalCountinteger(int32)

Total count.

subsequentQueriesArray of objects

Subsequent queries.

statusstring

Status

mspEcAlarmCountListArray of objects(MspEcAlarmCount)

MSP EC alarm count

Response
{
  "requestId": "string",
  "error": {
    "code": "string",
    "message": "string",
    "reason": "string",
    "suggestion": "string"
  },
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "subsequentQueries": [
    { … }
  ],
  "status": "string",
  "mspEcAlarmCountList": [
    { … }
  ]
}

Get Alarms Venue,AP and Network Data

Request

Get all alarms filtered by the query. Includes venue, access point and network data.

Body
required
fieldsArray of stringsunique
filtersobject

Filters alarm metadata by ids. Must provide 'ids' in the filters as a key, whether value of the filters is empty or not.

{
  "fields": [
    "string"
  ],
  "filters": {
    "property1": {},
    "property2": {}
  }
}

Responses

successful operation

Body
requestIdstring
errorobject(Error)
errorsArray of objects(Error)
dataArray of objects

Alarm information.

fieldsArray of strings

Relevant fields

totalCountinteger(int32)

Total count.

subsequentQueriesArray of objects

Subsequent queries.

statusstring

Status

mspEcAlarmCountListArray of objects(MspEcAlarmCount)

MSP EC alarm count

Response
{
  "requestId": "string",
  "error": {
    "code": "string",
    "message": "string",
    "reason": "string",
    "suggestion": "string"
  },
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "subsequentQueries": [
    { … }
  ],
  "status": "string",
  "mspEcAlarmCountList": [
    { … }
  ]
}

Clear Alarm

Request

Clear the alarm.

Path
alarmIdstringrequired
Body
string
"string"

Responses

successful operation

Response
No content

Event

Event List API

Operations

Group Members Last login Event

Operations