API additional data UK

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 об'єкта|значення
 ...