API device UK

en | uk | ru

Розділ API ERP "UserSide"

Призначення: Обладнання

Додаткові параметри:
action - підкатегорія запиту (можливе значення: див. нижче)

Підкатегорії

add_mark

Змінено у 3.19beta1 (параметр object_type исключен)

Опис: Додавання метки
Обов'язкові параметри:
 object_type - Тип пристрої [switch] (до версії 3.19beta1)
 object_id - id пристрої
 mark_id - ID метки

get_connected_ont_information

Додано у: 3.14.13

Опис: Отримання информации о подключенных ONU к OLT (сохраненная информация из базы. Прямой опрос не выполняется)
Необов'язкові параметри:
 device_id - ID OLT (можна через кому)
 level_onu_rx_min - минимальный входящий рівень сигнала на ONU (выбрать записи с уровнем менее чем...)
 level_onu_rx_max - максимальный входящий рівень сигнала на ONU (выбрать записи с уровнем выше чем...)

get_current_ont_data

Додано з: 3.16dev4

Опис: Отримання некоторой текущей информации по ONU с OLT
Обов'язкові параметри:
 id - id пристрої (ONU)

get_device_id

Змінено у 3.19beta1 (параметр object_type исключен)

Доопрацьовано у: 3.13.63 (в data_typer добавлено возможное значення serial_number)

Доопрацьовано у: 3.12.95 (в data_typer добавлено возможное значення mac)

Опис: Отримання ID пристрої по входящим данным
Обов'язкові параметри:
 object_type - тип пристрої [switch] (до версії 3.19beta1)
 data_typer - тип данных, которые проверяем (возможные значення: ip, mac, inventory_number, serial_number, additional_field_XXX)
 data_value - значення

get_data

Доопрацьовано у 3.20.2 (додано параметр is_with_ip)

Доопрацьовано у 3.19.15 (додано параметр customer_id)

Доопрацьовано у 3.19beta1 (додано параметр dataset)

Доопрацьовано у: 3.18.4 (додано параметр is_hide_access_data)

Доопрацьовано у: 3.17beta1 (додано параметр node_id)

Доопрацьовано у: 3.15.18 (добавлен object_type=olt)

Доопрацьовано у: 3.14.14 (додано параметр is_hide_ifaces_data)

Доопрацьовано у: 3.12.38 (добавлен object_type=all)

Опис: Отримання информации об пристроїх
Обов'язкові параметри:
 object_type - Тип пристрої [switch|onu|olt|radio|all]
Необов'язкові параметри:
 customer_id - id абонента (можна через кому)
 dataset - список полей, которые выводить в выдаче (через кому)
 is_online - прапорець - выбирать только активные пристрої (1 - активные, -1 - неактивные)
 is_hide_ifaces_data - прапорець - скрывать развёрнутую информацию по интерфейсам обладнання
 is_hide_access_data - прапорець - скрывать информацию по параметрам доступа к оборудованию
 is_with_ip - прапорець - только с IP-адресами
 node_id - id об'єкти інфраструктури (можна через кому)
 object_id - id об'єкта для выборки

get_iface_info

Додано з: 3.17dev1

Опис: Отримання текущей информации по интерфейсам (напрямую с пристрої)
Обов'язкові параметри:
 id - id пристрої

get_iface_mac

Змінено у 3.19beta1 (параметр object_type исключен)

Додано з: 3.12beta25

Опис: Список интерфейсов с MAC-адресами на устройстве
Обов'язкові параметри:
 object_type - Тип пристрої [switch] (до версії 3.19beta1)
 object_id - id пристрої для выборки

get_mac_list

Змінено у 3.19beta1 (параметр object_type исключен, список object_id сделан необязательным)

Опис: Отримання списка MAC-адресов, которые были найдены на устройстве
Обов'язкові параметри:
 object_type - Тип пристрої [switch] (до версії 3.19beta1)
Необов'язкові параметри:
 interface_list - Номер интерфейса по которому выводить список (можна через кому)
 object_id - id пристрої для выборки

get_ont_data

Доопрацьовано у: 3.16dev4 (додано параметр device_id)

Додано з: 3.12.81

Опис: Отримання последней информации по ONU
Обов'язкові параметри:
 id - MAC-адрес или серийный номер (id)
 или
 device_id - id пристрої (ONU)

get_pon_level_history

Доопрацьовано у: 3.16.19 (додано параметр onu_device_id)

Доопрацьовано у: 3.16dev4 (додано параметр device_id)

Доопрацьовано у: 3.12.60 (додано параметри limit, order_by, is_desc)

Додано з: 3.12.53

Опис: Отримання истории PON-уровней сигналов по ONU
Обов'язкові параметри:
 onu_name - MAC-адрес или серийный номер ONU (без разделителей)
 или
 device_id - id пристрої (OLT)
 или
 onu_device_id - id пристрої (ONU)
Необов'язкові параметри:
 limit - ограничение списка выводимых данных
 order_by - поле сортировки данных
 is_desc - прапорець - сортировка в обратном порядке

get_relation_customers

Додано у: 3.19.45

Опис: Отримання информации о зависимых абонентах
Обов'язкові параметри:
 device_id - id пристрої
Необов'язкові параметри:
 port_start - начальный номер порта
 port_finish - конечный номер порта

delete_mark

Змінено у 3.19beta1 (параметр object_type исключен)

Опис: Снятие метки
Обов'язкові параметри:
 object_type - Тип пристрої [switch] (до версії 3.19beta1)
 object_id - id пристрої
 mark_id - ID метки

read_fdb

Додано з: 3.15.7

Опис: Чтение FDB-таблицы с пристрої (может выполняться продолжительное час)
Обов'язкові параметри:
 device_id - id пристрої

set_data

Змінено у 3.19beta1 (параметр object_type исключен)

Доопрацьовано у 3.17dev1 (в параметр param добавлено возможное значення date_last_activity)

Доопрацьовано у 3.14.53 (в параметр param добавлено возможное значення downlink_port, uplink_port)

Доопрацьовано у 3.13.61 (в параметр param добавлено возможное значення iface_count)

Доопрацьовано у 3.12.74 (в параметр param добавлено возможное значення comment)

Опис: Зміна информации об устройстве
Обов'язкові параметри:
 object_type - Тип пристрої [switch] (до версії 3.19beta1)
 object_id - id пристрої
 param - тип параметра для изменения [ip|mac|comment|iface_count|downlink_port|uplink_port|date_last_activity]
 value - данные (может быть пустым)

set_iface_state

Додано з: 3.15beta3

Опис: Зміна состояния интерфейса на устройстве
Обов'язкові параметри:
 device_id - id пристрої
 iface - номер интерфейса
 state - стан [1|0]

find_mac

Додано з: 3.12beta25

Опис: Поиск MAC-адреса в истории опроса по оборудованию
Обов'язкові параметри:
 mac - MAC-адрес (верхній регістр без разделителей)