Документация для разработчиков
Документация для разработчиков Документация по D7 Документация по REST Пользовательская документация
Темная тема

task.item.list

Scope: task Права на выполнение: для всех

Описание

Внимание! Метод устарел и не поддерживается. Рекомендуется использовать методы tasks.task.*.

Возвращает массив задач, каждая из которых содержит массив полей (аналогичен массиву, возвращаемому task.item.getdata).

Параметры

ПараметрОписание
ORDERМассив для сортировки результата. Массив вида {"поле_сортировки": 'направление сортировки' [, ...]}.
Поле для сортировки может принимать значения:
  • TITLE - название задачи;
  • DATE_START - дата старта;
  • DEADLINE - крайний срок;
  • STATUS - статус;
  • PRIORITY - приоритет;
  • MARK - оценка;
  • CREATED_BY - постановщик; 
  • RESPONSIBLE_ID - исполнитель; 
  • GROUP_ID - рабочая группа. 
Направление сортировки может принимать значения:
  • asc - по возрастанию;
  • desc - по убыванию;
 Необязательный. По умолчанию фильтруется по убыванию идентификатора задачи.
FILTERМассив вида {"фильтруемое_поле": "значение фильтра" [, ...]}. Фильтруемое поле может принимать значения:
  • ID - идентификатор задачи;
  • PARENT_ID - идентификатор родительской задачи;
  • GROUP_ID - идентификатор рабочей группы;
  • CREATED_BY - постановщик;
  • STATUS_CHANGED_BY - пользователь, последним изменивший статус задачи;
  • PRIORITY - приоритет;
  • FORUM_TOPIC_ID - идентификатор темы форума;
  • RESPONSIBLE_ID - исполнитель;
  • TITLE - название задачи (можно искать по шаблону [%_]) ;
  • TAG -  тэг;
  • REAL_STATUS - статус задачи. Константы отражающие статусы задач:
    • STATE_NEW = 1;
    • STATE_PENDING = 2;
    • STATE_IN_PROGRESS = 3;
    • STATE_SUPPOSEDLY_COMPLETED = 4;
    • STATE_COMPLETED = 5;
    • STATE_DEFERRED = 6;
    • STATE_DECLINED = 7;
  • STATUS - статус для сортировки. Аналогичен REAL_STATUS, но имеет дополнительно два мета статуса:
    • -2 - не просмотренная задача;
    • -1 - просроченная задача.
  • MARK - оценка;
  • SITE_ID - идентификатор сайта;
  • ADD_IN_REPORT - задача в отчете (Y|N);
  • DATE_START - дата начала выполнения;
  • DEADLINE - крайний срок;
  • CREATED_DATE - дата создания;
  • CLOSED_DATE - дата завершения;
  • CHANGED_DATE - дата последнего изменения;
  • ACCOMPLICE - идентификатор соисполнителя;
  • AUDITOR - идентификатор аудитора;
  • DEPENDS_ON - идентификатор предыдущей задачи; 
  • ONLY_ROOT_TASKS -  только задачи, которые не являются подзадачами (корневые задачи), а также подзадачи родительской задачи, к которой текущий пользователь доступа не имеет (Y|N).
Перед названием фильтруемого поля может указать тип фильтрации:
  • "!" - не равно
  • "<" - меньше
  • "<=" - меньше либо равно
  • ">" - больше
  • ">=" - больше либо равно

"значения фильтра" - одиночное значение или массив.

Необязательный. По умолчанию записи не фильтруются.

Внимание! Для метода task.item.list обязательно нужно указывать сортировку для фильтрации. Фильтрация без сортировки возвращает все задачи.

PARAMSМассив для опций вызова. Элементом является массив NAV_PARAMS вида {"опция вызова": 'значение' [, ...]}, хранящий следующие опции:
  • nPageSize - количество элементов на странице. В целях ограничения нагрузки на постраничную навигацию наложено ограничение в 50 задач.
  • iNumPage - номер страницы при постраничной навигации.
SELECTМассив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение "*", то будут возвращены все доступные поля.

Значение по умолчанию - пустой массив array() - означает, что будут возвращены все поля основной таблицы запроса.

Внимание! Соблюдение порядка следования параметров в запросе обязательно. При его нарушении запрос будет выполнен с ошибками.

Однако, если какие-то параметры нужно пропустить, то их все равно нужно передать, но в виде пустых массивов: ORDER[]=&FILTER[]=&PARAMS[]=&SELECT[]=.

Примеры

// Пример для работы с JavaScript
// Получим список всех задач (по умолчанию сработает ограничение — постраничка по 50 элементов)
BX24.callMethod(
	'task.item.list',
	[],
	function(result)
	{
		console.info(result.data());
		console.log(result);
	}
);

// Пример для работы с JavaScript
// Получим список задач с идентификаторами 1,2,3,4,5,6. Причем выберем только поля ID и TITLE.
// Режим постранички — по 2 элемента на странице, 2-ая страница.
// Сортировка по ID — по убыванию.
BX24.callMethod(
	'task.item.list',
	[
		{ID : 'desc'},		// Сортировка по ID — по убыванию.
		{ID: [1,2,3,4,5,6]},	// Фильтр
		{	
            NAV_PARAMS: { // постраничка
		        nPageSize : 2,	// по 2 элемента на странице.
		        iNumPage  : 2	// страница номер 2        
			}
		}
	],
	function(result)
	{
		console.info(result.data());
		console.log(result);
	}
);

// Пример для работы с php
// Получение GET-запроса на выборку данных.
$appParams = array(
	"auth" => '92006f4ae0c55d400f1e6e09428af64a',
	"ORDER" => array("DEADLINE" => "desc"),
	"FILTER" => array(">ID" => 1),
	"PARAMS" => array('NAV_PARAMS' => array("nPageSize" => 2, 'iNumPage' => 2)),
);

$appRequestUrl = 'http://test-domain.ru/rest/task.item.list.xml?'.http_build_query($appParams);

print(urldecode($appRequestUrl));;

Метод отдаёт теги, если передать ему параметр LOAD_TAGS:

/rest/task.item.list.xml?auth=31r0ckfy3r2u96yttz4k70g5kv2w534h&O[]=&F[]=&P[LOAD_TAGS]=Y


© «Битрикс», 2001-2024, «1С-Битрикс», 2024