Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
FloorPlan

Retrieves assigned devices

Devices that have been assigned to the floor are returned. Devices that have been placed on the floor are not included in the result

get/network-monitoring/v1/sitemaps/{site-id}/network-devices-assigned

Query parameters

filterstring const required

OData Version 4.0 filter string (limited functionality). Supports only 'eq' operations ('gt', 'ge', 'lt', 'le' and 'in' are NOT supported). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported filter fields are: floorId and buildingId.

An OData 4.0 filter must be provided with at least floorId. Other supported fields are types (in operator must be used ), mac, serial, name

limitinteger

Specifies the number of results to be returned.

nextstring const

Specifies the pagination cursor for the next page of resources.

Response

Returns the assigned devices for the FloorMap.

offsetinteger

Specifies the offset of the returned page.

countinteger required

The number of objects returned in the current list.

totalinteger

The total number of objects contained in the datastore.

Example response

{
  "count": 100,
  "total": 200,
  "response": {
    "code": "SUC-001",
    "status": "SUCCESS",
    "message": "success."
  },
  "items": [
    {
      "serialNumber": "AP00000001",
      "model": "AP-635",
      "macAddress": "11:22:33:44:55:66",
      "deviceName": "AP 001",
      "partNumber": "JX973A",
      "state": "ASSOCIATED",
      "id": "AP00000001"
    }
  ]
}