records modülü kullanımdan kaldırma nedenlerini, genel kayıt yaşam döngüsünü (pasif liste, etiket çözümleme, yeniden etkinleştirme) ve saklama ayarlarını sunar. 10 uç noktanın tamamı /api/v1/records altındadır. İş anlamı için Records modülü sayfasına bakın.
Grup olguları¶
| Öğe | Değer | Kaynak |
|---|---|---|
| Temel yol | /api/v1/records |
src/cluster_erp/core/module_base.py:37-38, src/cluster_erp/modules/records/module.py:50 |
| Yönlendiriciler | 3 dosyada 3 yönlendirici nesnesi; Uç nokta özeti bölümünde listelenir | src/cluster_erp/modules/records/module.py:39 |
| Uç noktalar | 10; register_routes ile bağlanan yönlendiricilerin yol dekoratörleri ve add_api_route çağrılarından sayıldı |
src/cluster_erp/modules/records/deactivation_reasons/routes.py, src/cluster_erp/modules/records/lifecycle_routes.py, src/cluster_erp/modules/records/retention/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ı | 10 yolun 7 tanesi require_permission bildirir; diğer yollar korumalarını tablolarda gösterir |
src/cluster_erp/modules/auth/guards.py:205-240 |
| Uygulama yetkilendirme kapısı | register_routes içinde bağlanmaz |
src/cluster_erp/modules/records/module.py:50 |
| 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ğı |
|---|---|---|---|
deactivation_reasons |
router (/deactivation-reasons) |
5 | src/cluster_erp/modules/records/deactivation_reasons/routes.py:21 |
lifecycle_routes |
router |
3 | src/cluster_erp/modules/records/lifecycle_routes.py:32 |
retention |
router (/retention) |
2 | src/cluster_erp/modules/records/retention/routes.py:14 |
Kullanımdan kaldırma nedenleri uç noktaları¶
Kullanımdan kaldırma nedeni kayıtları.
| Yöntem | Yol | İşleyici | Yetki | İstek | Sorgu | Yanıt | Durum | Kaynak |
|---|---|---|---|---|---|---|---|---|
GET |
/api/v1/records/deactivation-reasons/ |
list_deactivation_reasons |
deactivation_reason.read |
yok | active_only, search |
dict |
200 (varsayılan) | src/cluster_erp/modules/records/deactivation_reasons/routes.py:24 |
GET |
/api/v1/records/deactivation-reasons/{reason_id} |
get_deactivation_reason |
deactivation_reason.read |
yok | yok | DeactivationReasonRead |
200 (varsayılan) | src/cluster_erp/modules/records/deactivation_reasons/routes.py:39 |
POST |
/api/v1/records/deactivation-reasons/ |
create_deactivation_reason |
deactivation_reason.create |
DeactivationReasonCreate |
yok | DeactivationReasonRead |
201 |
src/cluster_erp/modules/records/deactivation_reasons/routes.py:52 |
PUT |
/api/v1/records/deactivation-reasons/{reason_id} |
update_deactivation_reason |
deactivation_reason.update |
DeactivationReasonUpdate |
yok | DeactivationReasonRead |
200 (varsayılan) | src/cluster_erp/modules/records/deactivation_reasons/routes.py:64 |
DELETE |
/api/v1/records/deactivation-reasons/{reason_id} |
delete_deactivation_reason |
deactivation_reason.delete |
yok | yok | yok | 204 |
src/cluster_erp/modules/records/deactivation_reasons/routes.py:79 |
Kayıt yaşam döngüsü uç noktaları¶
Modül ve varlıkla anahtarlanan genel yollar: bir varlığın pasif kayıtları, pasifler dahil kimlikler için etiketler ve yeniden etkinleştirme. Her işleyici varlık adından kurulan bir yetki kodunu denetler ve assert_module_entitled çağırır (src/cluster_erp/modules/records/lifecycle_routes.py:125-130).
| Yöntem | Yol | İşleyici | Yetki | İstek | Sorgu | Yanıt | Durum | Kaynak |
|---|---|---|---|---|---|---|---|---|
GET |
/api/v1/records/{module}/{entity}/inactive |
list_inactive |
işleyicide {entity}.read |
yok | search, limit, offset |
dict |
200 (varsayılan) | src/cluster_erp/modules/records/lifecycle_routes.py:114 |
GET |
/api/v1/records/{module}/{entity}/labels |
resolve_labels |
işleyicide {entity}.read |
yok | ids |
dict |
200 (varsayılan) | src/cluster_erp/modules/records/lifecycle_routes.py:175 |
POST |
/api/v1/records/{module}/{entity}/{record_id}/activate |
activate |
işleyicide {entity}.delete |
yok | yok | dict |
200 (varsayılan) | src/cluster_erp/modules/records/lifecycle_routes.py:224 |
Saklama uç noktaları¶
Saklama ayarlarının okunması ve güncellenmesi.
| Yöntem | Yol | İşleyici | Yetki | İstek | Sorgu | Yanıt | Durum | Kaynak |
|---|---|---|---|---|---|---|---|---|
GET |
/api/v1/records/retention/ |
get_retention |
retention_config.read |
yok | yok | RetentionConfigRead |
200 (varsayılan) | src/cluster_erp/modules/records/retention/routes.py:17 |
PUT |
/api/v1/records/retention/ |
update_retention |
retention_config.update |
RetentionConfigUpdate |
yok | RetentionConfigRead |
200 (varsayılan) | src/cluster_erp/modules/records/retention/routes.py:27 |
Hata kodları¶
Tablo, src/cluster_erp/modules/records/ 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 |
|---|---|---|---|
AUTH_PERMISSION_DENIED |
403 |
lifecycle_routes |
src/cluster_erp/modules/records/lifecycle_routes.py:84 |
RESOURCE_NOT_FOUND |
404 |
deactivation_reasons, lifecycle_routes |
src/cluster_erp/modules/records/deactivation_reasons/routes.py:48 |
Yayımlanan olaylar¶
Tablo, src/cluster_erp/modules/records/ 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.
| Sözleşme | Konum sayısı | İlk konum |
|---|---|---|
RecordActivated |
1 | src/cluster_erp/modules/records/lifecycle_routes.py:260 |
İlgili sayfalar¶
92f8051 numaralı commit ile 2026-11-13 tarihinde doğrulandı.