REST API: Работа с файлами
REST API Planfix поддерживает работу с файлами:
Прикрепление и обновление
С помощью API можно прикреплять и обновлять ранее загруженные файлы:
Задача
- Файлы можно прикреплять и обновлять только в описании задачи.
- Прикрепляйте файлы к описанию при создании задачи:
- Обновляйте файлы в описании задачи:
Важно:
- Файлы заменяются файлами, переданными в параметре files.
- Если передано пустое поле, файлы открепляются от задачи и удаляются, если не используются в других местах.
- Если поле files не передано, файлы не обновляются.
Контакт
- Файлы можно прикреплять и обновлять только в описании контакта.
- Прикрепляйте файлы к описанию при создании контакта:
- Обновляйте файлы в описании контакта:
Важно:
- Файлы заменяются файлами, переданными в параметре files.
- Если передано пустое поле, файлы открепляются от контакта и удаляются, если не используются в других местах.
- Если поле files не передано, файлы не обновляются.
Проект
- Файлы можно прикреплять и обновлять только в документах проекта.
- Прикрепляйте файлы при создании проекта:
- Обновляйте файлы в проекте:
Важно:
- Файлы заменяются файлами, переданными в параметре files.
- Если передано пустое поле, файлы удаляются из проекта и удаляются, если не используются в других местах.
- Если поле files не передано, файлы не обновляются.
Справочник
Добавление файла в запись справочника в Planfix состоит из двух шагов:
1. Загрузите файл с помощью одного из следующих методов REST API:
- /file/ — загрузка файла с локального устройства.
- /file/from-url/ — загрузка файла по URL.
В качестве значения параметра targetType укажите directory.
В ответе вы получите ID загруженного файла.
2. Создайте запись справочника и добавьте файл в поле «files».
Или обновите существующую запись справочника:
Важно:
- При обновлении записи файлы заменяются файлами, переданными в параметре value.
Получение списка файлов
Список файлов можно получить через API для следующих объектов:
Задача
Метод поддерживает параметр onlyFromDescription, который позволяет получить только файлы из описания задачи:
Контакт
Метод поддерживает параметр onlyFromDescription, который позволяет получить только файлы из описания контакта:
Проект
Метод поддерживает параметры pageSize и offset для постраничного просмотра списка:
