REST API: Работа с файлами: различия между версиями
Материал из Planfix
Artem (обсуждение | вклад) Нет описания правки |
Artem (обсуждение | вклад) Нет описания правки |
||
Строка 6: | Строка 6: | ||
}} | }} | ||
[[REST API]] ПланФикса поддерживает работу с файлами. | [[REST API]] ПланФикса поддерживает работу с файлами. | ||
*[[#Прикрепить и обновить |Прикрепить и обновить]] | |||
*[[#Получить список файлов |Получить список файлов]] | |||
== Прикрепить и обновить == | == Прикрепить и обновить == |
Версия от 10:01, 22 июня 2023
REST API ПланФикса поддерживает работу с файлами.
Прикрепить и обновить
Через API можно прикреплять или обновлять ранее загруженные файлы в:
Задача
- Файлы крепятся или обновляются только в описании задачи.
- Прикрепить файлы к описанию во время создания задачи:
- Обновить файлы в описании задачи:
Важно:
- Файлы заменяются теми, что переданы в параметре files.
- Если передан пустой массив, файлы будут откреплены от задачи и удалены, если нигде более не используются.
- Если поле files передано не будет, файлы обновляться не будут.
Контакт
- Файлы крепятся или обновляются только в описании контакта.
- Прикрепить файлы к описанию во время создания контакта:
- Обновить файлы в описании контакта:
Важно:
- Файлы заменяются теми, что переданы в параметре files.
- Если передан пустой массив, файлы будут откреплены от контакта и удалены, если нигде более не используются.
- Если поле files передано не будет, файлы обновляться не будут.
Проект
- Файлы крепятся или обновляются только в документах проекта.
- Прикрепить файлы во время создания проекта:
- Обновить файлы в проекте:
Важно:
- Файлы заменяются теми, что переданы в параметре files.
- Если передан пустой массив, файлы будут откреплены от проекта и удалены, если нигде более не используются.
- Если поле files передано не будет, файлы обновляться не будут.
Получить список файлов
Через API можно получить список файлов из: Задачи Контакта Проекта
Задачи
У метода есть параметр onlyFromDescription, который позволяет получать файлы только из описания задачи:
Контакта
У метода есть параметр onlyFromDescription, который позволяет получать файлы только из описания контакта:
Проекта
У метода есть параметры pageSize и offset, для постраничной навигации по списку: