Получить список пунктов чек-листа task.checklistitem.getlist
Scope:
taskКто может выполнять метод: любой пользователь с правом доступа на чтение задачи или выше
Метод task.checklistitem.getlist получает список пунктов чек-листов в задаче.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
TASKID* |
Идентификатор задачи. Идентификатор можно получить при создании задачи или методом получения списка задач |
|
ORDER |
Объект для сортировки результата вида Сортировать можно по полям:
Направление сортировки может принимать значения:
По умолчанию результат сортируется по |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID":8017,"ORDER":{"IS_COMPLETE":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.checklistitem.getlist
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"TASKID":8017,"ORDER":{"IS_COMPLETE":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/task.checklistitem.getlist
// callListMethod: Получает все данные сразу.
// Используйте только для небольших выборок (< 1000 элементов) из-за высокой
// нагрузки на память.
try {
const response = await $b24.callListMethod(
'task.checklistitem.getlist',
{
TASKID: 8017,
ORDER: {
IS_COMPLETE: 'ASC'
}
},
(progress: number) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity) }
} catch (error: any) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора.
// Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('task.checklistitem.getlist', {
TASKID: 8017,
ORDER: {
IS_COMPLETE: 'ASC'
}
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error: any) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start.
// Используйте для точного контроля над пакетами запросов.
// Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('task.checklistitem.getlist', {
TASKID: 8017,
ORDER: {
IS_COMPLETE: 'ASC'
}
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity) }
} catch (error: any) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'task.checklistitem.getlist',
[
'TASKID' => 8017,
'ORDER' => [
'IS_COMPLETE' => 'ASC'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching checklist items: ' . $e->getMessage();
}
BX24.callMethod(
'task.checklistitem.getlist',
{
'TASKID': 8017,
'ORDER': {
'IS_COMPLETE': 'ASC'
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'task.checklistitem.getlist',
[
'TASKID' => 8017,
'ORDER' => [
'IS_COMPLETE' => 'ASC'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "477",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Подготовить договор Светлана Иванова",
"SORT_INDEX": "2",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": "503",
"TOGGLED_DATE": "2025-11-10T15:02:30+03:00",
"MEMBERS": [
{
"ID": "103",
"TYPE": "A",
"NAME": "Светлана Иванова",
"PERSONAL_PHOTO": "8644",
"PERSONAL_GENDER": "F",
"IMAGE": "https://mysite.ru/b17053/resize_cache/8644/c0120a8d7c10d63c83e32398d1ec4d9e/main/45f/45fff10d17d398a5583184c8350cd197/buh.jpg",
"IS_COLLABER": false
}
],
"ATTACHMENTS": {
"1113": {
"ATTACHMENT_ID": 1113,
"NAME": "Инструкция.docx",
"SIZE": "115161",
"FILE_ID": "5065",
"DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=1113&action=download&ncc=1",
"VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=1113&action=show&ncc=1"
},
"1115": {
"ATTACHMENT_ID": 1115,
"NAME": "Список документов.xlsx",
"SIZE": "14675",
"FILE_ID": "5067",
"DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=1115&action=download&ncc=1",
"VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=1115&action=show&ncc=1"
}
}
},
{
"ID": "431",
"TASK_ID": "8017",
"PARENT_ID": 0,
"CREATED_BY": "503",
"TITLE": "Чек-лист 1",
"SORT_INDEX": "0",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "447",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Согласовать с клиентом детали",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "469",
"TASK_ID": "8017",
"PARENT_ID": "447",
"CREATED_BY": "503",
"TITLE": "Согласовать с руководителем Андрей Карпов Андрей Сергеев",
"SORT_INDEX": "2",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [
{
"ID": "3",
"TYPE": "A",
"NAME": "Андрей Карпов",
"PERSONAL_PHOTO": "249",
"PERSONAL_GENDER": "M",
"IMAGE": "https://mysite.ru/b17053/resize_cache/249/c0120a8d7c10d63c83e32398d1ec4d9e/main/cd526b0644e7ff4d794ea41cb36bc423/odmin.png",
"IS_COLLABER": false
},
{
"ID": "11",
"TYPE": "U",
"NAME": "Андрей Сергеев",
"PERSONAL_PHOTO": "231",
"PERSONAL_GENDER": "",
"IMAGE": "https://mysite.ru/b17053/resize_cache/231/c0120a8d7c10d63c83e32398d1ec4d9e/main/026bf59e161a0bd50f401d3796800651/66b.jpg",
"IS_COLLABER": false
}
],
"ATTACHMENTS": []
},
{
"ID": "471",
"TASK_ID": "8017",
"PARENT_ID": "447",
"CREATED_BY": "503",
"TITLE": "Подготовить решение",
"SORT_INDEX": "1",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "491",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Подписать договор",
"SORT_INDEX": "3",
"IS_COMPLETE": "N",
"IS_IMPORTANT": "N",
"TOGGLED_BY": null,
"TOGGLED_DATE": "",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "433",
"TASK_ID": "8017",
"PARENT_ID": "431",
"CREATED_BY": "503",
"TITLE": "Найти все документы по клиенту",
"SORT_INDEX": "0",
"IS_COMPLETE": "Y",
"IS_IMPORTANT": "N",
"TOGGLED_BY": "503",
"TOGGLED_DATE": "2025-11-10T15:02:30+03:00",
"MEMBERS": [],
"ATTACHMENTS": []
},
{
"ID": "485",
"TASK_ID": "8017",
"PARENT_ID": "447",
"CREATED_BY": "503",
"TITLE": "Договориться о встрече Андрей Сергеев",
"SORT_INDEX": "0",
"IS_COMPLETE": "Y",
"IS_IMPORTANT": "N",
"TOGGLED_BY": "503",
"TOGGLED_DATE": "2025-11-10T15:02:33+03:00",
"MEMBERS": [
{
"ID": "11",
"TYPE": "U",
"NAME": "Андрей Сергеев",
"PERSONAL_PHOTO": "231",
"PERSONAL_GENDER": "",
"IMAGE": "https://mysite.ru/b17053/resize_cache/231/c0120a8d7c10d63c83e32398d1ec4d9e/main/026bf59e161a0bd50f401d3796800651/66b.jpg",
"IS_COLLABER": false
}
],
"ATTACHMENTS": []
}
],
"time": {
"start": 1762780903,
"finish": 1762780903.978847,
"duration": 0.9788470268249512,
"processing": 0,
"date_start": "2025-11-10T16:21:43+03:00",
"date_finish": "2025-11-10T16:21:43+03:00",
"operating_reset_at": 1762781503,
"operating": 0.3446669578552246
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список объектов с описанием полей пунктов чек-листа |
|
time |
Информация о времени выполнения запроса |
Поля объекта result
|
Название |
Описание |
|
ID |
Идентификатор пункта чек-листа |
|
TASK_ID |
Идентификатор задачи, к которой относится пункт |
|
PARENT_ID |
Идентификатор родительского пункта. Значение |
|
CREATED_BY |
Идентификатор автора пункта |
|
TITLE |
Текст пункта чек-листа. Если |
|
SORT_INDEX |
Индекс сортировки. Чем меньше значение, тем выше пункт в списке или подсписке |
|
IS_COMPLETE |
Статус выполнения пункта. Возможные значения:
|
|
IS_IMPORTANT |
Отметка важности пункта. Возможные значения:
|
|
TOGGLED_BY |
Идентификатор пользователя, который последний раз сменил статус пункта. Может быть |
|
TOGGLED_DATE |
Дата и время изменения статуса пункта в формате |
|
MEMBERS |
Список объектов с описанием участников |
|
ATTACHMENTS |
Объект с описанием прикрепленных файлов. Ключ — идентификатор прикрепления файла |
Объект members
|
Название |
Описание |
|
ID |
Идентификатор пользователя |
|
TYPE |
Роль пользователя в пункте чек-листа. Возможные значения:
|
|
NAME |
Имя пользователя |
|
PERSONAL_PHOTO |
Идентификатор файла с аватаром пользователя на Диске |
|
PERSONAL_GENDER |
Пол пользователя. Возможные значения:
|
|
IMAGE |
Ссылка на аватар пользователя |
|
IS_COLLABER |
Признак, что пользователь является внешним участником |
Объект attachments
|
Название |
Описание |
|
ATTACHMENT_ID |
Идентификатор прикрепления |
|
NAME |
Имя файла |
|
SIZE |
Размер файла в байтах |
|
FILE_ID |
Идентификатор файла на Диске |
|
DOWNLOAD_URL |
Ссылка для скачивания файла |
|
VIEW_URL |
Ссылка для просмотра файла в браузере |
Обработка ошибок
HTTP-статус: 400
{
"error":"ERROR_CORE",
"error_description":"TASKS_ERROR_EXCEPTION_#8; Action failed; 8\/TE\/ACTION_FAILED_TO_BE_PROCESSED\u003Cbr\u003E"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
TASKS_ERROR_EXCEPTION_#8; Action failed; 8/TE/ACTION_FAILED_TO_BE_PROCESSED\u003Cbr\u003E |
У пользователя нет доступа к задаче |
|
|
TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) for method ctaskchecklistitem::getlist() expected to be of type \u0022integer\u0022, but given something else.; 256/TE/WRONG_ARGUMENTS\u003Cbr\u003E |
Не передан обязательный параметр |
|
|
TASKS_ERROR_EXCEPTION_#256; Param #1 (arOrder) for method ctaskchecklistitem::getlist() must not contain key \u0022IS_COMPLETED\u0022.; 256/TE/WRONG_ARGUMENTS\u003Cbr\u003E |
Указано неверное поле в |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Чек-листы: обзор методов
- Добавить пункт чек-листа task.checklistitem.add
- Изменить пункт чек-листа task.checklistitem.update
- Получить пункт чек-листа task.checklistitem.get
- Удалить пункт чек-листа task.checklistitem.delete
- Перенести пункт чек-листа task.checklistitem.moveafteritem
- Пометить пункт чек-листа как выполненный task.checklistitem.complete
- Пометить пункт чек-листа как невыполненный task.checklistitem.renew
- Проверить разрешение действия task.checklistitem.isactionallowed