REST API: Работа с файлами: различия между версиями
Материал из Planfix
Artem (обсуждение | вклад) Нет описания правки |
Artem (обсуждение | вклад) Нет описания правки |
||
| Строка 8: | Строка 8: | ||
*[[#Прикрепить и обновить |Прикрепить и обновить]] | *[[#Прикрепить и обновить |Прикрепить и обновить]] | ||
*[[#Получить список файлов |Получить список файлов]] | *[[#Получить список файлов |Получить список файлов]] | ||
== Прикрепить и обновить == | == Прикрепить и обновить == | ||
| Строка 15: | Строка 14: | ||
*[[#Контакт |Контактах]] | *[[#Контакт |Контактах]] | ||
*[[#Проект |Проектах]] | *[[#Проект |Проектах]] | ||
=== Задача === | === Задача === | ||
| Строка 31: | Строка 29: | ||
*Если передан пустой массив, файлы будут откреплены от задачи и удалены, если нигде более не используются. | *Если передан пустой массив, файлы будут откреплены от задачи и удалены, если нигде более не используются. | ||
*Если поле files передано не будет, файлы обновляться не будут. | *Если поле files передано не будет, файлы обновляться не будут. | ||
=== Контакт === | === Контакт === | ||
| Строка 47: | Строка 44: | ||
*Если передан пустой массив, файлы будут откреплены от контакта и удалены, если нигде более не используются. | *Если передан пустой массив, файлы будут откреплены от контакта и удалены, если нигде более не используются. | ||
*Если поле files передано не будет, файлы обновляться не будут. | *Если поле files передано не будет, файлы обновляться не будут. | ||
=== Проект === | === Проект === | ||
| Строка 63: | Строка 59: | ||
*Если передан пустой массив, файлы будут откреплены от проекта и удалены, если нигде более не используются. | *Если передан пустой массив, файлы будут откреплены от проекта и удалены, если нигде более не используются. | ||
*Если поле files передано не будет, файлы обновляться не будут. | *Если поле files передано не будет, файлы обновляться не будут. | ||
== Получить список файлов == | == Получить список файлов == | ||
| Строка 85: | Строка 80: | ||
У метода есть параметры pageSize и offset, для постраничной навигации по списку: | У метода есть параметры pageSize и offset, для постраничной навигации по списку: | ||
https://p.pfx.so/pf/oa/EmFu1e.png | https://p.pfx.so/pf/oa/EmFu1e.png | ||
== Перейти == | == Перейти == | ||
*[[REST API]] | *[[REST API]] | ||
*[[API ПланФикса]] | *[[API ПланФикса]] | ||
Версия от 08:16, 10 ноября 2025
REST API ПланФикса поддерживает работу с файлами.
Прикрепить и обновить
Через API можно прикреплять или обновлять ранее загруженные файлы в:
Задача
- Файлы крепятся или обновляются только в описании задачи.
- Прикрепить файлы к описанию во время создания задачи:
- Обновить файлы в описании задачи:
Важно:
- Файлы заменяются теми, что переданы в параметре files.
- Если передан пустой массив, файлы будут откреплены от задачи и удалены, если нигде более не используются.
- Если поле files передано не будет, файлы обновляться не будут.
Контакт
- Файлы крепятся или обновляются только в описании контакта.
- Прикрепить файлы к описанию во время создания контакта:
- Обновить файлы в описании контакта:
Важно:
- Файлы заменяются теми, что переданы в параметре files.
- Если передан пустой массив, файлы будут откреплены от контакта и удалены, если нигде более не используются.
- Если поле files передано не будет, файлы обновляться не будут.
Проект
- Файлы крепятся или обновляются только в документах проекта.
- Прикрепить файлы во время создания проекта:
- Обновить файлы в проекте:
Важно:
- Файлы заменяются теми, что переданы в параметре files.
- Если передан пустой массив, файлы будут откреплены от проекта и удалены, если нигде более не используются.
- Если поле files передано не будет, файлы обновляться не будут.
Получить список файлов
Через API можно получить список файлов из:
Задачи
У метода есть параметр onlyFromDescription, который позволяет получать файлы только из описания задачи:
Контакта
У метода есть параметр onlyFromDescription, который позволяет получать файлы только из описания контакта:
Проекта
У метода есть параметры pageSize и offset, для постраничной навигации по списку:
