Celonis (предварительная версия)
API платформы Celonis для работы с элементами модели знаний, такими как записи, ключевые показатели эффективности, фильтры, триггеры и связанные с ними данные.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка Celonis |
| URL | https://developer.celonis.com/ |
| Адрес электронной почты | intelligence-api-feedback-sc@celonis.de |
| Метаданные соединителя | |
|---|---|
| Publisher | Келонис |
| Веб-сайт | https://www.celonis.com |
| Политика конфиденциальности | https://www.celonis.com/privacy-policy/ |
| Категории | Искусственный интеллект; Управление бизнесом |
Название
API Аналитики Celonis позволяет клиентам Celonis внедрять меры аналитики процессов на сторонние платформы, где конечные пользователи могут воспользоваться аналитическими сведениями о процессах Celonis. Таким образом, это приведет к тому, что аналитика Celonis, как ключевые показатели эффективности процесса или процесс неэффективности, ближе к конечным пользователям и принесет пользу операционным пользователям без текущего доступа к Celonis, предоставляя ценные аналитические сведения для лучшего принятия решений при выполнении своих повседневных действий. Помимо возможности запроса данных API аналитики также поддерживает отправку данных на сторонние платформы, позволяя им подписываться на бизнес-триггеры.
Издатель: имя издателя
Предпосылки
- Команда в Celonis Platform.
- Модель знаний , доступная в команде клиента.
- Подписка celonis на основе процесса (обратитесь к группе учетной записи, чтобы проверить).
Поддерживаемые операции
Текущие методы API позволяют потребителям взаимодействовать с моделями знаний, определенными на платформе Celonis, предоставляя следующие функции:
Методы обнаружения моделей знаний
Получение списка моделей знаний (KM)
Получение списка записей KM
Получение сведений о схеме записи KM
Получение списка фильтров KM
Методы извлечения данных модели знаний
Получение списка данных записи KM
Методы управления жизненным циклом подписки
Получение списка подписок
Получение списка триггеров KM
Создание подписки на триггер KM
Обновление подписки
Приостановка подписки
Возобновление подписки
Завершение подписки
Получение учетных данных
Authentication
Каждый запрос к API должен пройти проверку подлинности с помощью ключа API Celonis. Это можно сделать двумя способами.
Использование ключа API пользователя
Вы можете узнать, как создать ключ API пользователя, следуя руководству по ключам API пользователя . API Celonis использует проверку подлинности маркера носителя для проверки доступа потребителей. Учетные данные должны быть отправлены в заголовке авторизации в HTTP-запросе. Учетные данные, отправленные в URL-адресе или тексте запроса, будут игнорироваться. Для проверки подлинности с помощью проверки подлинности маркера носителя:
- Создайте маркер в Celonis:
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - Включите строку в заголовок авторизации HTTP, форматированный следующим образом:
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
Использование ключа API приложения
Вы можете узнать, как создать AppKey, следуя руководству по ключам API приложений . Для проверки подлинности с помощью проверки подлинности AppKey:
- Создайте AppKey в Celonis:
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - Включите строку в заголовок авторизации HTTP, форматированный следующим образом:
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Authorization
Необходимо задать правильные разрешения и убедиться, что ключ API пользователя или ключ API приложения , который используется для авторизации, имеет доступ к пакету Celonis Studio, содержащего модели знаний, к которые вы хотите получить доступ через API аналитики. Вы можете предоставить разрешения на доступ, выполнив следующие действия.
- Перейдите к пакету Studio.
- Щелкните три точки и выберите
Permissionsв всплывающем меню. - Найдите пользователя (в случае использования маркера носителя ) или AppKey (если вы используете AppKey ) и предоставьте по крайней мере
USE PACKAGEправа.
Начало работы
Базовый URL-адрес API Celonis — https://<team>.<cluster>.celonis.cloud/intelligence/api найти команду и кластер, проверьте URL-адрес, который вы используете для доступа к платформе Celonis, и получения команды и кластера из него.
API Аналитики Celonis — это API JSON, и конечные точки всегда возвращают ответ JSON независимо от успешности запроса.
Текущие методы API позволяют потребителям взаимодействовать с моделями знаний, определенными на платформе Celonis, предоставляя следующие функции:
- Список доступных моделей знаний и их подробных сведений
- Список записей и их подробностей
- Список фильтров
- Данные для определенной записи. Сведения о функциях API аналитики Celonis на портале разработчика Celonis.
Известные проблемы и ограничения
Ограничение скорости
API аналитики не был создан для массового экспорта необработанных данных, но для создания вычисляемых результатов и аналитических сведений от интеллектуального анализа процессов, доступных для сторонних платформ и приложений. Именно поэтому API Celonis применяет ограничение скорости. Это означает, что в каждом вызове разрешено только определенное количество запросов, и в каждом вызове может быть получено определенное количество записей. Celonis резервирует право на корректировку ограничений скорости в любое время, чтобы гарантировать высококачественную услугу для всех клиентов.
Если клиент неоднократно превышает ограничения скорости или участвует в поведении, которое считается подозрительным, Celonis резервирует право временно или постоянно ограничить или приостановить доступ к API для этого клиента.
Если клиент превышает количество запросов в день, API Celonis вернет ответ 429 (слишком много запросов), включая заголовок HTTP (x-ratelimit-reset), указывающий время (в секундах), которое клиент должен ждать до обработки нового запроса.
Следующие заголовки HTTP также возвращаются в рамках каждого вызова:
-
x-ratelimit-limit: представляет максимальное количество запросов, которые клиент может выполнять в текущем окне времени. -
x-ratelimit-remaining: количество оставшихся запросов в текущем окне времени. В настоящее время API имеет следующие ограничения по умолчанию:
Таблица 1. Ограничения скорости запросов по умолчанию
|
Предел | Значения по умолчанию | |-|---| | Максимальное количество запросов в день | 6000 запросы/день | | Максимальное количество запросов в секунду | 20 requests/second | | Максимальное число разрешенных полей на запрос в модели знаний | 200 поля и запрос | | Максимальное количество записей на запрос, возвращаемое при вызове /data конечной точки | 50 записи и запрос | Общее максимальное количество записей, которые можно получить через конечную точку /data | Первые 5.000 записи на отфильтрованную или отсортированную таблицу | Подписка на триггер также применяет ограничение скорости. Это означает, что для команды можно создать только определенное количество подписок. Кроме того, независимо от того, сколько подписок создается, существует максимальное количество событий, которые могут быть созданы из API третьим лицам.
Если клиент достигает максимального количества подписок, необходимо удалить существующую подписку, чтобы создать новую.
Если клиент достигает максимального количества событий, создаваемых API, остальные данные, созданные платформой Celonis, будут удалены.
Если клиент приближается к ежедневной квоте, они будут проинформированы по электронной почте вашей учетной записи администратора. Первое сообщение электронной почты будет отправлено при превышении 80% квоты, позволяя учетной записи администратора знать, что вы превышаете этот процент. Второе сообщение будет отправлено, как только вы превышаете 100% квоты.
В настоящее время API имеет следующие ограничения по умолчанию:
Таблица 2. Ограничения скорости событий по умолчанию
|
Предел | Значения по умолчанию | |-|---| | Максимальное количество подписок или команды | 10 | | Максимальное количество событий в день | 100,000 | Обратитесь к группе учетной записи, чтобы проверить ограничения вашей команды.
Часто задаваемые вопросы
Ознакомьтесь с разделом " Часто задаваемые вопросы " на портале разработчика Celonis.
Инструкции по развертыванию
Обязательное. Добавьте инструкции по развертыванию этого соединителя в качестве настраиваемого соединителя.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Команда | струна | Укажите команду Celonis. | True |
| Cluster | струна | Укажите кластер Celonis. | True |
| Authorization | securestring | Авторизация для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Возобновляет подписку, чтобы начать получать новые события, отменяя события журнала |
Возобновляет приостановленную подписку, чтобы начать получать новые события снова, отменяя события журнала |
| Возобновляет приостановленную подписку, чтобы начать получение событий снова |
Возобновляет приостановленную подписку, чтобы начать получение событий снова |
| Извлекает следующую страницу событий не пересылается из-за неудачной подписки |
Извлекает следующую страницу событий, если они не были перенаправлены из-за неудачной подписки |
| Обновляет подписку |
Обновляет подписку |
| Отмена подписки из триггера, удаляя все данные для подписки |
Отмена подписки из триггера, удаляя все данные для подписки |
| Получение сведений о km верхнего уровня |
Модель знаний, определенная в команде EMS |
| Получение сведений о схеме записи KM верхнего уровня |
Сведения о схеме записи верхнего уровня |
| Получение списка KM |
Список моделей знаний, определенных в команде EMS |
| Получение списка данных записи KM |
Данные для записи в модели знаний |
| Получение списка подписок |
Список всех созданных подписок |
| Получение списка схем записей KM |
Список схем записей |
| Получение списка триггеров KM |
Список триггеров для модели знаний |
| Получение списка фильтров KM |
Список фильтров для модели знаний |
| Приостанавливает подписку, чтобы остановить получение событий |
Приостанавливает подписку, чтобы остановить получение событий |
| Создает подписку для триггера |
Создает подписку для триггера |
Возобновляет подписку, чтобы начать получать новые события, отменяя события журнала
Возобновляет приостановленную подписку, чтобы начать получать новые события снова, отменяя события журнала
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификатор подписки;
|
subscription_id | True | string |
Идентификатор подписки будет возобновлен без получения переданных событий |
Возобновляет приостановленную подписку, чтобы начать получение событий снова
Возобновляет приостановленную подписку, чтобы начать получение событий снова
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификатор подписки;
|
subscription_id | True | string |
Идентификатор подписки будет возобновлен и снова начнет получать событие. |
Извлекает следующую страницу событий не пересылается из-за неудачной подписки
Извлекает следующую страницу событий, если они не были перенаправлены из-за неудачной подписки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификатор подписки;
|
subscription_id | True | string |
Идентификатор подписки, который извлекает неудающееся событие, отправленное в не более 50 элементов |
Возвращаемое значение
- Страница результатов сигнала
- SignalResultPage
Обновляет подписку
Обновляет подписку
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификатор подписки;
|
subscription_id | True | string |
Идентификатор подписки, который будет полностью обновлен |
|
headers
|
headers | object |
Заголовки обратного вызова могут содержать маркер проверки подлинности, тип контента и т. д. |
|
|
protocol
|
protocol | True | string |
Только возможное значение — HTTPS, что означает, что URI обратного вызова должен быть допустимым https |
|
УРИ
|
uri | True | string |
Uri для выполнения обратного вызова из API аналитики после запуска триггера |
|
configurations
|
configurations | array of string |
Конфигурация подписки |
|
|
имя
|
name | True | string |
Имя подписки |
Отмена подписки из триггера, удаляя все данные для подписки
Отмена подписки из триггера, удаляя все данные для подписки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификатор подписки;
|
subscription_id | True | string |
Идентификатор подписки будет удален |
Получение сведений о km верхнего уровня
Модель знаний, определенная в команде EMS
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор модели знаний
|
km_id | True | string |
Идентификатор модели знаний |
Возвращаемое значение
Структура данных модели знаний
- Модель знаний
- knowledgeModelDetailedDTO
Получение сведений о схеме записи KM верхнего уровня
Сведения о схеме записи верхнего уровня
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор модели знаний
|
km_id | True | string |
Идентификатор модели знаний |
|
Код записи
|
record_id | True | string |
Код записи |
Возвращаемое значение
Запись представляет концепцию в модели знаний
- Тип записи
- recordDTO
Получение списка KM
Список моделей знаний, определенных в команде EMS
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результата, начиная с 0 (первая страница) |
|
|
Размер страницы
|
pageSize | integer |
Количество элементов, возвращаемых на странице. |
|
|
Сортировка
|
sort | string |
Определяет стратегию для продолжения сортировки без учета регистра. Оно должно быть только одним полем, и оно должно начинаться с "+", чтобы применить порядок ASC или "-", чтобы применить порядок DESC. Не префикс будет сортироваться как ASC. Не существующее поле в заголовке вызовет ошибку |
Возвращаемое значение
- Страница результатов KnowledgeModel
- knowledgeModelResultPage
Получение списка данных записи KM
Данные для записи в модели знаний
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор модели знаний
|
km_id | True | string |
Идентификатор модели знаний |
|
Код записи
|
record_id | True | string |
Код записи |
|
Фильтры
|
filters | array |
Предопределенный идентификатор фильтра |
|
|
Идентификаторы полей
|
fields | True | array |
Предопределенный идентификатор фильтра |
|
Страница
|
page | integer |
Номер страницы результата, начиная с 0 (первая страница) |
|
|
Размер страницы
|
pageSize | integer |
Количество элементов, возвращаемых на странице. |
|
|
Сортировка
|
sort | array |
Определяет стратегию для сортировки. Это должен быть разделенный запятыми список полей, и они должны начинаться с "+", чтобы применить порядок ASC или "-" для применения порядка DESC. Поля без префикса будут отсортированы как ASC. Не существующие поля в заголовке вызывают ошибку |
|
|
Критерий фильтра
|
filterExpr | array |
Динамические выражения фильтров |
Возвращаемое значение
- Страница результатов записи данных
- recordResultPageDTO
Получение списка подписок
Список всех созданных подписок
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результата, начиная с 0 (первая страница) |
|
|
Размер страницы
|
pageSize | integer |
Количество элементов, возвращаемых на странице. |
|
|
Сортировать
|
sort | string |
Определяет стратегию для продолжения сортировки без учета регистра. Оно должно быть только одним полем, и оно должно начинаться с "+", чтобы применить порядок ASC или "-", чтобы применить порядок DESC. Не префикс будет сортироваться как ASC. Не существующее поле в заголовке вызовет ошибку |
Возвращаемое значение
- Страница результатов схемы подписки
- subscriptionResultPage
Получение списка схем записей KM
Список схем записей
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результата, начиная с 0 (первая страница) |
|
|
Размер страницы
|
pageSize | integer |
Количество элементов, возвращаемых на странице. |
|
|
Сортировка
|
sort | string |
Определяет стратегию для продолжения сортировки без учета регистра. Оно должно быть только одним полем, и оно должно начинаться с "+", чтобы применить порядок ASC или "-", чтобы применить порядок DESC. Не префикс будет сортироваться как ASC. Не существующее поле в заголовке вызовет ошибку |
|
|
Идентификатор модели знаний
|
km_id | True | string |
Идентификатор модели знаний |
Возвращаемое значение
- Страница результатов схемы записи
- recordSchemaResultPage
Получение списка триггеров KM
Список триггеров для модели знаний
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результата, начиная с 0 (первая страница) |
|
|
Размер страницы
|
pageSize | integer |
Количество элементов, возвращаемых на странице. |
|
|
Сортировать
|
sort | string |
Определяет стратегию для продолжения сортировки без учета регистра. Оно должно быть только одним полем, и оно должно начинаться с "+", чтобы применить порядок ASC или "-", чтобы применить порядок DESC. Не префикс будет сортироваться как ASC. Не существующее поле в заголовке вызовет ошибку |
|
|
Идентификатор km
|
km_id | True | string |
Идентификатор модели знаний |
Возвращаемое значение
- Страница результатов схемы триггера
- triggerResultPage
Получение списка фильтров KM
Список фильтров для модели знаний
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Страница
|
page | integer |
Номер страницы результата, начиная с 0 (первая страница) |
|
|
Размер страницы
|
pageSize | integer |
Количество элементов, возвращаемых на странице. |
|
|
Сортировка
|
sort | string |
Определяет стратегию для продолжения сортировки без учета регистра. Оно должно быть только одним полем, и оно должно начинаться с "+", чтобы применить порядок ASC или "-", чтобы применить порядок DESC. Не префикс будет сортироваться как ASC. Не существующее поле в заголовке вызовет ошибку |
|
|
Идентификатор модели знаний
|
km_id | True | string |
Идентификатор модели знаний |
Возвращаемое значение
- Страница результатов схемы фильтра
- filterResultPage
Приостанавливает подписку, чтобы остановить получение событий
Приостанавливает подписку, чтобы остановить получение событий
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
идентификатор подписки;
|
subscription_id | True | string |
Идентификатор подписки будет приостановлен |
Создает подписку для триггера
Создает подписку для триггера
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор km
|
km_id | True | string |
Идентификатор модели знаний |
|
Идентификатор триггера
|
trigger_id | True | string |
Идентификатор триггера |
|
headers
|
headers | object |
Заголовки обратного вызова могут содержать маркер проверки подлинности, тип контента и т. д. |
|
|
protocol
|
protocol | True | string |
Только возможное значение — HTTPS, что означает, что URI обратного вызова должен быть допустимым https |
|
УРИ
|
uri | True | string |
Uri для выполнения обратного вызова из API аналитики после запуска триггера |
|
configurations
|
configurations | array of string |
Конфигурация подписки |
|
|
имя
|
name | True | string |
Имя подписки |
Возвращаемое значение
- response
- string
Определения
SignalResultPage
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
содержимое
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
Размер страницы, определенный системой |
filterDTO
Фильтр для применения в KM
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
описание
|
description | string |
Описание понятного для человека фильтра |
|
id
|
id | string |
Уникальный идентификатор фильтра |
|
имя
|
name | string |
Понятное отображаемое имя фильтра |
filterResultPage
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
page
|
page | integer |
Страница |
|
pageSize
|
pageSize | integer |
Размер страницы, определенный параметром pageSize |
|
sort
|
sort | string |
Поле, используемое для применения сортировки к запрошенным данным, + или нет символа означает ASC, — означает DESC |
|
итог
|
total | integer |
Всего элементов, возвращаемых на странице |
|
содержимое
|
content | array of filterDTO |
knowledgeModelDetailedDTO
Структура данных модели знаний
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
Уникальный идентификатор модели знаний |
|
имя
|
name | string |
Понятный для человека текст |
|
extendedKMId
|
extendedKMId | string |
Модель знаний, используемая в качестве ссылки, база KM. |
knowledgeModelResultPage
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
page
|
page | integer |
Страница |
|
pageSize
|
pageSize | integer |
Размер страницы, определенный параметром pageSize |
|
sort
|
sort | string |
Поле, используемое для применения сортировки к запрошенным данным, + или нет символа означает ASC, — означает DESC |
|
итог
|
total | integer |
Всего элементов, возвращаемых на странице |
|
содержимое
|
content | array of knowledgeModelSimplifiedDTO |
knowledgeModelSimplifiedDTO
Структура данных модели знаний
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
Уникальный идентификатор модели знаний |
|
имя
|
name | string |
Понятный для человека текст |
|
опубликованный
|
published | string |
Последняя опубликованная дата |
recordDTO
Запись представляет концепцию в модели знаний
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
описание
|
description | string |
Описание записи |
|
id
|
id | string |
Уникальный идентификатор записи |
|
имя
|
name | string |
Отображаемое имя записи, понятное имя человека |
|
столбцов
|
fields | array of recordFieldDTO |
recordFieldDTO
Поля для записи
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
format
|
format | string |
Формат для применения |
|
id
|
id | string |
Сумма, ожидающая оплаты |
|
имя
|
name | string |
понятное имя человека |
|
type
|
type | string | |
|
единица
|
unit | string |
Единица, добавленная в значение поля |
recordIdDTO
Идентификатор и имя типа записи
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
описание
|
description | string |
Описание записи |
|
id
|
id | string |
Уникальный идентификатор записи |
|
имя
|
name | string |
Отображаемое имя записи, понятное имя человека |
recordItemDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
данные
|
data | array of |
Список элементов записи, составной с именем и значением |
|
headers
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
агрегация
|
aggregation | boolean |
Укажите, является ли поле агрегированием или вычисляемыми данными (KPI). |
|
Фильтруемый
|
filterable | boolean |
Укажите, можно ли отфильтровать поле. |
|
format
|
format | string |
Выражение форматирования |
|
id
|
id | string |
Удостоверение поля для использования в параметре списка полей и параметре filterExpression |
|
имя
|
name | string |
Понятный для человека текст |
|
Сортируемый
|
sortable | boolean |
Укажите, можно ли отсортировать поле. |
|
type
|
type | string |
Возможные типы данных. |
|
единица
|
unit | string |
Дополнительный знак представления значений форматирования |
recordResultPageDTO
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
page
|
page | integer |
Страница |
|
pageSize
|
pageSize | integer |
Размер страницы, определенный параметром pageSize |
|
sort
|
sort | array of string | |
|
итог
|
total | integer |
Всего элементов, возвращаемых на странице |
|
Элемент записи
|
content | recordItemDTO |
recordSchemaResultPage
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
page
|
page | integer |
Страница |
|
pageSize
|
pageSize | integer |
Размер страницы, определенный параметром pageSize |
|
sort
|
sort | string |
Поле, используемое для применения сортировки к запрошенным данным, + или нет символа означает ASC, — означает DESC |
|
итог
|
total | integer |
Всего элементов, возвращаемых на странице |
|
содержимое
|
content | array of recordIdDTO |
signalDTO
Сигнал, хранящийся в подписке
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
signal
|
signal | string |
Необработанный json сигнала |
|
subscriptionId
|
subscriptionId | string |
Уникальный идентификатор подписчика в качестве SUID |
|
triggerId
|
triggerId | string |
Уникальный идентификатор триггера в качестве SUID |
|
дата создания
|
creationDate | date-time |
Дата создания сигнала |
subscriptionDTO
Схема подписки
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
configurations
|
configurations | array of string |
Конфигурация подписки |
|
id
|
id | string |
Уникальный идентификатор подписчика в качестве SUID |
|
knowledgeModelId
|
knowledgeModelId | string |
Уникальный идентификатор модели знаний |
|
latestSucceedEvent
|
latestSucceedEvent | date-time |
Дата последнего успешного события |
|
имя
|
name | string |
Понятное имя подписки |
|
статус
|
status | string | |
|
triggerId
|
triggerId | string |
Уникальный идентификатор триггера в качестве SUID |
subscriptionResultPage
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
page
|
page | integer |
Страница |
|
pageSize
|
pageSize | integer |
Размер страницы, определенный параметром pageSize |
|
sort
|
sort | string |
Поле, используемое для применения сортировки к запрошенным данным, + или нет символа означает ASC, — означает DESC |
|
итог
|
total | integer |
Всего элементов, возвращаемых на странице |
|
содержимое
|
content | array of subscriptionDTO |
triggerDTO
Триггер, определенный в KM
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
Уникальный идентификатор триггера в качестве SUID |
|
имя
|
name | string |
Понятное имя триггера человека |
|
запись
|
record | string |
Уникальный идентификатор записи в качестве SUID |
triggerResultPage
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
page
|
page | integer |
Страница |
|
pageSize
|
pageSize | integer |
Размер страницы, определенный параметром pageSize |
|
sort
|
sort | string |
Поле, используемое для применения сортировки к запрошенным данным, + или нет символа означает ASC, — означает DESC |
|
итог
|
total | integer |
Всего элементов, возвращаемых на странице |
|
содержимое
|
content | array of triggerDTO |
струна
Это базовый тип данных string.