• Управление метриками процессов
  • Обновление значения метрики
  • Структура запроса
  • Параметры запроса
  • Структура ответа
  • Поля ответа

Метрики процессов

Управление метриками процессов через REST API. Общие правила (авторизация, лимиты) — в обзоре REST API.

Управление метриками процессов

Обновление значения метрики

Путь: POST /public-api/v1/processes/metrics

Метод позволяет заполнять или обновлять значения метрик для процессов. Сама метрика (пользовательское поле) должна быть предварительно создана в интерфейсе системы.

Структура запроса

{
    "processId": "94d2e63f-f84a-40d4-b4a3-592b0cc7c7d9",
    "metricName": "Среднее время выполнения",
    "metricValue": 45.5,
    "metricPlanValue": 30.0,
    "comment": "Значение за январь 2025",
    "metricDate": "2025-01-15T10:30:00"
}

Параметры запроса

Поле	Тип	Обязательное	Описание
processId	UUID	✅	Идентификатор процесса
metricName	string	✅	Название метрики
metricValue	number	📄	Фактическое значение метрики
metricPlanValue	number	📄	Плановое значение метрики
comment	string	📄	Комментарий к значению
metricDate	datetime	📄	Дата/время измерения (ISO 8601)

Структура ответа

{
    "processId": "94d2e63f-f84a-40d4-b4a3-592b0cc7c7d9",
    "metricName": "Среднее время выполнения",
    "metricValue": 45.5,
    "metricPlanValue": 30.0,
    "delta": 15.5,
    "comment": "Значение за январь 2025",
    "metricDate": "2025-01-15T10:30:00"
}

Поля ответа

Поле	Тип	Описание
processId	UUID	Идентификатор процесса
metricName	string	Название метрики
metricValue	number	Фактическое значение метрики
metricPlanValue	number	Плановое значение метрики
delta	number	Отклонение от плана (metricValue - metricPlanValue)
comment	string	Комментарий к значению
metricDate	datetime	Дата/время измерения

Сценарии использования

• Интеграция с BPMS: Автоматическая загрузка метрик производительности из систем исполнения процессов (Camunda, Activiti и др.)
• BI системы: Экспорт аналитических показателей из хранилищ данных
• Мониторинг SLA: Автоматическое обновление показателей соблюдения SLA

---