...
| URL | Параметры | Возвращаемое значение | Описание |
|---|---|---|---|
| /api/objects/listGroups | нет | Массив краткой информации по всем группам в системе | |
| /api/objects/getGroup/{groupId} | идентификатор группы | Краткая информация по заданной группе | |
| /api/objects/listSensors | нет | Массив краткой информации по всем сенсорам в системе | |
| /api/objects/getSensor/{sensorId} | идентификатор сенсора | Краткая информация по заданному сенсору | |
| /api/objects/listAccessPoints | нет | Массив краткой информации по всем "своим" точкам доступа в системе | |
| /api/objects/getAccessPoint/{accessPointId} | идентификатор точки доступа | Краткая информация по заданной точке доступа | |
| /api/objects/listTasks | нет | Массив краткой информации по всем задачам в системе | |
| /api/objects/getTask/{taskId} | идентификатор задачи | Краткая информация по заданной задаче | |
| /api/objects/getNames/{groupId} | идентификатор группы или "default" для самой верхней (топ) группы | Массив объектов: типов и имен групп, точек доступа и сенсоров по их Id, для всех объектов заданной группы, и её подгрупп | Пример вывода: [ { |
| /api/healthSummary/getLatest | один из параметров должен быть указан: groupId, sensorId, accessPointId или bssid | Краткая информация по результатам измерения для заданного объекта, взятая из последнего измерения из БД сервера. | Запрос последних известных данных по измерениям для заданного объекта. Параметры объекта передаются в URL запросе в виде ключ=значение, например https://dev.wifisensor.pro/api/healthSummary/getLatest?sensorId=611a211ff1290747553498f4 Ответ сервера приходит синхронно и за короткое время (миллисекунды). |
| /api/healthSummary/requestHealth | один из параметров должен быть указан: groupId, sensorId, accessPointId, accessPointName, taskId, ssid или bssid (все - строки) обязательные параметры callbackUrl (строка) и timeout (число секунд) | Статус запуска задачи "вне очереди" на подходящем по параметрам запроса сенсоре (сенсорах) | Запрос выполнения измерения для заданного объекта. Параметры объекта передаются в URL запросе в виде ключ=значение. Ответ сервера приходит асинхронно после заданного таймаута, либо раньше, если измерения завершатся до него, путем отправки запроса на заданный Callback URL вашей системы. |
| /api/objects/getSsids/{groupId} | идентификатор группы | список заданных для этой группы SSID | Запрос перечня заданных для группы "собственных" сетей со всеми их настройками, без вложенных либо родительских групп |
| /api/objects/setSsidPassword | ssid=строка password=строка | количество измененных SSID | Запрос изменения PSK пароля для заданного SSID. Изменяется значение всех найденных SSID (по имени) во всех группах. Запрос отправляется по методу HTTP POST. |
| /api/metrics/getList | необязательные параметры: groupId, sensorId, accessPointId | массив объектов типа "метрика", содержащий имя (ключ), описание и пороговые значения | может быть отфильтрован по собираемым метрикам для заданной группы, сенсора или точки доступа |
| /api/metrics/getAggregated | один из параметров должен быть указан: groupId, sensorId, accessPointId необязательные параметры: interval (по умолчанию Day) допустимо Hour, SixHours, TwelveHours, Day, Week, TwoWeeks, Month key, ssid, или bssid | комплексный объект, содержащий общие счетчики метрик за весь период, и затем в виде массива счетчики по интервалам (отрезкам времени) внутри этого периода. | аналогичен данным, использующимся в отрисовке гистограммы по метрикам. применимы дополнительные фильтры по ключу метрики, SSID и BSSID |
| /api/metrics/getRaw | необязательные параметры: interval (по умолчанию Day) допустимо Hour, SixHours, TwelveHours, Day, Week, TwoWeeks, Month либо Period, в последнем случае также указать fromDate и toDate groupId, sensorId, accessPointId key, ssid, bssid | массив объектов типа MeasurementResult с примененными фильтрами, и за заданный диапазон времени | исходные результаты измерений (метрики) без агрегации по времени или типу. формат дат fromDate и toDate задаётся как "dd/MM/yyyy HH:mm" |
| /api/metrics/getSemiAggregated | обязательные параметры: groupId, key необязательный параметр: interval, принимает значения: FiveMinutes, TenMinutes, ThirtyMinutes, Hour, ThreeHours, SixHours, TwelveHours, Day, Week, TwoWeeks, Month, TwoMonths, ThreeMonths, FourMonths, SixMonths, Year по умолчанию interval=TenMinutes | массив объектов типа MetricSemiAggregatedResult для группы и ключа метрики key, за заданный интервал времени от "сейчас" назад: [ { | агрегированные по времени результаты измерений метрики, с разбивкой по BSSID |
При этом идентификатором является ключ в базе MongoDB, под которым хранятся сведения об объекте. Это длинная строка вида "611a213bf1290747553498f9".
...