Получить историю задачи tasks.task.history.list
Scope:
taskКто может выполнять метод: любой пользователь с доступом к задаче на чтение
Метод tasks.task.history.list получает историю изменений задачи.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
taskId* |
Идентификатор задачи, для которой нужно получить историю. Идентификатор задачи можно получить при создании новой задачи или методом получения списка задач |
|
filter |
Фильтр по типу события в формате |
|
order |
Объект для сортировки результата вида Направление сортировки может принимать значения:
По умолчанию записи сортируются по убыванию по времени создания, то есть от новых к старым |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"taskId":8137,"filter":{"FIELD":"COMMENT"},"order":{"createdDate":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.task.history.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"taskId":8137,"filter":{"FIELD":"COMMENT"},"order":{"createdDate":"ASC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.task.history.list
// callListMethod: Получает все данные сразу.
// Используйте только для небольших выборок (< 1000 элементов) из-за высокой
// нагрузки на память.
try {
const response = await $b24.callListMethod(
'tasks.task.history.list',
{
taskId: 8137,
filter: { FIELD: 'COMMENT' },
order: { createdDate: 'ASC' }
},
(progress) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора.
// Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('tasks.task.history.list', {
taskId: 8137,
filter: { FIELD: 'COMMENT' },
order: { createdDate: 'ASC' }
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start.
// Используйте для точного контроля над пакетами запросов.
// Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('tasks.task.history.list', {
taskId: 8137,
filter: { FIELD: 'COMMENT' },
order: { createdDate: 'ASC' }
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'tasks.task.history.list',
[
'taskId' => 8137,
'filter' => ['FIELD' => 'COMMENT'],
'order' => ['createdDate' => 'ASC']
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching task history: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.task.history.list',
{
taskId: 8137,
filter: { FIELD: 'COMMENT' },
order: {createdDate: 'ASC'},
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.task.history.list',
[
'taskId' => 8137,
'filter' => ['FIELD' => 'COMMENT'],
'order' => ['createdDate' => 'ASC']
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"list": [
{
"id": 16359,
"createdDate": "2025-09-25T14:09:45+03:00",
"field": "NEW",
"value": {
"from": null,
"to": null
},
"user": {
"id": 503,
"name": "Мария",
"lastName": "Иванова",
"secondName": "",
"login": "maria@mysite.ru"
}
},
{
"id": 16361,
"createdDate": "2025-09-25T14:09:45+03:00",
"field": "COMMENT",
"value": {
"from": null,
"to": "3409"
},
"user": {
"id": 503,
"name": "Мария",
"lastName": "Иванова",
"secondName": "",
"login": "maria@mysite.ru"
}
},
{
"id": 16363,
"createdDate": "2025-09-25T14:09:45+03:00",
"field": "CHECKLIST_ITEM_CREATE",
"value": {
"from": "",
"to": "Что сделать"
},
"user": {
"id": 503,
"name": "Мария",
"lastName": "Иванова",
"secondName": "",
"login": "maria@mysite.ru"
}
},
{
"id": 16365,
"createdDate": "2025-09-25T14:09:45+03:00",
"field": "CHECKLIST_ITEM_CREATE",
"value": {
"from": "",
"to": "Связаться с клиентом"
},
"user": {
"id": 503,
"name": "Мария",
"lastName": "Иванова",
"secondName": "",
"login": "maria@mysite.ru"
}
},
{
"id": 16367,
"createdDate": "2025-09-25T14:09:45+03:00",
"field": "CHECKLIST_ITEM_CREATE",
"value": {
"from": "",
"to": "Подготовить договор"
},
"user": {
"id": 503,
"name": "Мария",
"lastName": "Иванова",
"secondName": "",
"login": "maria@mysite.ru"
}
},
{
"id": 16369,
"createdDate": "2025-09-25T14:09:45+03:00",
"field": "CHECKLIST_ITEM_CREATE",
"value": {
"from": "",
"to": "Подписать договор"
},
"user": {
"id": 503,
"name": "Мария",
"lastName": "Иванова",
"secondName": "",
"login": "maria@mysite.ru"
}
},
{
"id": 16371,
"createdDate": "2025-09-25T14:09:57+03:00",
"field": "AUDITORS",
"value": {
"from": "",
"to": "547"
},
"user": {
"id": 503,
"name": "Мария",
"lastName": "Иванова",
"secondName": "",
"login": "maria@mysite.ru"
}
},
{
"id": 16375,
"createdDate": "2025-09-25T14:09:57+03:00",
"field": "COMMENT",
"value": {
"from": null,
"to": "3411"
},
"user": {
"id": 503,
"name": "Мария",
"lastName": "Иванова",
"secondName": "",
"login": "maria@mysite.ru"
}
},
{
"id": 16373,
"createdDate": "2025-09-25T14:09:58+03:00",
"field": "COMMENT",
"value": {
"from": null,
"to": "3413"
},
"user": {
"id": 503,
"name": "Мария",
"lastName": "Иванова",
"secondName": "",
"login": "maria@mysite.ru"
}
}
],
},
"time": {
"start": 1758798620,
"finish": 1758798620.969019,
"duration": 0.9690189361572266,
"processing": 0,
"date_start": "2025-09-25T14:10:20+03:00",
"date_finish": "2025-09-25T14:10:20+03:00",
"operating_reset_at": 1758799220,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит массив Возвращает пустой массив |
|
time |
Информация о времени выполнения запроса |
Объекты lists
|
Название |
Описание |
|
id |
Идентификатор события истории |
|
createdDate |
Дата и время создания события в формате ISO 8601 |
|
field |
Тип события истории. Возможные значения
|
|
value |
Объект описывает, какое изменение произошло:
Тип значения зависит от события: для нового комментария — |
|
user |
Объект с описанием пользователя, который выполнил действие |
Объект user
|
Название |
Описание |
|
id |
Идентификатор пользователя |
|
name |
Имя |
|
lastName |
Фамилия |
|
secondName |
Отчество |
|
login |
Логин |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Access denied. (internal error)"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
CTaskItem All parameters in the constructor must have real class type (internal error) |
Не указан обязательный параметр |
|
|
wrong task id (internal error) |
В параметре |
|
|
Access denied. (internal error) |
У пользователя нет доступа к задаче |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |