Документация для разработчиков
Темная тема

event.offline.get

Права на выполнение: для всех

Метод возвращает приложению первые в очереди офлайновые события согласно установкам фильтра. Доступность офлайн событий можно проверить через метод feature.get.

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

Параметр Описание Тип
filter Фильтр записей. По умолчанию отдаются все записи, без фильтрации. Поддерживается фильтрация по полям: ID,
TIMESTAMP_X,
EVENT_NAME,
MESSAGE_ID
со стандартными операциями типа =, >, <, <= и так далее.
array
order Сортировка записей. Поддерживается сортировка по тем же полям, что и в фильтре, на вход принимается массив вида [поле=>ASC|DESC]. По умолчанию - [TIMESTAMP_X:ASC]. array
limit Количество выбираемых записей. По умолчанию 50. int

Дополнительные параметры

Параметр Описание
clear Значения: 0|1 - удалять ли выбранные записи. По умолчанию 1
process_id Идентификатор процесса. Используется если понадобится повторно выбрать еще не обработанные текущим процессом записи.
error Значения: 0|1 - возвращать ли ошибочные записи (см. ниже). По умолчанию 0.

Метод поддерживает многопоточный разбор. То есть допускается несколько параллельных запросов к /rest/event.offline.get (с соблюдением ограничений на количество запросов в единицу времени), и каждый из них получит разные наборы записей.

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024