ПланФикс API: Работа с файлами: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
 
(не показано 14 промежуточных версий 4 участников)
Строка 1: Строка 1:
{{#seo:
|title=ПланФикс API: Работа с файлами
|titlemode=append
|keywords=планфикс, файлы, документы, апи, api
|description=файлы api
}}


== file.download / скачать файл ==
Функции для работы с файлами:
(!Под вопросом). Позволяет скачать файл.
#[[ПланФикс API file.upload|file.upload / Добавить файл]]
<source lang="xml">
<!-- #[[ПланФикс API file.uploadNewVersion|file.uploadNewVersion / Загрузить новую версию файла]] -->
<?xml version="1.0" encoding="UTF-8"?>
#[[ПланФикс API file.download|file.download / Скачать файл]]
<request method="file.download">
#[[ПланФикс API file.get|file.get / Получение информации о файле]]
  <account><!-- имя аккаунта --></account>
#[[ПланФикс API file.getListForProject|file.getListForProject / Список файлов в проекте]]
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
#[[ПланФикс API file.getListForTask|file.getListForTask / Список файлов в задаче]]
  <file>
#[[ПланФикс API file.getListForUser|file.getListForUser / Список файлов загруженных пользователем]]
  <id></id>
#[[ПланФикс API file.getListForClient|file.getListForClient /Список файлов контрагента]]
  </file>
#[[ПланФикс API file.getHistory|file.getHistory / Получение истории по файлу]]
  <signature></signature>
#[[ПланФикс API file.delete|file.delete / Удаление файлов]]
</request>
</source>
 
Ответом будет не стандартный пакет в формате XML а прямой файл. Поэтому надо будет парсить HTTP-ответ. Типа 200 - все ок, 403 - доступ к файлу жапрещен, 404 - фалй не найден.
 
 
== file.getListForProject / список файлов ==
Получение списка файлов для проекта.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="file.getListForProject">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <project>
  <id></id>
  </project>
  <fileGroup></fileGroup>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <signature></signature>
</request>
</source>
Параметр '''fileGroup''' - не обязательный.  
 
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <files count="x" totalCount="x">
    <file>
      <id></id>
      <name>имя файла</name>
      <version>версия</version>
      <description>описание</description>
      <date>дата загрузки файла</date>
      <sourceType>смотри раздел Константы. Типы файлов.</sourceType>
      <size>размер в байтах</size>
 
      <task>
        <id></id>
        <title></title>
      </task>
 
      <project>
        <id></id>
        <title></title>
      </project>
<!-- пользователь который загрузил данный файл -->
      <user>
        <id></id>
        <name></name>
      </user>
    </file>
    <file>
<!-- ... -->
    </file>
    <!-- ... -->
  </files>
</response>
</source>
Формат такого ответа получают все запросы на список файлов.
 
== Константы ==
=== Типы файлов ===
*'''FILESYSTEM''' - обычный файл
*'''INTERNET''' - внешний файл, хранящийся на внешнем ресурсе.




== Перейти ==
== Перейти ==
[[ПланФикс API]]
[[Список функций]]

Текущая версия от 08:43, 29 ноября 2019

Функции для работы с файлами:

  1. file.upload / Добавить файл
  2. file.download / Скачать файл
  3. file.get / Получение информации о файле
  4. file.getListForProject / Список файлов в проекте
  5. file.getListForTask / Список файлов в задаче
  6. file.getListForUser / Список файлов загруженных пользователем
  7. file.getListForClient /Список файлов контрагента
  8. file.getHistory / Получение истории по файлу
  9. file.delete / Удаление файлов


Перейти

Список функций

Источник — http://planfix.com/ru/help/index.php?title=ПланФикс_API:Работа_с_файлами&oldid=20414