ПланФикс API task.getList — различия между версиями
Материал из ПланФикс
SliZzzZ (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
(не показано 13 промежуточных версий 3 участников) | |||
Строка 1: | Строка 1: | ||
+ | {{#seo: | ||
+ | |title=ПланФикс API task.getList | ||
+ | |titlemode=append | ||
+ | |keywords=планфикс, задачи, апи, api | ||
+ | |description=получение списка задач | ||
+ | }} | ||
+ | |||
Функция получения списка задач. В зависимости от значений параметров, можно получить список задач упорядоченных по разным признакам. Формат запроса: | Функция получения списка задач. В зависимости от значений параметров, можно получить список задач упорядоченных по разным признакам. Формат запроса: | ||
<source lang="xml"> | <source lang="xml"> | ||
Строка 11: | Строка 18: | ||
<project> | <project> | ||
<id></id> | <id></id> | ||
+ | <withSubprojects></withSubprojects> | ||
</project> | </project> | ||
+ | <parent> | ||
+ | <id></id> | ||
+ | </parent> | ||
<sort></sort> | <sort></sort> | ||
<status></status> | <status></status> | ||
Строка 17: | Строка 28: | ||
<pageSize></pageSize> | <pageSize></pageSize> | ||
<filter></filter> | <filter></filter> | ||
+ | <filters> | ||
+ | <filter> | ||
+ | <type></type> | ||
+ | <operator></operator> | ||
+ | <value></value> | ||
+ | <field></field> | ||
+ | ... | ||
+ | </filter> | ||
+ | ... | ||
+ | </filters> | ||
<signature></signature> | <signature></signature> | ||
</request> | </request> | ||
Строка 27: | Строка 48: | ||
|user.id ||int || идентификатор пользователя|| | |user.id ||int || идентификатор пользователя|| | ||
|- | |- | ||
− | |target ||enum ||входящие, исходящие или | + | |target ||enum / int ||входящие, исходящие, все или заданный фильтр задач || допустимые значения смотри ниже |
|- | |- | ||
|project || || фильтр по проекту || необязательный параметр | |project || || фильтр по проекту || необязательный параметр | ||
|- | |- | ||
|project.id || int||идентификатор проекта || | |project.id || int||идентификатор проекта || | ||
+ | |- | ||
+ | |project.withSubprojects || bool - 0/1 ||включая задачи подпроектов||необязательный, значение по-умолчанию - 0 | ||
+ | |- | ||
+ | |parent || || надзадача || необязательный параметр, если задан выбор идёт из подзадач указанной задачи (из всего дерева вниз) | ||
+ | |- | ||
+ | |parent.id || int||идентификатор надзадачи|| | ||
|- | |- | ||
|sort ||enum ||тип сортировка || список допустимых значений смотри в разделе [[ПланФикс API:Типы сортировок задач|типы сортировок задач]] | |sort ||enum ||тип сортировка || список допустимых значений смотри в разделе [[ПланФикс API:Типы сортировок задач|типы сортировок задач]] | ||
Строка 37: | Строка 64: | ||
|status ||enum || статус||перечень допустимых значений смотри в разделе [[ПланФикс API:Статусы задач|статусы задач]] | |status ||enum || статус||перечень допустимых значений смотри в разделе [[ПланФикс API:Статусы задач|статусы задач]] | ||
|- | |- | ||
− | |pageCurrent ||int || текущая страница || 0 - используется для получения количества | + | |pageCurrent ||int || текущая страница || 0 - используется для получения количества задач |
|- | |- | ||
− | |pageSize ||int || размер возвращаемого списка || 0 - используется значение по умолчанию | + | |pageSize ||int || размер возвращаемого списка (максимум 100) || 0 - используется значение по умолчанию |
|- | |- | ||
|filter || set|| дополнительный фильтр, допустимые значения смотри ниже || | |filter || set|| дополнительный фильтр, допустимые значения смотри ниже || | ||
+ | |- | ||
+ | |filters || || дополнительные сложные фильтры || перечень и формат допустимых значений смотри в разделе [[ПланФикс API:Фильтры задач|фильтры задач]] | ||
|- | |- | ||
|} | |} | ||
Строка 48: | Строка 77: | ||
!Значение !! Описание !! Примечание | !Значение !! Описание !! Примечание | ||
|- | |- | ||
− | |all || все|| | + | |all || все|| значение по умолчанию |
|- | |- | ||
− | |in || входящие|| | + | |in || входящие|| |
|- | |- | ||
|out || исходящие|| | |out || исходящие|| | ||
+ | |- | ||
+ | |template|| шаблоны|| | ||
+ | |- | ||
+ | |periodic|| шаблоны повторяющихся задач|| | ||
+ | |- | ||
+ | |идентификатор фильтра задач || доступные фильтры задач можно получить функцией [[ПланФикс API task.getFilterList|task.getFilterList]]|| | ||
|- | |- | ||
|} | |} | ||
Строка 94: | Строка 129: | ||
|'''tasks''' totalCount ||int || количество задач удовлетворяющих условиям запроса || | |'''tasks''' totalCount ||int || количество задач удовлетворяющих условиям запроса || | ||
|- | |- | ||
− | |task || || задача | + | |task || || задача, описание данного параметра смотрите в секции [[ПланФикс API task.get|ответ на получении карточки задачи]] , с тем отличием, что функция task.getList не возвращает аудиторов и участников задачи || |
|- | |- | ||
|} | |} | ||
Строка 111: | Строка 146: | ||
== Перейти == | == Перейти == | ||
*[[ПланФикс API:Задачи]] | *[[ПланФикс API:Задачи]] | ||
+ | *[[Коды ошибок]] | ||
*[[Список функций]] | *[[Список функций]] |
Текущая версия на 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>