Получить список методов и их описание task.checklistitem.getmanifest

Scope: task

Кто может выполнять метод: любой пользователь

Метод task.checklistitem.getmanifest получает информацию о методах работы с пунктами чек-листа задач task.checklistitem.*.

Рекомендуем использовать результат только в качестве справочника, так как структуру ответа метода разработчик может изменить в любой момент.

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

Без параметров.

Примеры кода

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

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

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

HTTP-статус: 200

{
            "result": {
                "Manifest version": "2.0",
                "Warning": "don't rely on format of this manifest, it can be changed without any notification",
                "REST: shortname alias to class": "checklistitem",
                "REST: writable checklistitem data fields": [
                    "PARENT_ID",
                    "TITLE",
                    "SORT_INDEX",
                    "IS_COMPLETE",
                    "IS_IMPORTANT",
                    "MEMBERS"
                ],
                "REST: readable checklistitem data fields": [
                    "ID",
                    "TASK_ID",
                    "PARENT_ID",
                    "CREATED_BY",
                    "TITLE",
                    "SORT_INDEX",
                    "IS_COMPLETE",
                    "IS_IMPORTANT",
                    "TOGGLED_BY",
                    "TOGGLED_DATE",
                    "MEMBERS",
                    "ATTACHMENTS"
                ],
                "REST: sortable checklistitem data fields": [
                    "ID",
                    "PARENT_ID",
                    "CREATED_BY",
                    "TITLE",
                    "SORT_INDEX",
                    "IS_COMPLETE",
                    "IS_IMPORTANT",
                    "TOGGLED_BY",
                    "TOGGLED_DATE"
                ],
                "REST: date fields": [
                    "TOGGLED_DATE"
                ],
                "REST: available methods": {
                    "getmanifest": {
                        "staticMethod": true,
                        "params": []
                    },
                    "get": {
                        "mandatoryParamsCount": 2,
                        "params": [
                            {
                                "description": "taskId",
                                "type": "integer"
                            },
                            {
                                "description": "itemId",
                                "type": "integer"
                            }
                        ],
                        "allowedKeysInReturnValue": [
                            "ID",
                            "TASK_ID",
                            "PARENT_ID",
                            "CREATED_BY",
                            "TITLE",
                            "SORT_INDEX",
                            "IS_COMPLETE",
                            "IS_IMPORTANT",
                            "TOGGLED_BY",
                            "TOGGLED_DATE",
                            "MEMBERS",
                            "ATTACHMENTS"
                        ]
                    },
                    "getlist": {
                        "staticMethod": true,
                        "mandatoryParamsCount": 1,
                        "params": [
                            {
                                "description": "taskId",
                                "type": "integer"
                            },
                            {
                                "description": "arOrder",
                                "type": "array",
                                "allowedKeys": [
                                    "ID",
                                    "PARENT_ID",
                                    "CREATED_BY",
                                    "TITLE",
                                    "SORT_INDEX",
                                    "IS_COMPLETE",
                                    "IS_IMPORTANT",
                                    "TOGGLED_BY",
                                    "TOGGLED_DATE"
                                ]
                            }
                        ],
                        "allowedKeysInReturnValue": [
                            "ID",
                            "TASK_ID",
                            "PARENT_ID",
                            "CREATED_BY",
                            "TITLE",
                            "SORT_INDEX",
                            "IS_COMPLETE",
                            "IS_IMPORTANT",
                            "TOGGLED_BY",
                            "TOGGLED_DATE",
                            "MEMBERS",
                            "ATTACHMENTS"
                        ],
                        "collectionInReturnValue": true
                    },
                    "add": {
                        "staticMethod": true,
                        "mandatoryParamsCount": 2,
                        "params": [
                            {
                                "description": "taskId",
                                "type": "integer"
                            },
                            {
                                "description": "arFields",
                                "type": "array",
                                "allowedKeys": [
                                    "PARENT_ID",
                                    "TITLE",
                                    "SORT_INDEX",
                                    "IS_COMPLETE",
                                    "IS_IMPORTANT",
                                    "MEMBERS"
                                ]
                            }
                        ]
                    },
                    "update": {
                        "staticMethod": false,
                        "mandatoryParamsCount": 3,
                        "params": [
                            {
                                "description": "taskId",
                                "type": "integer"
                            },
                            {
                                "description": "itemId",
                                "type": "integer"
                            },
                            {
                                "description": "arFields",
                                "type": "array",
                                "allowedKeys": [
                                    "PARENT_ID",
                                    "TITLE",
                                    "SORT_INDEX",
                                    "IS_COMPLETE",
                                    "IS_IMPORTANT",
                                    "MEMBERS"
                                ]
                            }
                        ]
                    },
                    "delete": {
                        "staticMethod": false,
                        "mandatoryParamsCount": 2,
                        "params": [
                            {
                                "description": "taskId",
                                "type": "integer"
                            },
                            {
                                "description": "itemId",
                                "type": "integer"
                            }
                        ]
                    },
                    "complete": {
                        "staticMethod": false,
                        "mandatoryParamsCount": 2,
                        "params": [
                            {
                                "description": "taskId",
                                "type": "integer"
                            },
                            {
                                "description": "itemId",
                                "type": "integer"
                            }
                        ]
                    },
                    "renew": {
                        "staticMethod": false,
                        "mandatoryParamsCount": 2,
                        "params": [
                            {
                                "description": "taskId",
                                "type": "integer"
                            },
                            {
                                "description": "itemId",
                                "type": "integer"
                            }
                        ]
                    },
                    "moveafteritem": {
                        "staticMethod": false,
                        "mandatoryParamsCount": 3,
                        "params": [
                            {
                                "description": "taskId",
                                "type": "integer"
                            },
                            {
                                "description": "itemId",
                                "type": "integer"
                            },
                            {
                                "description": "afterItemId",
                                "type": "integer"
                            }
                        ]
                    },
                    "isactionallowed": {
                        "staticMethod": false,
                        "mandatoryParamsCount": 3,
                        "params": [
                            {
                                "description": "taskId",
                                "type": "integer"
                            },
                            {
                                "description": "itemId",
                                "type": "integer"
                            },
                            {
                                "description": "actionId",
                                "type": "integer"
                            }
                        ]
                    }
                }
            },
            "time": {
                "start": 1769070876,
                "finish": 1769070877.009113,
                "duration": 1.009113073348999,
                "processing": 0,
                "date_start": "2026-01-22T11:34:36+03:00",
                "date_finish": "2026-01-22T11:34:37+03:00",
                "operating_reset_at": 1769071477,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
object

Объект с описанием методов task.checklistitem.*

time
time

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

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

Название
тип

Описание

error
string

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

error_description
error_description

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

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

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

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

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