Различия

Показаны различия между двумя версиями страницы.

--- product:api:list:checktimerevent [13.02.2026 06:28] – Москвитина Алина
+++ product:api:list:checktimerevent [02.03.2026 06:39] (текущий) – Москвитина Алина
@@ Строка 2: / Строка 2: @@
 Метод: **CheckTimerEvent**
-Увидеть всю очередь сообщений бизнес-операции можно с помощью API-функции «CheckTimerEvent». Информацию о способе её вызова также можно найти на странице службы «APIScheduledEvents» (относительный путь на стенде ADVANTA: «/components/services/APIScheduledEvents.asmx»).
+Позволяет увидеть всю очередь сообщений бизнес-операции.
+**Примечание:**
+Информацию о способе вызова также можно найти на странице «APIScheduledEvents» (относительный путь для установленной системы ADVANTA: «/components/services/APIScheduledEvents.asmx»).
 =====Передаваемые параметры=====
-^Параметр^Описание^
+^Параметр^Тип^Назначение^
-|SessionID|ID сессии пользователя|
+|**SessionID**|string|Идентификатор сессии пользователя, от имени которого выполняется операция|
-|OperationCode|обязательный целочисленный параметр с кодом операции|
+|**OperationCode**|int|**Обязательный**. Код бизнес-операции. Определяет тип обрабатываемого события|
-|ObjectID|GUID объекта. \\ Не обязательный параметр. Если он передан, ищутся сохраненные в очереди записи с точным совпадением на GUID и код операции. Если параметр null, то необходимо искать в очереди записи только с кодом операции и ObjectID = null.|
+|**ObjectID**|Guid|Идентификатор объекта, с которым связано событие. Влияет на логику поиска существующих записей в очереди: \\ • Если параметр передан (не null), производится поиск записей с точным совпадением по GUID и коду операции \\ • Если параметр имеет значение null, поиск осуществляется только по коду операции с условием ObjectID = null|
 <code xml>
@@ Строка 27: / Строка 30: @@
 =====Возвращаемые параметры=====
-^Параметр^Описание^Описание^Тип данных^
+^Параметр^Название^Описание^Тип данных^
-CheckTimerEventResponse|Ответ на проверку таймера|Корневой элемент ответа|Контейнер
+|CheckTimerEventResponse|Ответ на проверку таймера|Корневой элемент ответа|Контейнер|
-CheckTimerEventResult|Результат проверки таймера|Содержит список событий таймера|Контейнер
+|CheckTimerEventResult|Результат проверки таймера|Содержит список событий таймера|Контейнер|
-TimerEvents|Список событий|Коллекция событий таймера|Массив
+|TimerEvents|Список событий|Коллекция событий таймера|Массив|
-CheckTimerEventWrapper|Событие таймера|Информация о запланированном событии|Объект
+|CheckTimerEventWrapper|Событие таймера|Информация о запланированном событии|Объект|
-Id|Идентификатор события|Уникальный идентификатор события|GUID
+|Id|Идентификатор события|Уникальный идентификатор события|GUID|
-ObjectId|Идентификатор объекта|ID объекта, с которым связано событие|GUID
+|ObjectId|Идентификатор объекта|ID объекта, с которым связано событие|GUID|
-CallTime|Время вызова|Дата и время запланированного вызова|DateTime (ISO 8601)
+|CallTime|Время вызова|Дата и время запланированного вызова|DateTime (ISO 8601)|
-Parameters|Параметры|JSON-строка с дополнительными параметрами|JSON
+|Parameters|Параметры|JSON-строка с дополнительными параметрами|JSON|
+**Примечания:**
+  * ''CallTime'' представлен в формате ISO 8601: ''ГГГГ-ММ-ДДTЧЧ:ММ:СС''
+  * ''Parameters'' содержит сериализованный JSON с данными объекта
+  * Все GUID идентификаторы имеют стандартный формат ''8-4-4-4-12''
+  * Пространство имен XML: ''http://streamline/''
+\\
-|CheckTimerEventResult|Группирующий элемент массива бизнес-операций|
-|TimerEvents|Массив бизнес-операций|
-|CheckTimerEventWrapper|Массив вызовов|
-|Id|Массив вызовов|
-|ObjectId|Массив вызовов|
-|CallTime|Массив вызовов|
-|Parameters|Массив вызовов|
 <code xml>
 <?xml version="1.0" encoding="utf-8"?>
@@ Строка 77: / Строка 73: @@
 </soap:Envelope>
 </code>
+===== Пример вызова API «CheckTimerEvent» в Postman =====
 Пример настройки POST-запроса для вызова «CheckTimerEvent» в Postman: