API attach UK

en | uk | ru

Розділ API ERP "UserSide"

Призначення: Робота з прикріпленими файлами

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

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

add

Доопрацьовано у: 3.21.0-beta.3 (виключено параметри src, name, comment, src_id)

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

Доопрацьовано у: 3.16.19 (додано параметри name і comment)

Доопрацьовано у: 3.16dev4 (до параметра object_type додано можливе значення cable_line)

Доопрацьовано у: 3.16dev2 (виключено параметр operator_id, додано параметр employee_id)

Доопрацьовано у: 3.15.42 (до параметра object_type додано можливе значення inventory)

Доопрацьовано у: 3.14.21 (до параметра object_type додано можливе значення customer)

Опис: Додавання файла до об'єкта
Обов'язкові параметри:
 object_type - тип об'єкта [cable_line|customer|node|task|task_comment|inventory]
 object_id - id об'єкта, до якого прикріплювати файл
 comment_id - id коментаря до завдання, до якого прикріплювати файл (для типу task_comment)
 uuid - uuid іншого файла, який уже завантажений і який потрібно прикріпити до іншого об'єкта
Необов'язкові параметри:
 employee_id - id співробітника, від імені якого прикріпити файл
 name - ім'я файла (довільний текст) (до версії 3.21)
 comment - нотатки/опис до файла (до версії 3.21)
 src_id - id методу/типу завантаження файла (довільно, на розсуд клієнта) (до версії 3.21)

delete

Доопрацьовано у: 3.19beta1 (виключено параметр id, додано параметр uuid)

Додано з: 3.12beta25

Опис: Видалення файла
Обов'язкові параметри:
 id - id файла (версії до 3.19)
 uuid - uuid файла (версія 3.19+)
 name - ім'я файла (без шляхів)

get

Доопрацьовано у: 3.20.23 (до параметра object_type додано можливе значення additional_field)

Доопрацьовано у: 3.19beta1 (виключено параметр id, додано параметр uuid)

Доопрацьовано у: 3.16dev4 (до параметра object_type додано можливе значення cable_line)

Доопрацьовано у: 3.15.42 (до параметра object_type додано можливе значення inventory)

Доопрацьовано у: 3.15.12 (додано параметри object_type і object_id)

Доопрацьовано у: 3.14.41 (додано параметри ext_name і int_name)

Додано з: 3.14.36

Опис: Отримання інформації
Обов'язкові параметри (щось одне):
 uuid - uuid файла (можна через кому) (версії 3.19+)
 id - id файла (можна через кому) (версії до 3.19)
 ext_name - зовнішнє ім'я файла (початкове)
 int_name - внутрішнє ім'я файла (як зберігається в системі)
 object_type - тип об'єкта [additional_field|cable_line|customer|inventory|node|task|task_comment] (використовується разом з object_id)
 object_id - id/uuid об'єкта, до якого прикріплений файл (використовується разом з object_type)

get_file

Доопрацьовано у: 3.19beta1 (виключено параметр id, додано параметр uuid)

Додано з: 3.14.57

Опис: Виведення вмісту файла (у бінарному вигляді)
Обов'язкові параметри:
 uuid - uuid файла (версії 3.19+)
 id - id файла (версії до 3.19)

get_file_temporary_link

Доопрацьовано у: 3.19beta1 (виключено параметр id, додано параметр uuid)

Додано з: 3.17dev1

Опис: Надання прямого тимчасового посилання для завантаження файла
Обов'язкові параметри:
 uuid - uuid файла (версії 3.19+)
 id - id файла (версії до 3.19)

upload

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

Додано з: 3.21.0-beta.3

Опис: Завантаження (додавання) файла до об'єкта.

content-type=multipart/form-data

Обов'язкові параметри:
 object_type - тип об'єкта [cable_line|customer|node|task|task_comment|inventory]
 object_id - id об'єкта, до якого прикріплювати файл
 comment_id - id коментаря до завдання, до якого прикріплювати файл (для object_type=task_comment)
 file - файл
Необов'язкові параметри:
 additional_field_id - id додаткового поля (якщо потрібно прикріпити файл до додаткового поля об'єкта. Тип додаткового поля має бути "Файл")
 employee_id - id співробітника, від імені якого додати файл
 name - ім'я файла (довільний текст)
 comment - нотатки/опис до файла
 src_id - id методу/типу завантаження файла (довільно, на розсуд клієнта)