Scope: 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 - оценка;
- XML_ID - внешний код;
- 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);
- SUBORDINATE_TASKS - задачи текущего пользователя и его подчиненных (Y|N);
- OVERDUED - были просрочены (Y|N);
- DEPARTMENT_ID - идентификатор отдела.
Перед названием фильтруемого поля может указать тип фильтрации:
- "!" - не равно
- "<" - меньше
- "<=" - меньше либо равно
- ">" - больше
- ">=" - больше либо равно
"значения фильтра" - одиночное значение или массив.
Необязательный. По умолчанию записи не фильтруются.
|
TASKDATA | Массив возвращаемых полей задачи. |
NAV_PARAMS | Постраничная навигация. Доступны следующие опции:
- iNumPage - номер страницы.
|
Внимание! Соблюдение порядка следования параметров в запросе обязательно. При его нарушении запрос будет выполнен с ошибками.
Примеры
// Получим список всех задач (по умолчанию сработает ограничение — постраничка по 50 элементов)
BX24.callMethod(
'task.items.getlist',
[],
function(result)
{
console.info(result.data());
console.log(result);
}
);
// Получим список задач с идентификаторами 1,2,3,4,5,6. Причем выберем только поля ID и TITLE.
// Режим постранички — по 2 элемента на странице, 2-ая страница.
// Сортировка по ID — по убыванию.
BX24.callMethod(
'task.items.getlist',
[
{ID : 'desc'}, // Сортировка по ID — по убыванию.
{ID: [1,2,3,4,5,6]}, // Фильтр
['ID', 'TITLE'], // Выбираемые поля
{
NAV_PARAMS: { // постраничка
iNumPage : 2 // страница номер 2
}
}
],
function(result)
{
console.info(result.data());
console.log(result);
}
);
Примечание: В целях ограничения нагрузки на постраничную навигацию наложено ограничение в 50 задач.