Перейти к основному содержимому

Карта API

Общие правила

  • Базовый префикс: /api/v2/management.
  • Все write endpoints требуют authenticated actor и permission.
  • Все списки поддерживают page, perPage, sort, filters.
  • Все команды, которые могут быть повторены клиентом или worker, принимают Idempotency-Key.
  • Drill-down links не возвращают данные исходного домена, а отдают ссылку и проверяемый контекст.
  • Ошибки возвращаются в общем envelope из identity/API Gateway.

Metrics

EndpointМетодPermissionНазначение
/metricsGETmanagement.metrics.readсписок метрик
/metricsPOSTmanagement.metrics.manageсоздать метрику
/metrics/{metricId}GETmanagement.metrics.readкарточка метрики
/metrics/{metricId}PATCHmanagement.metrics.manageизменить метаданные
/metrics/{metricId}/versionsGETmanagement.metrics.readверсии формулы
/metrics/{metricId}/versionsPOSTmanagement.metrics.manageновая версия формулы
/metrics/{metricKey}/valuesGETmanagement.metrics.readзначения метрики
/metrics/{metricKey}/recalculatePOSTmanagement.metrics.recalculateзапросить пересчёт

Dashboards

EndpointМетодPermissionНазначение
/dashboardsGETmanagement.dashboards.readдоступные dashboards
/dashboardsPOSTmanagement.dashboards.manageсоздать dashboard
/dashboards/{dashboardId}GETmanagement.dashboards.readdashboard с widgets
/dashboards/{dashboardId}PATCHmanagement.dashboards.manageизменить dashboard
/dashboards/{dashboardId}/publishPOSTmanagement.dashboards.publishопубликовать
/dashboards/{dashboardId}/widgetsPOSTmanagement.dashboards.manageдобавить widget
/widgets/{widgetId}PATCH/DELETEmanagement.dashboards.manageизменить или удалить widget
/dashboards/{dashboardId}/saved-viewsGET/POSTmanagement.dashboards.readпользовательские views

Plans

EndpointМетодPermissionНазначение
/plansGETmanagement.plans.readсписок планов
/plansPOSTmanagement.plans.manageсоздать план
/plans/{planId}GETmanagement.plans.readкарточка плана
/plans/{planId}PATCHmanagement.plans.manageизменить план
/plans/{planId}/statusPATCHmanagement.plans.manageизменить статус
/plans/{planId}/targetsPOSTmanagement.plans.manageдобавить цель
/plan-targets/{targetId}/factsGETmanagement.plans.readplan-fact история
/plans/{planId}/tasksGET/POSTmanagement.tasks.read/manageсвязанные задачи

Tasks

EndpointМетодPermissionНазначение
/tasksGETmanagement.tasks.readсписок задач
/tasksPOSTmanagement.tasks.manageсоздать задачу
/tasks/{taskId}GETmanagement.tasks.readкарточка
/tasks/{taskId}PATCHmanagement.tasks.manageредактировать
/tasks/{taskId}/statusPATCHmanagement.tasks.manageсменить статус
/tasks/{taskId}/commentsGET/POSTmanagement.tasks.read/commentкомментарии
/tasks/{taskId}/historyGETmanagement.tasks.readистория изменений
/task-templatesGET/POSTmanagement.adminшаблоны задач

Alerts

EndpointМетодPermissionНазначение
/alert-rulesGET/POSTmanagement.alerts.manageправила alerts
/alert-rules/{ruleId}GET/PATCHmanagement.alerts.manageкарточка правила
/alertsGETmanagement.alerts.readсписок alerts
/alerts/{alertId}GETmanagement.alerts.readкарточка alert
/alerts/{alertId}/acknowledgePOSTmanagement.alerts.manageподтвердить
/alerts/{alertId}/resolvePOSTmanagement.alerts.manageзакрыть
/alerts/{alertId}/create-taskPOSTmanagement.tasks.manageсоздать задачу

Data quality

EndpointМетодPermissionНазначение
/data-sourcesGET/POSTmanagement.data_sources.manageисточники
/data-sources/{sourceId}GET/PATCHmanagement.data_sources.manageкарточка источника
/ingestion-runsGETmanagement.data_quality.readзагрузки
/data-quality/issuesGETmanagement.data_quality.readпроблемы данных
/data-quality/issues/{issueId}/acknowledgePOSTmanagement.data_quality.manageподтвердить
/data-quality/issues/{issueId}/resolvePOSTmanagement.data_quality.manageзакрыть

Management actions

EndpointМетодPermissionНазначение
/goal-profilesGET/POSTmanagement.goals.read/manageпрофили целей
/goalsGET/POSTmanagement.goals.read/manageцели
/goals/{goalId}/activatePOSTmanagement.goals.manageактивировать цель
/recommendationsGETmanagement.recommendations.readрекомендации
/recommendations/{recommendationId}/publishPOSTmanagement.recommendations.publishопубликовать рекомендацию
/recommendations/{recommendationId}/dismissPOSTmanagement.recommendations.dismissотклонить рекомендацию
/diagnosticsGET/POSTmanagement.diagnostics.read/manageдиагностики
/actionsPOSTmanagement.actions.executeзапустить действие
/actions/{actionId}GETmanagement.actions.readстатус действия
/actions/{actionId}/retryPOSTmanagement.actions.executeповторить failed действие

Admin

EndpointМетодPermissionНазначение
/settingsGET/PATCHmanagement.adminнастройки домена
/audit-logsGETmanagement.audit.readаудит
/exportsPOSTmanagement.exports.createэкспорт отчёта

Error codes

КодHTTPКогда
management.metric.not_found404метрика не найдена
management.metric.version_required400изменение формулы без версии
management.dashboard.not_publishable409dashboard нельзя опубликовать
management.plan.invalid_status409недопустимый переход плана
management.task.invalid_status409недопустимый переход задачи
management.alert.already_resolved409alert уже закрыт
management.data_source.unavailable503источник недоступен
management.sensitivity.forbidden403sensitivity запрещает доступ