ПланФикс API task.getList — различия между версиями

Текущая версия на 08:03, 15 августа 2019

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="task.getList">
  <account></account>
  <sid></sid>
  <user>
    <id></id>
  </user>
  <target></target>
  <project>
    <id></id>
    <withSubprojects></withSubprojects>
  </project>
  <parent>
    <id></id>
  </parent>
  <sort></sort>
  <status></status>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <filter></filter>
  <filters>
    <filter>
      <type></type>
      <operator></operator>
      <value></value>
      <field></field>
      ...
    </filter>
    ...
  </filters>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
user		если указан этот параметр, то результатом будет список задач для указанного пользователя	допустим только для пользователей с правами администратора
user.id	int	идентификатор пользователя
target	enum / int	входящие, исходящие, все или заданный фильтр задач	допустимые значения смотри ниже
project		фильтр по проекту	необязательный параметр
project.id	int	идентификатор проекта
project.withSubprojects	bool - 0/1	включая задачи подпроектов	необязательный, значение по-умолчанию - 0
parent		надзадача	необязательный параметр, если задан выбор идёт из подзадач указанной задачи (из всего дерева вниз)
parent.id	int	идентификатор надзадачи
sort	enum	тип сортировка	список допустимых значений смотри в разделе типы сортировок задач
status	enum	статус	перечень допустимых значений смотри в разделе статусы задач
pageCurrent	int	текущая страница	0 - используется для получения количества задач
pageSize	int	размер возвращаемого списка (максимум 100)	0 - используется значение по умолчанию
filter	set	дополнительный фильтр, допустимые значения смотри ниже
filters		дополнительные сложные фильтры	перечень и формат допустимых значений смотри в разделе фильтры задач

Допустимые значения параметра target

Значение	Описание	Примечание
all	все	значение по умолчанию
in	входящие
out	исходящие
template	шаблоны
periodic	шаблоны повторяющихся задач
идентификатор фильтра задач	доступные фильтры задач можно получить функцией task.getFilterList

Допустимые значения для параметра filter

Значение	Описание	Примечание
ACTIVE	активные задачи
OVERDUE	просроченные задачи
MY	мои задачи

Значение параметра может представлять комбинацию допустимых значений, например:

  <filter>ACTIVE MY</filter>

Результатом выполнения запроса будет список активных моих задач.

В случае удачного выполнения функции будет получен ответ следующего вида:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <tasks count="count" totalCount="totalCount">
    <task>
      <id></id>
      <!-- ... -->
    </task>
    <!-- ... -->
  </tasks>
</response>

Название	Тип	Значение
tasks		корневой элемент, содержит список задач
tasks count	int	количество задач возвращенных в результате выполнения функции
tasks totalCount	int	количество задач удовлетворяющих условиям запроса
task		задача, описание данного параметра смотрите в секции ответ на получении карточки задачи , с тем отличием, что функция task.getList не возвращает аудиторов и участников задачи

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

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

Перейти

@@ Строка 77: / Строка 77: @@
 !Значение !! Описание !! Примечание
 |-
-|all || все||
+|all || все|| значение по умолчанию
 |-
-|in || входящие|| значение по умолчанию
+|in || входящие||
 |-
 |out || исходящие||