v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

FloorPlan

Retrieves placed devices over the FloorMap

A list of placed devices on the FloorMap is returned. Currently, geoMetry is not supported; only x and y are returned in meters in geometryRelative.

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

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 or buildingId. Other supported fields are ``types (inoperator must be used ),name, modelandserial`.

limitinteger

Specifies the number of results to be returned.

nextstring const

Specifies the pagination cursor for the next page of resources.

Response

Returns a list of placed devices on 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

{
  "response": {
    "code": "SUC-001",
    "status": "SUCCESS",
    "message": "success."
  },
  "items": [
    {
      "deviceName": "AP 001",
      "type": "Access Point",
      "id": "AP00000021",
      "lpId": "AP00000021",
      "lpFeatureType": "POINT",
      "accesspointProperties": {
        "model": "AP-635",
        "serialNumber": "AP00000001",
        "macAddress": "11:22:33:44:55:66",
        "state": "DEPLOYED",
        "status": "ONLINE",
        "partNumber": "JX973A",
        "radios": [
          {
            "serial": "AP00000001",
            "power": "18 Dbm",
            "band": "5 GHz",
            "channel": "5 GHz",
            "number": 1,
            "macAddress": "11:22:33:44:55:66"
          }
        ],
        "siteId": "3b5b-0e6c-4b73-9f6e-4e895a080190",
        "floorId": "fff2bd91-de81-4097-8420-3ca7f87450fd"
      }
    }
  ],
  "count": 100,
  "total": 200
}