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

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

Версия от 17:16, 14 декабря 2017

Раздел 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_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 - данные (может быть пустым)