Factorizer/Cluster ERP WikiCluster ERP English
Ana sayfa / API referansı

API

Logs API (logs)

/api/v1/logs altındaki logs modülünün HTTP uç noktaları: yetkiler, şemalar, durum kodları ve hata kodlarıyla 9 yol.

logs modülü etkinlik günlüğünü, istemci hata bildirimi ve izleme kimliğiyle arama içeren hata günlüğünü ve değişiklik geçmişini sunar. 9 uç noktanın tamamı /api/v1/logs altındadır. İş anlamı için Logs modülü sayfasına bakın.

Grup olguları

Öğe Değer Kaynak
Temel yol /api/v1/logs src/cluster_erp/core/module_base.py:37-38, src/cluster_erp/modules/logs/module.py:42
Yönlendiriciler 3 dosyada 3 yönlendirici nesnesi; Uç nokta özeti bölümünde listelenir src/cluster_erp/modules/logs/module.py:31
Uç noktalar 9; register_routes ile bağlanan yönlendiricilerin yol dekoratörleri ve add_api_route çağrılarından sayıldı src/cluster_erp/modules/logs/activity_log/routes.py, src/cluster_erp/modules/logs/change_history/routes.py, src/cluster_erp/modules/logs/error_log/routes.py
Kimlik doğrulama Bearer başlığı veya oturum çerezi, get_current_user ile çözülür; bkz. Kimlik doğrulama ve başlıklar src/cluster_erp/modules/auth/guards.py:85-167
Yetki koruması 9 yolun 8 tanesi require_permission bildirir; diğer yollar korumalarını tablolarda gösterir src/cluster_erp/modules/auth/guards.py:205-240
Hata biçimi JSON gövdesi {"error": {...}}; bkz. Hatalar src/cluster_erp/server/error_handler.py:33-46

Uç nokta özeti

Alt modül klasörü başına bir satır. Yönlendirici öneki temel yola eklenir.

Alt modül Yönlendiriciler Uç noktalar Yönlendirici kaynağı
activity_log router (/activities) 2 src/cluster_erp/modules/logs/activity_log/routes.py:18
error_log router (/errors) 4 src/cluster_erp/modules/logs/error_log/routes.py:19
change_history router (/change-history) 3 src/cluster_erp/modules/logs/change_history/routes.py:19

Etkinlik günlüğü uç noktaları

Etkinlik günlüğü listeleme ve okuma.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
GET /api/v1/logs/activities/ list_activity_logs activity_log.read yok search, actor_id, module, method, status_min, status_max, date_from, date_to, limit, offset ActivityLogListResponse 200 (varsayılan) src/cluster_erp/modules/logs/activity_log/routes.py:21
GET /api/v1/logs/activities/{log_id} get_activity_log activity_log.read yok yok ActivityLogRead 200 (varsayılan) src/cluster_erp/modules/logs/activity_log/routes.py:58

Hata günlüğü uç noktaları

İstemci hata bildirimi, hata günlüğü listesi, izleme kimliğiyle okuma ve kimlikle okuma.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
POST /api/v1/logs/errors/client report_client_error oturum açmış kullanıcı (get_current_user) ClientErrorReport yok ErrorLogRead 201 src/cluster_erp/modules/logs/error_log/routes.py:22
GET /api/v1/logs/errors/ list_error_logs error_log.read yok search, trace_id, error_code, http_status, actor_id, date_from, date_to, limit, offset ErrorLogListResponse 200 (varsayılan) src/cluster_erp/modules/logs/error_log/routes.py:47
GET /api/v1/logs/errors/by-trace/{trace_id} get_error_by_trace error_log.read yok yok ErrorLogRead 200 (varsayılan) src/cluster_erp/modules/logs/error_log/routes.py:82
GET /api/v1/logs/errors/{log_id} get_error_log error_log.read yok yok ErrorLogRead 200 (varsayılan) src/cluster_erp/modules/logs/error_log/routes.py:95

Değişiklik geçmişi uç noktaları

Değişiklik geçmişi listesi, tablo listesi ve tek bir kaydın geçmişi.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
GET /api/v1/logs/change-history/ list_change_history change_history.read yok search, entity_type, table_name, action, actor_id, date_from, date_to, limit, offset ChangeHistoryListResponse 200 (varsayılan) src/cluster_erp/modules/logs/change_history/routes.py:29
GET /api/v1/logs/change-history/tables list_change_history_tables change_history.read yok yok list[str] 200 (varsayılan) src/cluster_erp/modules/logs/change_history/routes.py:65
GET /api/v1/logs/change-history/{record_id} get_change_history change_history.read yok yok ChangeHistoryRead 200 (varsayılan) src/cluster_erp/modules/logs/change_history/routes.py:74

Hata kodları

Tablo, src/cluster_erp/modules/logs/ altındaki kodun attığı hata kodlarını listeler. Kodlar, AppError(...) çağrıları, src/cluster_erp/core/errors.py içindeki fabrikalar (not_found, conflict, protected, permission_denied, privilege_escalation, check_version) ve HTTPException(...) için yapılan bir sözdizimi ağacı taramasıyla bulundu. 400 durumu AppError varsayılanıdır (src/cluster_erp/core/errors.py:23). Koruma hataları (401, 403), yetkilendirme kodları ve doğrulama hataları (422) her yol için geçerlidir ve Hatalar sayfasında listelenir.

Kod HTTP durumu Atıldığı yer İlk konum
RESOURCE_NOT_FOUND 404 activity_log, change_history, error_log src/cluster_erp/modules/logs/activity_log/routes.py:67

Yayımlanan olaylar

Tablo, src/cluster_erp/modules/logs/ altındaki kodun EventBus.emit çağrısına doğrudan verdiği sözleşme sınıflarını listeler; sözdizimi ağacı taramasıyla bulundu. Önce bir değişkene kurulan olaylar sayılmaz. Sözleşmeler Sözleşmeler başvurusu sayfasında anlatılır.

Tarama bir olay bulmadı.

İlgili sayfalar


92f8051 numaralı commit ile 2026-11-13 tarihinde doğrulandı.

Doğrulanan commit 92f8051 · 2026-11-13