task.item.list
Scope: task Права на выполнение: для всех
Описание
Внимание! Метод устарел и не поддерживается. Рекомендуется использовать методы tasks.task.*.
Возвращает массив задач, каждая из которых содержит массив полей (аналогичен массиву, возвращаемому task.item.getdata).
Параметры
| Параметр | Описание |
|---|---|
| ORDER | Массив для сортировки результата. Массив вида {"поле_сортировки": 'направление сортировки' [, ...]}.
Поле для сортировки может принимать значения:
|
| FILTER | Массив вида {"фильтруемое_поле": "значение фильтра" [, ...]}. Фильтруемое поле может принимать значения:
"значения фильтра" - одиночное значение или массив. Необязательный. По умолчанию записи не фильтруются. Внимание! Для метода task.item.list обязательно нужно указывать сортировку для фильтрации. Фильтрация без сортировки возвращает все задачи.
|
| PARAMS | Массив для опций вызова. Элементом является массив NAV_PARAMS вида {"опция вызова": 'значение' [, ...]}, хранящий следующие опции:
|
| SELECT | Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение "*", то будут возвращены все доступные поля. Значение по умолчанию - пустой массив array() - означает, что будут возвращены все поля основной таблицы запроса. |
Внимание! Соблюдение порядка следования параметров в запросе обязательно. При его нарушении запрос будет выполнен с ошибками.
Однако, если какие-то параметры нужно пропустить, то их все равно нужно передать, но в виде пустых массивов: ORDER[]=&FILTER[]=&PARAMS[]=&SELECT[]=.
Однако, если какие-то параметры нужно пропустить, то их все равно нужно передать, но в виде пустых массивов: 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
G
| ||
| ||
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.