Получить пункт чек-листа task.checklistitem.get

Scope: task

Кто может выполнять метод: любой пользователь с правом доступа на чтение задачи или выше

Метод task.checklistitem.get получает описание пункта чек-листа по идентификатору.

Параметры метода

Передавайте параметры в запросе в соответствии с порядком в таблице. Если нарушить порядок, запрос вернет ошибку.

Обязательные параметры отмечены *

Название
тип

Описание

TASKID*
integer

Идентификатор задачи.

Идентификатор можно получить при создании задачи или методом получения списка задач

ITEMID*
integer

Идентификатор пункта чек-листа.

Идентификатор пункта можно получить при добавлении нового пункта или методом получения списка пунктов чек-листа

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":8017,"ITEMID":479}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.checklistitem.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"TASKID":8017,"ITEMID":479,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/task.checklistitem.get
        
try
        {
            const response = await $b24.callMethod(
                'task.checklistitem.get',
                {
                    TASKID: 8017,
                    ITEMID: 479
                }
            );
            
            const result = response.getData().result;
            console.log('Retrieved checklist item:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'task.checklistitem.get',
                    [
                        'TASKID' => 8017,
                        'ITEMID' => 479
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving checklist item: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'task.checklistitem.get',
            {
                TASKID: 8017,
                ITEMID: 479
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'task.checklistitem.get',
            [
                'TASKID' => 8017,
                'ITEMID' => 479
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "ID": "495",
                "TASK_ID": "8017",
                "PARENT_ID": "457",
                "CREATED_BY": "503",
                "TITLE": "Подготовить отчет Андрей Сергеев Светлана Иванова Андрей Карпов",
                "SORT_INDEX": "4",
                "IS_COMPLETE": "N",
                "IS_IMPORTANT": "Y",
                "TOGGLED_BY": null,
                "TOGGLED_DATE": "",
                "MEMBERS": [
                    {
                        "ID": "3",
                        "TYPE": "U",
                        "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": "M",
                        "IMAGE": "https://mysite.ru/b17053/resize_cache/231/c0120a8d7c10d63c83e32398d1ec4d9e/main/026bf59e161a0bd50f401d3796800651/66b.jpg",
                        "IS_COLLABER": false
                    },
                    {
                        "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": {
                    "1111": {
                        "ATTACHMENT_ID": 1111,
                        "NAME": "Счет для клиента.pdf",
                        "SIZE": "148238",
                        "FILE_ID": "989",
                        "DOWNLOAD_URL": "/bitrix/tools/disk/uf.php?attachedId=1111&action=download&ncc=1",
                        "VIEW_URL": "/bitrix/tools/disk/uf.php?attachedId=1111&action=show&ncc=1"
                    }
                }
            },
            "time": {
                "start": 1762755387,
                "finish": 1762755387.104804,
                "duration": 0.10480403900146484,
                "processing": 0,
                "date_start": "2025-11-10T09:16:27+03:00",
                "date_finish": "2025-11-10T09:16:27+03:00",
                "operating_reset_at": 1762755987,
                "operating": 0
            }
        }
        

Возвращаемые данные

Название
тип

Описание

result
object

Объект с описанием полей пункта чек-листа

time
time

Информация о времени выполнения запроса

Поля объекта result

Название
тип

Описание

ID
string

Идентификатор пункта чек-листа

TASK_ID
string

Идентификатор задачи, к которой относится пункт

PARENT_ID
string

Идентификатор родительского пункта.

Значение 0 означает корневой пункт

CREATED_BY
string

Идентификатор автора пункта

TITLE
string

Текст пункта чек-листа.

Если PARENT_ID = 0, поле содержит название чек-листа

SORT_INDEX
string

Индекс сортировки.

Чем меньше значение, тем выше пункт в списке или подсписке

IS_COMPLETE
boolean

Статус выполнения пункта. Возможные значения:

  • Y — выполнен,
  • N — не выполнен

IS_IMPORTANT
boolean

Отметка важности пункта. Возможные значения:

  • Y — важный,
  • N — обычный

TOGGLED_BY
string

Идентификатор пользователя, который последний раз сменил статус пункта.

Может быть null, если статус не меняли

TOGGLED_DATE
string

Дата и время изменения статуса пункта в формате ISO 8601

MEMBERS
array

Список объектов с описанием участников

ATTACHMENTS
object

Объект с описанием прикрепленных файлов.

Ключ — идентификатор прикрепления файла ATTACHMENT_ID

Объект members

Название
тип

Описание

ID
string

Идентификатор пользователя

TYPE
string

Роль пользователя в пункте чек-листа. Возможные значения:

  • A — соисполнитель,
  • U — наблюдатель

NAME
string

Имя пользователя

PERSONAL_PHOTO
string

Идентификатор файла с аватаром пользователя на Диске

PERSONAL_GENDER
string

Пол пользователя. Возможные значения:

  • M — мужчина,
  • F — женщина

IMAGE
string

Ссылка на аватар пользователя

IS_COLLABER
boolean

Признак, что пользователь является внешним участником

Объект attachments

Название
тип

Описание

ATTACHMENT_ID
integer

Идентификатор прикрепления

NAME
string

Имя файла

SIZE
string

Размер файла в байтах

FILE_ID
string

Идентификатор файла на Диске

DOWNLOAD_URL
string

Ссылка для скачивания файла

VIEW_URL
string

Ссылка для просмотра файла в браузере

Обработка ошибок

HTTP-статус: 400

{
            "error":"ERROR_CORE",
            "error_description":"TASKS_ERROR_EXCEPTION_#256; Param #1 (itemId) expected by method ctaskchecklistitem::get(), but not given.; 256\/TE\/WRONG_ARGUMENTS\u003Cbr\u003E"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

ERROR_CORE

TASKS_ERROR_EXCEPTION_#256; Param #1 (itemId) expected by method ctaskchecklistitem::get(), but not given.; 256/TE/WRONG_ARGUMENTS\u003Cbr\u003E

Не переданы обязательные параметры TASKID и ITEMID

ERROR_CORE

error_description":"TASKS_ERROR_EXCEPTION_#256; Param #0 (taskId) for method ctaskchecklistitem::get() expected to be of type \u0022integer\u0022, but given something else.; 256/TE/WRONG_ARGUMENTS\u003Cbr\u003E

Указан неверный тип значения для TASKID или ITEMID

ERROR_CORE

TASKS_ERROR_EXCEPTION_#512; Check listitem not found or not accessible; 512/TE/ITEM_NOT_FOUND_OR_NOT_ACCESSIBLE\u003Cbr\u003E

Возможные причины:

  • нарушен порядок параметров в методе
  • указанный TASKID или ITEMID не существует
  • у пользователя нет прав доступа к задаче

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение