API additional data: различия между версиями
Admin (обсуждение | вклад) |
Admin (обсуждение | вклад) |
||
| (не показано 16 промежуточных версий 2 участников) | |||
| Строка 1: | Строка 1: | ||
[[API_additional_data_EN|en]] | [[API_additional_data|ru]] | |||
Раздел '''[[API]]''' ERP "UserSide" | Раздел '''[[API]]''' ERP "UserSide" | ||
| Строка 8: | Строка 10: | ||
Дополнительные поля имеют категории (cat_id) | Дополнительные поля имеют категории (cat_id) | ||
1 - Сотрудники | 1 - Сотрудники ''(до 3.16dev2)'' | ||
2 - | 2 - Кабельные линии | ||
4 - Абоненты (все) | 4 - Абоненты ''(все. До 3.14)'' | ||
5 - Абоненты (юр.лица) | 5 - Абоненты ''(юр.лица. До 3.14)'' | ||
6 - Радиооборудование | 6 - Радиооборудование | ||
7 - | 7 - Здания | ||
8 - Коммутаторы | 8 - Коммутаторы | ||
9 - Медиаконвертеры | 9 - Медиаконвертеры | ||
10 - Системные устройства | 10 - Системные устройства | ||
11 - Операторы | 11 - Операторы ''(до 3.16dev2)'' | ||
12 - Тарифы (только для ручных биллингов) | 12 - Тарифы (только для ручных биллингов) | ||
13 - Дополнительные услуги (только для ручных биллингов) | 13 - Дополнительные услуги (только для ручных биллингов) | ||
14 - | 14 - Сооружения связи | ||
15 - Кроссы/ODF | 15 - Кроссы/ODF | ||
16 - VLAN | 16 - VLAN | ||
| Строка 28: | Строка 30: | ||
20 - Произвольные устройства | 20 - Произвольные устройства | ||
21 - Поставщики | 21 - Поставщики | ||
22 - Потенциальные абоненты | 22 - Потенциальные абоненты ''(до 3.14)'' | ||
23 - Делители/Уплотнители | 23 - Делители/Уплотнители | ||
24 - Собственники | 24 - Собственники | ||
25 - ТМЦ | 25 - ТМЦ | ||
26 - Кабельные каналы | 26 - Кабельные каналы | ||
27 - Кабельные трассы ''(кабельных линий)'' | |||
28 - Абоненты ''(все. С 3.14)'' | |||
29 - Ключи | |||
30 - Наименования ТМЦ ''(с 3.14.5)'' | |||
40 - Адресные единицы ''(с 3.14.14)'' | |||
48 - Склады ''(с 3.14.12)'' | |||
999 - Сотрудники ''(с 3.16dev2)'' | |||
Дополнительные поля имеют тип поля (type) | Дополнительные поля имеют тип поля (type) | ||
| Строка 48: | Строка 57: | ||
==== get_list ==== | ==== get_list ==== | ||
''Доработано в: 3.14.22 (в параметре section можно использовать числовые значения)'' | |||
Описание: Получение списка полей | Описание: Получение списка полей | ||
Обязательные параметры: | Обязательные параметры: | ||
section - Категория дополнительных полей [house|node|task|switch|inventory] | section - Категория дополнительных полей [house|node|task|switch|inventory|...числовые значения из каталога выше...] | ||
==== add_field ==== | ==== add_field ==== | ||
| Строка 91: | Строка 101: | ||
==== change_value ==== | ==== change_value ==== | ||
''Доработано в: 3.18.27 (параметр cat_id сделан обязательным)'' | |||
Описание: Изменение значения доп.поля | Описание: Изменение значения доп.поля | ||
В случае отсутствия такого доп.поля у объекта - оно будет создано. | В случае отсутствия такого доп.поля у объекта - оно будет создано. | ||
| Строка 97: | Строка 110: | ||
object_id - id объекта | object_id - id объекта | ||
value - значение | value - значение | ||
cat_id - категория ( | cat_id - категория ''(см.выше справочник)'' | ||
==== change_value_mass ==== | |||
''Добавлено в: 3.19beta1'' | |||
Описание: Массовое изменение значения доп.поля для множества объектов | |||
В случае отсутствия такого доп.поля у объекта - оно будет создано. | |||
Обязательные параметры: | |||
cat_id - категория ''(см.выше справочник)'' | |||
field_id - id дополнительного поля | |||
data[] - id объекта|значение | |||
data[] - id объекта|значение | |||
data[] - id объекта|значение | |||
... | |||
Текущая версия от 19:24, 16 марта 2024
Раздел 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) 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.12.80
Описание: Получение значений полей Обязательные параметры: field_id - 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 объекта|значение ...