API additional data UK

Материал из WiKi - UserSide
Версия от 08:35, 10 мая 2026; IronBot (обсуждение | вклад) (Add Ukrainian API docs and trilingual API links)

en | uk | ru

Розділ API ERP "UserSide"

Призначення: Дія с дополнительными полями/данными

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

Додаткові поля имеют категории (cat_id)

1 - Співробітники (до 3.16dev2)
2 - Кабельні лінії
4 - Абоненти (усі. До 3.14)
5 - Абоненти (юр.особи. До 3.14)
6 - Радиообладнання
7 - Здания
8 - Комутатори
9 - Медиаконвертеры
10 - Системные пристрої
11 - Оператори (до 3.16dev2)
12 - Тарифи (только для ручних білінгів)
13 - Додаткові послуги (только для ручних білінгів)
14 - Об'єкти інфраструктури
15 - Кроси/ODF
16 - VLAN
17 - Завдання
18 - Автотранспорт
19 - Рекламні кампанії
20 - Произвольные пристрої
21 - Постачальники
22 - Потенційні абоненти (до 3.14)
23 - Сплітери
24 - Власники
25 - ТМЦ
26 - Кабельні канали
27 - Кабельні траси (кабельных линий)
28 - Абоненти (усі. С 3.14)
29 - Ключі
30 - Наименования ТМЦ (с 3.14.5)
40 - Адресные единицы (с 3.14.14)
48 - Склады (с 3.14.12)
102 - Об'єкты на карте (с 3.19.31)
999 - Співробітники (с 3.16dev2)


Додаткові поля имеют тип поля (type)

1 - Текст
2 - Число
3 - Флаг
4 - Выбор из списка
5 - Текстовое поле
6 - Выбор из списка (в т.ч. свой вариант)
7 - Дата
8 - Выбор из списка (несколько значень)

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

get_list

Доопрацьовано у: 3.14.22 (в параметре section можно использовать числовые значення)

Опис: Отримання списка полей
Обов'язкові параметри:
 section - Категорія дополнительных полей [house|node|task|switch|inventory|...числовые значення из каталога выше...]

add_field

Опис: Додавання доп.поля 
Обов'язкові параметри:
 cat_id - категорія (див. вище довідник)
 name - найменування
Необов'язкові параметри
 type - тип поля (див. вище довідник)
 size - размер поля
 max_size - максимальный размер поля
 is_active - прапорець - поле включено
 position - позиция поля среди остальных
 is_require - прапорець - обязательное к заполнению

edit_field

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

Опис: Редагування доп.поля 
Обов'язкові параметри:
 cat_id - категорія (див. вище довідник)
 id - id поля
Необов'язкові параметри
 См. из метода add_field
 value_list - возможные значення для типа поля "Выбор из списка" (розділювач - вертикальна риска "|")

delete_field

Опис: Видалення доп.поля (удаляется только если нет записей с этим доп.полем)
Обов'язкові параметри:
 cat_id - категорія (див. вище довідник)
 id - id поля

get_value

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

Додано з: 3.12.80

Опис: Отримання значень полей
Обов'язкові параметри:
 field_id - id поля
Необов'язкові параметри:
 cat_id - категорія (див. вище довідник)
 object_id - id об'єкта (по которому значення поля)
 value - значення поля

change_value

Доопрацьовано у: 3.18.27 (параметр cat_id зроблено обов'язковим)

Опис: Зміна значення доп.поля 
В случае отсутствия такого доп.поля у об'єкта - оно будет создано.
Обов'язкові параметри:
 field_id - id додаткового поля
 object_id - id об'єкта
 value - значення
 cat_id - категорія (див. вище довідник)

change_value_mass

Додано у: 3.19beta1

Опис: Массовое зміна значення доп.поля для множества об'єктів
В случае отсутствия такого доп.поля у об'єкта - оно будет создано.
Обов'язкові параметри:
 cat_id - категорія (див. вище довідник)
 field_id - id додаткового поля
 data[] - id об'єкта|значення
 data[] - id об'єкта|значення
 data[] - id об'єкта|значення
 ...