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

Материал из WiKi - UserSide
Нет описания правки
Строка 19: Строка 19:
   operator_id - id оператора, от имени которого добавить файл
   operator_id - id оператора, от имени которого добавить файл
   src_id - id метода/типа загрузки файла (произвольно, на усмотрение клиента)
   src_id - id метода/типа загрузки файла (произвольно, на усмотрение клиента)
Дополнительно возвращаемые данные:
  array(
  [file_id] => id добавленного файла в случае успеха
  [file_name] => присвоенное имя для файла. Файл будет лежать в директории /main/attach/
  )


==== delete ====
==== delete ====
Строка 42: Строка 37:
   ext_name - внешнее имя файла ''(исходное)''
   ext_name - внешнее имя файла ''(исходное)''
   int_name - внутреннее имя файла ''(как хранится в системе)''
   int_name - внутреннее имя файла ''(как хранится в системе)''
==== get_file ====
''Добавлено с: 3.14.57''
Описание: Вывод содержимого файла ''(в бинарном виде)''
Обязательные параметры:
  id - id файла

Версия от 10:28, 30 апреля 2020

Раздел API ERP "UserSide"

Назначение: Действие с прикрепляемыми файлами

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

Подкатегории

add

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

Описание: Добавление файла к объекту
Обязательные параметры:
 object_type - тип объекта [customer|node|task|task_comment]
 object_id - id объекта, к которому прикреплять файл
 comment_id - id комментария к заданию, к которому прикреплять файл (для типа task_comment)
 src - url к файлу, который требуется загрузить и прикрепить
Необязательные параметры:
 operator_id - id оператора, от имени которого добавить файл
 src_id - id метода/типа загрузки файла (произвольно, на усмотрение клиента)

delete

Добавлено с: 3.12beta25

Описание: Удаление файла
Обязательные параметры:
 id - id файла
 name - имя файла (без путей)

get

Доработано в: 3.14.41 (добавлены параметры ext_name и int_name)

Добавлено с: 3.14.36

Описание: Получение информации
Обязательные параметры (что-то одно):
 id - id файла (можно через запятую)
 ext_name - внешнее имя файла (исходное)
 int_name - внутреннее имя файла (как хранится в системе)

get_file

Добавлено с: 3.14.57

Описание: Вывод содержимого файла (в бинарном виде)
Обязательные параметры:
 id - id файла