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

Текущая версия от 10:50, 10 мая 2026

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

@@ Строка 1: / Строка 1: @@
 [[API_additional_data_EN|en]] | '''uk''' | [[API additional_data|ru]]
-Розділ '''[[API]]''' ERP "UserSide"
+Розділ '''[[API_UK|API]]''' ERP "UserSide"
-Призначення: Дія с дополнительными полями/данными
+Призначення: Робота з додатковими полями/даними
   Додаткові параметри:
   action - підкатегорія запиту ''(можливе значення: див. нижче)''
-Додаткові поля имеют категории (cat_id)
+Додаткові поля мають категорії (cat_id)
 - Співробітники ''(до 3.16dev2)''
@@ Строка 14: / Строка 14: @@
 - Абоненти ''(усі. До 3.14)''
 - Абоненти ''(юр.особи. До 3.14)''
-- Радиообладнання
+- Радіообладнання
-- Здания
+- Будівлі
 - Комутатори
-- Медиаконвертеры
+- Медіаконвертери
-- Системные пристрої
+- Системні пристрої
 - Оператори ''(до 3.16dev2)''
-- Тарифи (только для ручних білінгів)
+- Тарифи (тільки для ручних білінгів)
-- Додаткові послуги (только для ручних білінгів)
+- Додаткові послуги (тільки для ручних білінгів)
 - Об'єкти інфраструктури
 - Кроси/ODF
@@ Строка 28: / Строка 28: @@
 - Автотранспорт
 - Рекламні кампанії
-- Произвольные пристрої
+- Довільні пристрої
 - Постачальники
 - Потенційні абоненти ''(до 3.14)''
@@ Строка 35: / Строка 35: @@
 - ТМЦ
 - Кабельні канали
-- Кабельні траси ''(кабельных линий)''
+- Кабельні траси ''(кабельних ліній)''
-- Абоненти ''(усі. С 3.14)''
+- Абоненти ''(усі. З 3.14)''
 - Ключі
-- Наименования ТМЦ ''(с 3.14.5)''
+- Найменування ТМЦ ''(з 3.14.5)''
-- Адресные единицы ''(с 3.14.14)''
+- Адресні одиниці ''(з 3.14.14)''
-- Склады ''(с 3.14.12)''
+- Склади ''(з 3.14.12)''
-- Об'єкты на карте ''(с 3.19.31)''
+- Об'єкти на карті ''(з 3.19.31)''
-- Співробітники ''(с 3.16dev2)''
+- Співробітники ''(з 3.16dev2)''
-Додаткові поля имеют тип поля (type)
+Додаткові поля мають тип поля (type)
 - Текст
 - Число
-- Флаг
+- Прапорець
-- Выбор из списка
+- Вибір зі списку
-- Текстовое поле
+- Текстове поле
-- Выбор из списка (в т.ч. свой вариант)
+- Вибір зі списку (в т.ч. свій варіант)
 - Дата
-- Выбор из списка (несколько значений)
+- Вибір зі списку (кілька значень)
 == Підкатегорії ==
 ==== get_list ====
-''Доопрацьовано у: 3.14.22 (в параметре section можно использовать числовые значення)''
+''Доопрацьовано у: 3.14.22 (у параметрі section можна використовувати числові значення)''
-  Опис: Отримання списка полей
+  Опис: Отримання списку полів
   Обов'язкові параметри:
-   section - Категорія дополнительных полей [house|node|task|switch|inventory|...числовые значення из каталога выше...]
+   section - Категорія додаткових полів [house|node|task|switch|inventory|...числові значення з каталогу вище...]
 ==== add_field ====
-  Опис: Додавання доп.поля
+  Опис: Додавання додаткового поля
   Обов'язкові параметри:
    cat_id - категорія (див. вище довідник)
@@ Строка 71: / Строка 71: @@
   Необов'язкові параметри
    type - тип поля (див. вище довідник)
-   size - размер поля
+   size - розмір поля
-   max_size - максимальный размер поля
+   max_size - максимальний розмір поля
-   is_active - прапорець - поле включено
+   is_active - прапорець - поле увімкнено
-   position - позиция поля среди остальных
+   position - позиція поля серед інших
-   is_require - прапорець - обязательное к заполнению
+   is_require - прапорець - обов'язкове до заповнення
 ==== edit_field ====
 ''Доопрацьовано у: 3.13.14 (додано параметр value_list)''
-  Опис: Редагування доп.поля
+  Опис: Редагування додаткового поля
   Обов'язкові параметри:
    cat_id - категорія (див. вище довідник)
    id - id поля
   Необов'язкові параметри
-   См. из метода add_field
+   Див. з методу add_field
-   value_list - возможные значення для типа поля "Выбор из списка" ''(розділювач - вертикальна риска "|")''
+   value_list - можливі значення для типу поля "Вибір зі списку" ''(розділювач - вертикальна риска "|")''
 ==== delete_field ====
-  Опис: Видалення доп.поля (удаляется только если нет записей с этим доп.полем)
+  Опис: Видалення додаткового поля (видаляється лише якщо немає записів із цим додатковим полем)
   Обов'язкові параметри:
    cat_id - категорія (див. вище довідник)
@@ Строка 98: / Строка 98: @@
 ''Додано з: 3.12.80''
-  Опис: Отримання значений полей
+  Опис: Отримання значень полів
   Обов'язкові параметри:
    field_id - id поля
   Необов'язкові параметри:
    cat_id - категорія ''(див. вище довідник)''
-   object_id - id об'єкта ''(по которому значення поля)''
+   object_id - id об'єкта ''(за яким значення поля)''
    value - значення поля
@@ Строка 110: / Строка 110: @@
 ''Доопрацьовано у: 3.18.27 (параметр cat_id зроблено обов'язковим)''
-  Опис: Зміна значення доп.поля
+  Опис: Зміна значення додаткового поля
-  В случае отсутствия такого доп.поля у об'єкта - оно будет создано.
+  Якщо такого додаткового поля в об'єкта немає, його буде створено.
   Обов'язкові параметри:
-   field_id - id дополнительного поля
+   field_id - id додаткового поля
    object_id - id об'єкта
    value - значення
@@ Строка 122: / Строка 122: @@
 ''Додано у: 3.19beta1''
-  Опис: Массовое зміна значення доп.поля для множества об'єктів
+  Опис: Масова зміна значення додаткового поля для багатьох об'єктів
-  В случае отсутствия такого доп.поля у об'єкта - оно будет создано.
+  Якщо такого додаткового поля в об'єкта немає, його буде створено.
   Обов'язкові параметри:
    cat_id - категорія ''(див. вище довідник)''
-   field_id - id дополнительного поля
+   field_id - id додаткового поля
    data[] - id об'єкта|значення
    data[] - id об'єкта|значення
    data[] - id об'єкта|значення
    ...