ПланФикс API file.getListForTask: различия между версиями

Текущая версия от 15:02, 25 марта 2024

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="file.getListForTask">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
    <general></general>
  </task>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <returnDownloadLinks></returnDownloadLinks>
  <sort></sort>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
task.id	int	идентификатор задачи
task.general	int	номер задачи
pageCurrent	int	текущая страница	нумерация с 1. 0 - используется для получения количества
pageSize	int	размер запрашиваемой страницы
sort	enum	тип сортировки	список допустимых значений смотри в разделе типы сортировок файлов
returnDownloadLinks	bool	возвращать ли в ответе постоянные ссылки для скачивания файла	значение по-умолчанию 0
signature	string(32)	подпись

Результат выполнения функции:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <files count="count" totalCount="totalCount">
    <file>
    <id></id>
    <uniqueId></uniqueId>
      <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>
      <downloadLink></downloadLink>
    </file>
    <file>
      <!-- ... -->
    </file>
    <!-- ... -->
  </files>
</response>

Название	Тип	Значение	Примечание
files
files count	int	количество возвращенных запросом файлов
files totalCount	int	количество файлов удовлетворяющих запросу
file		узел описывающий файл
id	int	идентификатор файла	общий для всех версий одного файла
uniqueId	int	уникальный идентификатор файла
name	string	имя файла
version	int	версия
description	string	описание
date	DateTime	дата загрузки файла
sourceType	enum	типы файлов	список допустимых значений смотри в типы файлов
size	int	размер в килобайтах
task		в рамках какой задачи был залит
task.id	int	идентификатор задачи
task.title	string	название задачи
project		в рамках какого проекта был загружен файл
project.id	int	идентификатор проекта
project.title	string	название проекта
user		пользователь, который загрузил файл
user.id	int	идентификатор пользователя
user.name	string	имя пользователя
downloadLink	string	ссылка для скачивания файла

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

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

Перейти

@@ Строка 7: / Строка 7: @@
    <task>
      <id></id>
+    <general></general>
    </task>
-  <fileGroup></fileGroup>
    <pageCurrent></pageCurrent>
    <pageSize></pageSize>
+  <returnDownloadLinks></returnDownloadLinks>
    <sort></sort>
    <signature></signature>
@@ Строка 20: / Строка 21: @@
 |task.id ||int ||идентификатор задачи||
 |-
-|fileGroup ||int || фильтр группы ||
+|task.general|| int || номер задачи||
 |-
-|pageCurrent ||int ||текущая страница ||
+|pageCurrent ||int ||текущая страница || нумерация с 1. 0 - используется для получения количества
 |-
 |pageSize ||int ||размер запрашиваемой страницы ||
 |-
 |sort ||enum ||тип сортировки || список допустимых значений смотри в разделе [[ПланФикс API:Типы сортировок файлов|типы сортировок файлов]]
+|-
+|returnDownloadLinks ||bool ||возвращать ли в ответе постоянные ссылки для скачивания файла || значение по-умолчанию 0
 |-
 |signature ||string(32) ||подпись ||
@@ Строка 38: / Строка 41: @@
    <files count="count" totalCount="totalCount">
      <file>
-      <id></id>
+    <id></id>
+    <uniqueId></uniqueId>
        <name></name>
        <version></version>
@@ Строка 57: / Строка 61: @@
          <name></name>
        </user>
+      <downloadLink></downloadLink>
      </file>
      <file>
@@ Строка 76: / Строка 81: @@
 |file || ||узел описывающий файл ||
 |-
-|id || int||идентификатор файла ||
+|id || int||идентификатор файла || общий для всех версий одного файла
+|-
+|uniqueId || int||уникальный идентификатор файла ||
 |-
 |name ||string || имя файла||
@@ Строка 88: / Строка 95: @@
 |sourceType ||enum ||типы файлов ||список допустимых значений смотри в [[ПланФикс API:Типы файлов|типы файлов]]
 |-
-|size ||int ||размер в байтах ||
+|size ||int ||размер в килобайтах ||
 |-
 |task || || в рамках какой задачи был залит ||
@@ Строка 107: / Строка 114: @@
 |-
 |user.name || string||имя пользователя ||
+|-
+|downloadLink || string||ссылка для скачивания файла ||
 |-
 |}