ПланФикс API file.upload

Материал из ПланФикс
Перейти к: навигация, поиск

Функция позволяет прикрепить файл к проекту или задаче. Формат вызова:

<?xml version="1.0" encoding="UTF-8"?>
<request method="file.upload">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
  </task>
  <project>
    <id></id>
  </project>
  <files>
    <file>
      <name></name>
      <owner>
        <id></id>
      </owner>
      <sourceType></sourceType>
      <otherFile>
        <id></id>
        <url></url>
      </otherFile>
      <body></body>
      <description></description>
    </file>
  </files>
  <notifiedList>
    <users>
      <id></id>
      <id></id>
      <!-- ... -->
    </users>
  </notifiedList>
  <signature></signature>
</request>
Название Тип Значение Примечание
task в рамках какой задачи сохраняется исключает наличие project
task.id int идентификатор задачи
project в рамках какого проекта сохраняется используется, если не задан task
project.id int идентификатор проекта
files корневой элемент содержащий список сохраняемых файлов
file сохраняемый файл
file.name string имя сохраняемого файла игнорируется, если sourceType=PROJECT
file.owner автор файла необязательное поле. Если не указано - берется пользователь от имени которого выполняется функция
file.owner.id int идентификатор автора файла
file.sourceType enum тип источника список допустимых значений смотри в типы источников файла
file.otherFile Использовать уже существующий файл используется при sourceType: INTERNET, PROJECT
file.otherFile.id int идентификатор файла, используется при ссылке на файл из проекта sourceType=PROJECT
file.otherFile.url string URL фала в Интернет используется только при sourceType=INTERNET
file.body string тело файла закодированное base64 используется при sourceType=FILESYSTEM
file.description string краткое описание содержимого файла не обязательный параметр, игнорируется, если sourceType=PROJECT
notifiedList список пользователей которых должны уведомить
notifiedList.users корневой элемент списка пользователей
notifiedList.users.id int идентификатор пользователя


Результат удачного выполнения запроса:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <files>
    <file>
      <uniqueId></uniqueId>
      <name></name>
    </file>
    <file>
      <uniqueId></uniqueId>
      <name></name>
    </file>
    <!-- ... -->
  </files>
</response>
Название Тип Значение Примечание
action.id int идентификатор добавленного действия

Ответ является списком файлов из имён файлов и присвоенных им идентификаторов.

В противном случае будет возвращен ответ с ошибкой:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>


Перейти