Получить список записей о затраченном времени task.elapseditem.getlist

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: task

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

Метод возвращает список записей о затраченном времени по задаче.

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

Название
тип

Описание

TASKID
integer

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

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

ORDER
object

Объект для сортировки результата (подробное описание приведено ниже)

FILTER
object

Объект для фильтрации результата (подробное описание приведено ниже)

SELECT
array

Массив полей записей, которые будут возвращены методом. Можно указать только те поля, которые необходимы. Если в массиве присутствует значение "*", то будут возвращены все доступные поля.

По умолчанию будут возвращены все поля основной таблицы запроса

PARAMS
object

Объект для опций вызова. Элементом является объект NAV_PARAMS вида {'опция вызова': 'значение' [, ...]} (подробное описание приведено ниже) в виде структуры

Важно

Соблюдать указанный в таблице порядок следования параметров в запросе — обязательно. Иначе запрос выполнится с ошибками.

Примечание

Особенности ручного добавления информации о времени работы, которая была фактически выполнена несколько дней назад. В этом случае меняется значение некоторых полей:

  • CREATED_DATE — дата начала
  • DATE_START — дата создания записи
  • DATE_STOP — дата окончания записи

Параметр ORDER

Название
тип

Описание

ID
string

Идентификатор записи о затраченном времени. Может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

USER_ID
string

Идентификатор пользователя, от имени которого была сделана запись о затраченном времени. Может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

MINUTES
string

Затраченное время, минуты. Может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

SECONDS
string

Затраченное время, секунды. Может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

CREATED_DATE
string

Дата создания записи. Может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

DATE_START
string

Дата начала. Может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

DATE_STOP
string

Дата конца. Может принимать значения:

  • asc — по возрастанию
  • desc — по убыванию

Параметр FILTER

Название
тип

Описание

ID
integer

Идентификатор записи о затраченном времени

USER_ID
integer

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

CREATED_DATE
datetime

Дата создания записи

Примечание

Перед названием фильтруемого поля можно указать тип фильтрации:

  • "!" — не равно
  • "<" — меньше
  • "<=" — меньше либо равно
  • ">" — больше
  • ">=" — больше либо равно

'значения фильтра' — одиночное значение или массив

Параметр NAV_PARAMS

Название
тип

Описание

nPageSize
integer

Количество элементов на странице. В целях ограничения нагрузки на постраничную навигацию наложено ограничение в 50 записей

iNumPage
integer

Номер страницы при постраничной навигации

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '[{"ID": "desc"},{">=CREATED_DATE": "2024-02-16"}]' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.elapseditem.getlist
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{[{"ID": "desc"},{">=CREATED_DATE": "2024-02-16"}],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/task.elapseditem.getlist
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'task.elapseditem.getlist',
            [
              1, 
              {'ID': 'desc'},
              {'<ID': 50}
            ],
            (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('task.elapseditem.getlist', [{'ID': 'desc'}, {'>=CREATED_DATE': '2024-02-16'}, ['ID', 'TASK_ID'], {"NAV_PARAMS":{"nPageSize":2}}], '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('task.elapseditem.getlist', [{'ID': 'desc'}, {'>=CREATED_DATE': '2024-02-16'}, ['ID', 'TASK_ID'], {"NAV_PARAMS":{"nPageSize":2}}], 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
try {
            // Получить все записи о затраченном времени с сортировкой по ID в нисходящем порядке.
            // Будут отфильтрованы только те записи, ID которых имеет значение меньше 50.
            $response1 = $b24Service
                ->core
                ->call(
                    'task.elapseditem.getlist',
                    [
                        1,
                        ['ID' => 'desc'],
                        ['<ID' => 50],
                    ]
                );
        
            $result1 = $response1
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result1, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting elapsed time records: ' . $e->getMessage();
        }
        
        try {
            // Получение выборки по затраченному времени на основании общих условий фильтрации. Например, выбрать данные о трудозатратах с указанной даты:
            $response2 = $b24Service
                ->core
                ->call(
                    'task.elapseditem.getlist',
                    [
                        ['ID' => 'desc'],
                        ['>=CREATED_DATE' => '2024-02-16'],
                        ['ID', 'TASK_ID'],
                        [
                            'NAV_PARAMS' => [
                                'nPageSize' => 2,
                            ],
                        ],
                    ]
                );
        
            $result2 = $response2
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result2, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting elapsed time records: ' . $e->getMessage();
        }
        
// Получить все записи о затраченном времени с сортировкой по ID в нисходящем порядке.
        // Будут отфильтрованы только те записи, ID которых имеет значение меньше 50.
        BX24.callMethod(
            'task.elapseditem.getlist',
            [
                1, 
                {'ID': 'desc'},
                {'<ID': 50}
            ],
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        // Получение выборки по затраченному времени на основании общих условий фильтрации. Например, выбрать данные о трудозатратах с указанной даты:
        BX24.callMethod(
            'task.elapseditem.getlist',
            [
                {'ID': 'desc'}, 
                {'>=CREATED_DATE': '2024-02-16'},
                ['ID', 'TASK_ID'],
                {"NAV_PARAMS":{
                        "nPageSize":2
                    }
                },
            ],
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'task.elapseditem.getlist',
            [
                "ORDER" => ["ID" => "DESC"],            // Сортировка по ID - по убыванию
                "FILTER" => [">ID" => 1],               // Фильтр
                "SELECT" => ['ID', 'TASK_ID'],          // Выборка - только ID записи и задачи
                "PARAMS" => ['NAV_PARAMS' => [          // Постраничка
                        "nPageSize" => 2,                   // по 2 элемента на странице
                        'iNumPage' => 2                     // страница номер 2
                    ]
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

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

HTTP-статус: 200

{
            "result":[
                {
                    "ID": "1",
                    "TASK_ID": "691",
                    "USER_ID": "1",
                    "COMMENT_TEXT": "1",
                    "SECONDS": "3600",
                    "MINUTES": "60",
                    "SOURCE": "2",
                    "CREATED_DATE": "2024-05-16T10:33:00+02:00",
                    "DATE_START": "2024-05-16T10:33:15+02:00",
                    "DATE_STOP": "2024-05-16T10:33:15+02:00"
                }
            ],
            "total": 1,
            "time":{
                "start":1712137817.343984,
                "finish":1712137817.605804,
                "duration":0.26182007789611816,
                "processing":0.018325090408325195,
                "date_start":"2024-04-03T12:50:17+03:00",
                "date_finish":"2024-04-03T12:50:17+03:00"
            }
        }
        

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

Название
тип

Описание

result
array

Массив объектов с информацией о записях о затраченном времени по задаче

total
integer

Общее количество найденных записей

time
time

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

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

HTTP-статус: 400

{
            "error":"ERROR_CORE",
            "error_description":"ACTION_NOT_ALLOWED"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

0x100002

Доступ запрещен

0x000004

Действие не разрешено

0x000040

Неизвестная ошибка

0x000100

Переданы неверные параметры метода

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

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

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

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