Skip to content
/
Get Events

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

Event

Event List API

Operations

Get Historical Clients

Request

Get historical client list information grouped by client MAC address.

Body
required
searchStringstring
searchTargetFieldsArray of stringsunique
fieldsArray of stringsunique
sortFieldstring
sortOrderstring
pageinteger(int32)
pageSizeinteger(int32)
filtersobject

Users need to pass a list of string or string as map values.

detailLevelstring
{
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageSize": 0,
  "filters": {
    "property1": {},
    "property2": {}
  },
  "detailLevel": "string"
}

Responses

successful operation

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

Event information.

fieldsArray of strings

Relevant fields

totalCountinteger(int32)

Total count.

subsequentQueriesArray of objects

Subsequent queries.

messagestring

Error message.

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

Get Events

Request

Get event list information.

Body
required
searchStringstring
searchTargetFieldsArray of stringsunique
fieldsArray of stringsunique
sortFieldstring
sortOrderstring
pageinteger(int32)
pageSizeinteger(int32)
filtersobject

Users need to pass a list of string or string as map values.

detailLevelstring
{
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "fields": [
    "string"
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageSize": 0,
  "filters": {
    "property1": {},
    "property2": {}
  },
  "detailLevel": "string"
}

Responses

successful operation

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

Event information.

fieldsArray of strings

Relevant fields

totalCountinteger(int32)

Total count.

subsequentQueriesArray of objects

Subsequent queries.

messagestring

Error message.

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

Get Events Venue,AP and Network Data

Request

Get events with 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

Event information.

fieldsArray of strings

Relevant fields

totalCountinteger(int32)

Total count.

subsequentQueriesArray of objects

Subsequent queries.

messagestring

Error message.

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

Get Events Details Like Venue, AP and Network Data

Request

Get events details with 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

Event information.

fieldsArray of strings

Relevant fields

totalCountinteger(int32)

Total count.

subsequentQueriesArray of objects

Subsequent queries.

messagestring

Error message.

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

Export Events Within a Date Range

Request

Export specific events within a date range.

Body
required
matchFieldsArray of objects(MatchFieldDto)
mustNotMatchFieldsArray of objects(MustNotMatchFieldDto)
tenantIdstring
rangeFilterobject(RangeFilterDto)
pageinteger(int32)
pageSizeinteger(int32)
supportboolean
sortFieldstring
sortOrderstring
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
clientTimeZonestring
clientDateFormatstring
detailLevelstring
isSupportboolean
eventsPeriodForExportobject
termFieldobject(TermFieldDto)
groupBystring
{
  "matchFields": [
    { … }
  ],
  "mustNotMatchFields": [
    { … }
  ],
  "tenantId": "string",
  "rangeFilter": {
    "field": "string",
    "gte": "string",
    "lte": "string"
  },
  "page": 0,
  "pageSize": 0,
  "support": true,
  "sortField": "string",
  "sortOrder": "string",
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "clientTimeZone": "string",
  "clientDateFormat": "string",
  "detailLevel": "string",
  "isSupport": true,
  "eventsPeriodForExport": {
    "property1": "string",
    "property2": "string"
  },
  "termField": {
    "field": "string",
    "value": "string"
  },
  "groupBy": "string"
}

Responses

successful operation

Body
object(StreamingResponseBody)
Response
{}

Get Admin Members Last Logins

Request

Get admin members last logins.

Path
adminGroupIdstringrequired

Admin Group Id

No request payload

Responses

successful operation

Body
requestIdstring
errorobject(Error)
errorsArray of objects(Error)
countinteger(int32)

Number of members in a group.

lastLoginListArray of objects(LastLogin)

Member's last login list.

Response
{
  "requestId": "string",
  "error": {
    "code": "string",
    "message": "string",
    "reason": "string",
    "suggestion": "string"
  },
  "errors": [
    { … }
  ],
  "count": 0,
  "lastLoginList": [
    { … }
  ]
}

Group Members Last login Event

Operations