REST API: Работа с файлами

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, для постраничной навигации по списку:

Перейти

• REST API
• API ПланФикса