API device: различия между версиями

Материал из WiKi - UserSide
Нет описания правки
Строка 22: Строка 22:
   object_id - id объекта для выборки
   object_id - id объекта для выборки
   is_online - флаг - выбирать только активные устройства
   is_online - флаг - выбирать только активные устройства
==== get_iface_mac ====
''Добавлено с: 3.12beta25''
Описание: Список интерфейсов с MAC-адресами на устройстве
Обязательные параметры:
  object_type - Тип устройства [switch]
  object_id - id устройства для выборки


==== get_mac_list ====
==== get_mac_list ====

Версия от 20:37, 7 января 2018

Раздел API ERP "UserSide"

Назначение: Оборудование

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

Подкатегории

get_device_id

Описание: Получение ID устройства по входящим данным
Обязательные параметры:
 object_type - Тип устройства [switch]
 data_typer - тип данных, которые проверяем (возможные значения: ip, inventory_number, additional_field_XXX)
 data_value - значение

get_data

Описание: Получение информации об устройствах
Обязательные параметры:
 object_type - Тип устройства [switch|onu]
Необязательные параметры:
 object_id - id объекта для выборки
 is_online - флаг - выбирать только активные устройства

get_iface_mac

Добавлено с: 3.12beta25

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

get_mac_list

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

add_mark

Описание: Добавление метки
Обязательные параметры:
 object_type - Тип устройства [switch]
 object_id - id устройства
 mark_id - ID метки

delete_mark

Описание: Снятие метки
Обязательные параметры:
 object_type - Тип устройства [switch]
 object_id - id устройства
 mark_id - ID метки

set_data

Описание: Изменение информации об устройстве
Обязательные параметры:
 object_type - Тип устройства [switch]
 object_id - id устройства
 param - тип параметра для изменения [ip|mac]
 value - данные (может быть пустым)