REST API: Работа с файлами: различия между версиями
Материал из Planfix
Artem (обсуждение | вклад) Нет описания правки |
Artem (обсуждение | вклад) |
||
| (не показано 6 промежуточных версий этого же участника) | |||
| Строка 1: | Строка 1: | ||
{{#seo: | |||
|title=REST API: Работа с файлами | |||
|titlemode=append | |||
|keywords=планфикс, апи, api, rest, rest api, файлы, работа с файлами, api работа с файлами | |||
|description=REST API: Работа с файлами | |||
}} | |||
[[REST API]] ПланФикса поддерживает работу с файлами. | [[REST API]] ПланФикса поддерживает работу с файлами. | ||
*[[#Прикрепить и обновить |Прикрепить и обновить]] | |||
*[[#Получить список файлов |Получить список файлов]] | |||
== Прикрепить и обновить == | == Прикрепить и обновить == | ||
| Строка 6: | Строка 14: | ||
*[[#Контакт |Контактах]] | *[[#Контакт |Контактах]] | ||
*[[#Проект |Проектах]] | *[[#Проект |Проектах]] | ||
*[[#Справочник |Справочниках]] | |||
=== '''Задача''' === | |||
=== Задача === | |||
*Файлы крепятся или обновляются только в описании задачи. | *Файлы крепятся или обновляются только в описании задачи. | ||
*Прикрепить файлы к описанию во время создания задачи: | *Прикрепить файлы к описанию во время создания задачи: | ||
https://p.pfx.so/pf/6y/8jd89h.png | https://p.pfx.so/pf/6y/8jd89h.png | ||
*Обновить файлы в описании задачи: | *Обновить файлы в описании задачи: | ||
https://p.pfx.so/pf/Eg/dTxTaM.png | https://p.pfx.so/pf/Eg/dTxTaM.png | ||
| Строка 25: | Строка 31: | ||
*Если поле files передано не будет, файлы обновляться не будут. | *Если поле files передано не будет, файлы обновляться не будут. | ||
=== '''Контакт''' === | |||
=== Контакт === | |||
*Файлы крепятся или обновляются только в описании контакта. | *Файлы крепятся или обновляются только в описании контакта. | ||
*Прикрепить файлы к описанию во время создания контакта: | *Прикрепить файлы к описанию во время создания контакта: | ||
https://p.pfx.so/pf/i2/pKTt3M.png | https://p.pfx.so/pf/i2/pKTt3M.png | ||
*Обновить файлы в описании контакта: | *Обновить файлы в описании контакта: | ||
https://p.pfx.so/pf/Iw/dejkxz.png | https://p.pfx.so/pf/Iw/dejkxz.png | ||
| Строка 43: | Строка 46: | ||
*Если поле files передано не будет, файлы обновляться не будут. | *Если поле files передано не будет, файлы обновляться не будут. | ||
=== '''Проект''' === | |||
=== Проект === | |||
*Файлы крепятся или обновляются только в документах проекта. | *Файлы крепятся или обновляются только в документах проекта. | ||
*Прикрепить файлы во время создания проекта: | *Прикрепить файлы во время создания проекта: | ||
https://p.pfx.so/pf/6R/EKGUPU.png | https://p.pfx.so/pf/6R/EKGUPU.png | ||
*Обновить файлы в проекте: | *Обновить файлы в проекте: | ||
https://p.pfx.so/pf/Wg/fsElGe.png | https://p.pfx.so/pf/Wg/fsElGe.png | ||
| Строка 60: | Строка 60: | ||
*Если передан пустой массив, файлы будут откреплены от проекта и удалены, если нигде более не используются. | *Если передан пустой массив, файлы будут откреплены от проекта и удалены, если нигде более не используются. | ||
*Если поле files передано не будет, файлы обновляться не будут. | *Если поле files передано не будет, файлы обновляться не будут. | ||
=== '''Справочник''' === | |||
Добавление файла в запись справочника выполняется в два этапа: | |||
1. Загрузите файл в систему, используя один из методов REST API: | |||
*/file/ — загрузка файла из локального источника. | |||
*/file/from-url/ — загрузка файла по ссылке. | |||
Необходимо передать в параметре '''targetType''' значение '''directory'''. | |||
https://p.pfx.so/pf/jk/gOv7DU.png | |||
В ответе вы получите идентификатор загруженного файла. | |||
2. Создаем новую запись справочника и добавляем файл в поле типа файлы | |||
https://p.pfx.so/pf/hz/XH7XwC.png | |||
Или обновляем существующую запись справочника | |||
https://p.pfx.so/pf/Cg/0G5Oy1.png | |||
'''Важно:''' | |||
*При обновлении записи файлы заменяются теми, что переданы в параметре '''value'''. | |||
== Получить список файлов == | |||
Через API можно получить список файлов из: | |||
*[[#Задачи |Задачи]] | |||
*[[#Контакта |Контакта]] | |||
*[[#Проекта |Проекта]] | |||
=== Задачи === | |||
У метода есть параметр onlyFromDescription, который позволяет получать файлы только из описания задачи: | |||
https://p.pfx.so/pf/tu/IpVMnG.png | |||
=== Контакта === | |||
У метода есть параметр onlyFromDescription, который позволяет получать файлы только из описания контакта: | |||
https://p.pfx.so/pf/eh/PlMgOD.png | |||
=== Проекта === | |||
У метода есть параметры pageSize и offset, для постраничной навигации по списку: | |||
https://p.pfx.so/pf/oa/EmFu1e.png | |||
== Перейти == | |||
*[[REST API]] | |||
*[[API ПланФикса]] | |||
Текущая версия от 13:31, 10 ноября 2025
REST API ПланФикса поддерживает работу с файлами.
Прикрепить и обновить
Через API можно прикреплять или обновлять ранее загруженные файлы в:
Задача
- Файлы крепятся или обновляются только в описании задачи.
- Прикрепить файлы к описанию во время создания задачи:
- Обновить файлы в описании задачи:
Важно:
- Файлы заменяются теми, что переданы в параметре files.
- Если передан пустой массив, файлы будут откреплены от задачи и удалены, если нигде более не используются.
- Если поле files передано не будет, файлы обновляться не будут.
Контакт
- Файлы крепятся или обновляются только в описании контакта.
- Прикрепить файлы к описанию во время создания контакта:
- Обновить файлы в описании контакта:
Важно:
- Файлы заменяются теми, что переданы в параметре files.
- Если передан пустой массив, файлы будут откреплены от контакта и удалены, если нигде более не используются.
- Если поле files передано не будет, файлы обновляться не будут.
Проект
- Файлы крепятся или обновляются только в документах проекта.
- Прикрепить файлы во время создания проекта:
- Обновить файлы в проекте:
Важно:
- Файлы заменяются теми, что переданы в параметре files.
- Если передан пустой массив, файлы будут откреплены от проекта и удалены, если нигде более не используются.
- Если поле files передано не будет, файлы обновляться не будут.
Справочник
Добавление файла в запись справочника выполняется в два этапа:
1. Загрузите файл в систему, используя один из методов REST API:
- /file/ — загрузка файла из локального источника.
- /file/from-url/ — загрузка файла по ссылке.
Необходимо передать в параметре targetType значение directory.
В ответе вы получите идентификатор загруженного файла.
2. Создаем новую запись справочника и добавляем файл в поле типа файлы
Или обновляем существующую запись справочника
Важно:
- При обновлении записи файлы заменяются теми, что переданы в параметре value.
Получить список файлов
Через API можно получить список файлов из:
Задачи
У метода есть параметр onlyFromDescription, который позволяет получать файлы только из описания задачи:
Контакта
У метода есть параметр onlyFromDescription, который позволяет получать файлы только из описания контакта:
Проекта
У метода есть параметры pageSize и offset, для постраничной навигации по списку:
