REST API: Робота з файлами
REST API Planfix підтримує роботу з файлами.
Прикріпити і оновити
Через API можна прикріплювати або оновлювати раніше завантажені файли в:
Завдання
- Файли прикріплюються або оновлюються лише в описі завдання.
- Прикріпити файли до опису під час створення завдання:
- Оновити файли в описі завдання:
Важливо:
- Файли замінюються тими, що передані в параметрі files.
- Якщо переданий порожній масив, файли буде відкріплено від завдання й видалено, якщо вони більше ніде не використовуються.
- Якщо поле files не буде передано, файли оновлюватися не будуть.
Контакт
- Файли прикріплюються або оновлюються лише в описі контакту.
- Прикріпити файли до опису під час створення контакту:
- Оновити файли в описі контакту:
Важливо:
- Файли замінюються тими, що передані в параметрі files.
- Якщо переданий порожній масив, файли буде відкріплено від контакту й видалено, якщо вони більше ніде не використовуються.
- Якщо поле files не буде передано, файли оновлюватися не будуть.
Проєкт
- Файли прикріплюються або оновлюються лише в документах проєкту.
- Прикріпити файли під час створення проєкту:
- Оновити файли в проєкті:
Важливо:
- Файли замінюються тими, що передані в параметрі files.
- Якщо переданий порожній масив, файли буде відкріплено від проєкту й видалено, якщо вони більше ніде не використовуються.
- Якщо поле files не буде передано, файли оновлюватися не будуть.
Довідник
Додавання файлу до запису довідника виконується в два етапи:
1. Завантажте файл у систему, використовуючи один із методів REST API:
- /file/ — завантаження файлу з локального джерела.
- /file/from-url/ — завантаження файлу за посиланням.
Потрібно передати в параметрі targetType значення directory.
У відповіді ви отримаєте ідентифікатор завантаженого файлу.
2. Створюємо новий запис довідника і додаємо файл у поле типу файли
Або оновлюємо існуючий запис довідника
Важливо:
- При оновленні запису файли замінюються тими, що передані в параметрі value.
Отримати список файлів
Через API можна отримати список файлів з:
Завдань
У методу є параметр onlyFromDescription, який дозволяє отримувати файли тільки з опису завдання:
Контакта
У методу є параметр onlyFromDescription, який дозволяє отримувати файли тільки з опису контакту:
Проєкта
У методу є параметри pageSize і offset для посторінкової навігації по списку:
