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

Материал из ПланФикс
Версия от 12:09, 10 декабря 2010; Seva (обсуждение | вклад) (Новая страница: «Функция позволяет прикрепить файл к проекту или задаче. Формат вызова: <source lang="xml"> <?xml version="...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к: навигация, поиск

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

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


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

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

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

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


Перейти