API attach: различия между версиями
Admin (обсуждение | вклад) (→add) |
Admin (обсуждение | вклад) (→upload) |
||
| (не показано 12 промежуточных версий 3 участников) | |||
| Строка 1: | Строка 1: | ||
[[API_attach_EN|en]] | [[API_attach_UK|uk]] | '''ru''' | |||
Раздел '''[[API]]''' ERP "UserSide" | Раздел '''[[API]]''' ERP "UserSide" | ||
| Строка 9: | Строка 11: | ||
==== add ==== | ==== add ==== | ||
''Доработано в: 3.21.0-beta.3 (исключен параметр src, name, comment, src_id)'' | |||
''Доработано в: 3.19.48 (добавлен параметр uuid)'' | |||
''Доработано в: 3.16.19 (добавлены параметры name и comment)'' | ''Доработано в: 3.16.19 (добавлены параметры name и comment)'' | ||
| Строка 19: | Строка 25: | ||
''Доработано в: 3.14.21 (в параметр object_type добавлено возможное значение customer)'' | ''Доработано в: 3.14.21 (в параметр object_type добавлено возможное значение customer)'' | ||
Описание: Добавление файла к объекту | Описание: Добавление существующего файла к объекту | ||
Обязательные параметры: | Обязательные параметры: | ||
object_type - тип объекта [cable_line|customer|node|task|task_comment|inventory] | object_type - тип объекта [cable_line|customer|node|task|task_comment|inventory] | ||
object_id - id объекта, к которому прикреплять файл | object_id - id объекта, к которому прикреплять файл | ||
comment_id - id комментария к заданию, к которому прикреплять файл ''(для типа task_comment)'' | comment_id - id комментария к заданию, к которому прикреплять файл ''(для типа task_comment)'' | ||
uuid - uuid с иным файлом, который уже загружен и который требуется прикрепить к иному объекту | |||
Необязательные параметры: | Необязательные параметры: | ||
employee_id - id сотрудника, от имени которого | employee_id - id сотрудника, от имени которого прикрепить файл | ||
name - имя файла ''(произвольный текст)'' ''(до версии 3.21)'' | |||
comment - заметки/описание к файлу ''(до версии 3.21)'' | |||
comment - заметки/описание к файлу | src_id - id метода/типа загрузки файла ''(произвольно, на усмотрение клиента)'' ''(до версии 3.21)'' | ||
src_id - id метода/типа загрузки файла (произвольно, на усмотрение клиента) | |||
==== delete ==== | ==== delete ==== | ||
''Доработано в: 3.19beta1 (исключен параметр id, добавлен параметр uuid)'' | |||
''Добавлено с: 3.12beta25'' | ''Добавлено с: 3.12beta25'' | ||
Описание: Удаление файла | Описание: Удаление файла | ||
Обязательные параметры: | Обязательные параметры: | ||
id - id файла | id - id файла ''(версии до 3.19)'' | ||
uuid - uuid файла ''(версия 3.19+)'' | |||
name - имя файла ''(без путей)'' | name - имя файла ''(без путей)'' | ||
==== get ==== | ==== get ==== | ||
''Доработано в: 3.20.23 (в параметр object_type добавлено возможное значение additional_field)'' | |||
''Доработано в: 3.19beta1 (исключен параметр id, добавлен параметр uuid)'' | |||
''Доработано в: 3.16dev4 (в параметр object_type добавлено возможное значение cable_line)'' | ''Доработано в: 3.16dev4 (в параметр object_type добавлено возможное значение cable_line)'' | ||
| Строка 52: | Строка 63: | ||
Описание: Получение информации | Описание: Получение информации | ||
Обязательные параметры ''(что-то одно)'': | Обязательные параметры ''(что-то одно)'': | ||
id - id файла ''(можно через запятую)'' | uuid - uuid файла ''(можно через запятую)'' ''(версии 3.19+)'' | ||
id - id файла ''(можно через запятую)'' ''(версии до 3.19)'' | |||
ext_name - внешнее имя файла ''(исходное)'' | ext_name - внешнее имя файла ''(исходное)'' | ||
int_name - внутреннее имя файла ''(как хранится в системе)'' | int_name - внутреннее имя файла ''(как хранится в системе)'' | ||
object_type - тип объекта [cable_line|customer|inventory|node|task|task_comment] ''(используется совместно с object_id)'' | object_type - тип объекта [additional_field|cable_line|customer|inventory|node|task|task_comment] ''(используется совместно с object_id)'' | ||
object_id - id объекта, к которому прикреплён файл ''(используется совместно с object_type)'' | object_id - id/uuid объекта, к которому прикреплён файл ''(используется совместно с object_type)'' | ||
==== get_file ==== | ==== get_file ==== | ||
''Доработано в: 3.19beta1 (исключен параметр id, добавлен параметр uuid)'' | |||
''Добавлено с: 3.14.57'' | ''Добавлено с: 3.14.57'' | ||
Описание: Вывод содержимого файла ''(в бинарном виде)'' | Описание: Вывод содержимого файла ''(в бинарном виде)'' | ||
Обязательные параметры: | Обязательные параметры: | ||
id - id файла | 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.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 - файл | |||
Необязательные параметры: | |||
employee_id - id сотрудника, от имени которого добавить файл | |||
name - имя файла ''(произвольный текст)'' | |||
comment - заметки/описание к файлу | |||
src_id - id метода/типа загрузки файла ''(произвольно, на усмотрение клиента)'' | |||
Текущая версия от 10:43, 30 мая 2026
Раздел 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.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 - файл Необязательные параметры: employee_id - id сотрудника, от имени которого добавить файл name - имя файла (произвольный текст) comment - заметки/описание к файлу src_id - id метода/типа загрузки файла (произвольно, на усмотрение клиента)