Возобновить пункт чек-листа шаблона задачи tasks.template.checklist.renew

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

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

Метод tasks.template.checklist.renew снимает отметку выполнения с пункта чек-листа шаблона задачи.

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

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

Название
тип

Описание

templateId*
integer

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

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

checkListItemId*
integer

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

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

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "templateId": 139,
  "checkListItemId": 27
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.template.checklist.renew
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "templateId": 139,
  "checkListItemId": 27,
  "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/tasks.template.checklist.renew
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type ChecklistRenewResult = {
  checkListItem: {
    id: number
    copiedId: number | null
    userId: number
    createdBy: number | null
    parentId: number | null
    title: string
    sortIndex: number
    displaySortIndex: string
    isComplete: boolean
    isImportant: boolean
    completedCount: number
    members: unknown[]
    attachments: unknown[]
    nodeId: number | null
    templateId: number
  }
}

try {
  const response = await $b24.actions.v2.call.make<ChecklistRenewResult>({
    method: 'tasks.template.checklist.renew',
    params: {
      templateId: 139,
      checkListItemId: 27,
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.checkListItem)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function renewChecklistItem() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'tasks.template.checklist.renew',
        params: {
          templateId: 139,
          checkListItemId: 27,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.checkListItem)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', renewChecklistItem)
</script>
try {
    $response = $b24Service
        ->core
        ->call(
            'tasks.template.checklist.renew',
            [
                'templateId' => 139,
                'checkListItemId' => 27
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
BX24.callMethod(
    'tasks.template.checklist.renew',
    {
        templateId: 139,
        checkListItemId: 27,
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'tasks.template.checklist.renew',
    [
        'templateId' => 139,
        'checkListItemId' => 27
    ]
);

print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.template.checklist.renew", b24.Params{
	"templateId":      139,
	"checkListItemId": 27,
})
if err != nil {
	return fmt.Errorf("tasks.template.checklist.renew: %w", err)
}

// Метод заворачивает ответ в объект с ключом "checkListItem".
raw, ok := b24.Unwrap(res.Result, "checkListItem")
if !ok {
	return fmt.Errorf("в ответе нет ключа checkListItem")
}

var item struct {
	ID               b24.ID `json:"id"`
	UserID           b24.ID `json:"userId"`
	ParentID         b24.ID `json:"parentId"`
	Title            string `json:"title"`
	SortIndex        int    `json:"sortIndex"`
	DisplaySortIndex string `json:"displaySortIndex"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.UserID)

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

HTTP-статус: 200

{
    "result": {
        "checkListItem": {
            "id": 27,
            "copiedId": null,
            "userId": 503,
            "createdBy": null,
            "parentId": 23,
            "title": "2. Заполнить форму отчета",
            "sortIndex": 1,
            "displaySortIndex": "",
            "isComplete": false,
            "isImportant": false,
            "completedCount": 0,
            "members": [],
            "attachments": [],
            "nodeId": null,
            "templateId": 139
        }
    },
    "time": {
        "start": 1773241079,
        "finish": 1773241079.318369,
        "duration": 0.31836891174316406,
        "processing": 0,
        "date_start": "2026-03-11T17:57:59+03:00",
        "date_finish": "2026-03-11T17:57:59+03:00",
        "operating_reset_at": 1773241679,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа (подробное описание)

time
time

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

Объект result

Название
тип

Описание

checkListItem
object

Пункт чек-листа после возобновления (подробное описание)

Объект checkListItem

Название
тип

Описание

id
integer

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

copiedId
integer

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

userId
integer

Идентификатор пользователя, в контексте которого сформирован объект

createdBy
integer

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

parentId
integer

Идентификатор родительского пункта. Значение 0 означает корневой пункт

title
string

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

sortIndex
integer

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

displaySortIndex
string

Вспомогательное значение порядка отображения

isComplete
boolean

Статус выполнения пункта

isImportant
boolean

Отметка важности пункта

completedCount
integer

Количество завершений пункта

members
array

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

Если данных нет, возвращается пустой массив []

attachments
object

Объект с описанием вложений.

Если данных нет, возвращается пустой массив []

nodeId
integer

Служебный идентификатор узла, если используется

templateId
integer

Идентификатор шаблона задачи

Объект members

Название
тип

Описание

id
string

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

type
string

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

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

name
string

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

personalPhoto
string

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

personalGender
string

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

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

image
string

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

isCollaber
boolean

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

Объект attachments

Название
тип

Описание

attachmentId
string

Идентификатор файла на Диске в формате n<fileId>, где ключ — идентификатор прикрепления

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

HTTP-статус: 400

{
    "error": "100",
    "error_description": "Could not find value for parameter {templateId}"
}

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

400

100

Could not find value for parameter

Не передан обязательный параметр templateId

400

100

Bitrix\Tasks\CheckList\Internals\CheckList All parameters in the constructor must have real class type

Не передан обязательный параметр checkListItemId

400

0

Bitrix\Tasks\CheckList\CheckListFacade::onAfterUpdate(): Argument #1 ($taskId) must be of type int, string given, called in /var/www/html/bitrix/modules/tasks/lib/checklist/checklistfacade.php on line 313

Указан пустой или с неверным типом templateId

400

0

Указано некорректное значение [] для поля [ENTITY_ID] в элементе [, ]

Указан несуществующий, пустой или с неверным типом checkListItemId

400

0

Изменение статуса элемента: действие недоступно

У пользователя нет прав доступа на изменение шаблона задачи

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

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

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

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

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

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