v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

FloorPlan

Site devices summary

This API provides a list of non-associated and non-deployed APs for a site. The summary for the site and a specific floor can also be obtained by passing the floor ID of that specific floor.

get/network-monitoring/v1/sitemaps-summary/{site-id}

Path parameters

site-idstring const required

Example:16a-aad7-4070-8a19-fd6b8e1ff012

The ID of the site for which the device-related information is requested.

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 can be provided with floorId (in operator must be used ).

Response

Returns summary of devices associated with the site.

typestring const required

API type.

idstring const required

siteId associated with the device commonly in UUID format.

siteIdstring const

Site ID associated with the device commonly in UUID format.

Example response

{
  "type": "network-monitoring/sitemap-summary",
  "id": "3b5b-0e6c-4b73-9f6e-4e895a080190",
  "siteId": "3b5b-0e6c-4b73-9f6e-4e895a080190",
  "floorsSummary": [
    {
      "floorId": "fff2bd91-de81-4097-8420-3ca7f87450fd"
    }
  ]
}