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

API

Owned organisations API (owned_organisations)

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

owned_organisations modülü şirketin kendi kuruluşlarını, departmanlarını, çalışanlarını ve çalışan görevlendirmelerini sunar. 28 uç noktanın tamamı /api/v1/owned_organisations altındadır. İş anlamı için Owned organisations modülü sayfasına bakın.

Grup olguları

Öğe Değer Kaynak
Temel yol /api/v1/owned_organisations src/cluster_erp/core/module_base.py:37-38, src/cluster_erp/modules/owned_organisations/module.py:49
Yönlendiriciler 3 dosyada 3 yönlendirici nesnesi; Uç nokta özeti bölümünde listelenir src/cluster_erp/modules/owned_organisations/module.py:35
Uç noktalar 28; register_routes ile bağlanan yönlendiricilerin yol dekoratörleri ve add_api_route çağrılarından sayıldı src/cluster_erp/modules/owned_organisations/departments/routes.py, src/cluster_erp/modules/owned_organisations/employees/routes.py, src/cluster_erp/modules/owned_organisations/organisations/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ı 28 yolun 28 tanesi require_permission bildirir src/cluster_erp/modules/auth/guards.py:205-240
Uygulama yetkilendirme kapısı bağlanan her yönlendiricide require_app("owned_organisations") src/cluster_erp/modules/owned_organisations/module.py:54
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ğı
organisations router (/organisations) 6 src/cluster_erp/modules/owned_organisations/organisations/routes.py:28
departments router (/departments) 7 src/cluster_erp/modules/owned_organisations/departments/routes.py:21
employees router 15 src/cluster_erp/modules/owned_organisations/employees/routes.py:35

Kuruluşlar uç noktaları

Kuruluş kayıtları.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
GET /api/v1/owned_organisations/organisations/ list_organisations organisation.read yok active_only, party_id list[OwnedOrganisationListRead] 200 (varsayılan) src/cluster_erp/modules/owned_organisations/organisations/routes.py:44
POST /api/v1/owned_organisations/organisations/ create_organisation organisation.create OwnedOrganisationCreate yok OwnedOrganisationRead 201 src/cluster_erp/modules/owned_organisations/organisations/routes.py:69
GET /api/v1/owned_organisations/organisations/{org_id} get_organisation organisation.read yok yok OwnedOrganisationRead 200 (varsayılan) src/cluster_erp/modules/owned_organisations/organisations/routes.py:81
PUT /api/v1/owned_organisations/organisations/{org_id} update_organisation organisation.update OwnedOrganisationUpdate yok OwnedOrganisationRead 200 (varsayılan) src/cluster_erp/modules/owned_organisations/organisations/routes.py:95
POST /api/v1/owned_organisations/organisations/bulk-delete bulk_delete_organisations organisation.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/owned_organisations/organisations/routes.py:110
DELETE /api/v1/owned_organisations/organisations/{org_id} delete_organisation organisation.delete yok yok yok 204 src/cluster_erp/modules/owned_organisations/organisations/routes.py:122

Departmanlar uç noktaları

Departman kayıtları ve bir kuruluşun departmanları.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
GET /api/v1/owned_organisations/departments/ list_all_departments department.read yok yok dict 200 (varsayılan) src/cluster_erp/modules/owned_organisations/departments/routes.py:37
GET /api/v1/owned_organisations/departments/by-org/{org_id} list_departments department.read yok yok list[DepartmentRead] 200 (varsayılan) src/cluster_erp/modules/owned_organisations/departments/routes.py:57
POST /api/v1/owned_organisations/departments/ create_department department.create DepartmentCreate yok DepartmentRead 201 src/cluster_erp/modules/owned_organisations/departments/routes.py:75
GET /api/v1/owned_organisations/departments/{dept_id} get_department department.read yok yok DepartmentRead 200 (varsayılan) src/cluster_erp/modules/owned_organisations/departments/routes.py:86
PUT /api/v1/owned_organisations/departments/{dept_id} update_department department.update DepartmentUpdate yok DepartmentRead 200 (varsayılan) src/cluster_erp/modules/owned_organisations/departments/routes.py:99
POST /api/v1/owned_organisations/departments/bulk-delete bulk_delete_departments department.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/owned_organisations/departments/routes.py:113
DELETE /api/v1/owned_organisations/departments/{dept_id} delete_department department.delete yok yok yok 204 src/cluster_erp/modules/owned_organisations/departments/routes.py:124

Çalışanlar ve görevlendirmeler uç noktaları

Çalışan kayıtları ve görevlendirmeler; kuruluşa, tarafa ve departmana göre okumalarla.

Yöntem Yol İşleyici Yetki İstek Sorgu Yanıt Durum Kaynak
GET /api/v1/owned_organisations/employees/ list_all_employees employee.read yok search, party_id, limit, offset list[EmployeeListRead] 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:42
POST /api/v1/owned_organisations/employees/ create_employee employee.create EmployeeCreate yok EmployeeRead 201 src/cluster_erp/modules/owned_organisations/employees/routes.py:65
GET /api/v1/owned_organisations/employees/{employee_id} get_employee employee.read yok yok EmployeeRead 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:81
PUT /api/v1/owned_organisations/employees/{employee_id} update_employee employee.update EmployeeUpdate yok EmployeeRead 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:98
POST /api/v1/owned_organisations/employees/bulk-delete bulk_delete_employees employee.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:117
DELETE /api/v1/owned_organisations/employees/{employee_id} delete_employee employee.delete yok yok yok 204 src/cluster_erp/modules/owned_organisations/employees/routes.py:129
GET /api/v1/owned_organisations/assignments/ list_assignments assignment.read yok party_id list[AssignmentListRead] 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:146
GET /api/v1/owned_organisations/assignments/by-org/{org_id} list_assignments_by_org assignment.read yok active_only list[AssignmentListRead] 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:161
GET /api/v1/owned_organisations/assignments/by-party/{party_id} list_assignments_by_party assignment.read yok yok list[AssignmentListRead] 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:174
GET /api/v1/owned_organisations/assignments/by-dept/{dept_id} list_assignments_by_dept assignment.read yok yok list[AssignmentListRead] 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:188
POST /api/v1/owned_organisations/assignments/ create_assignment assignment.create AssignmentCreate yok AssignmentRead 201 src/cluster_erp/modules/owned_organisations/employees/routes.py:200
GET /api/v1/owned_organisations/assignments/{assignment_id} get_assignment assignment.read yok yok AssignmentRead 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:216
PUT /api/v1/owned_organisations/assignments/{assignment_id} update_assignment assignment.update AssignmentUpdate yok AssignmentRead 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:234
POST /api/v1/owned_organisations/assignments/bulk-delete bulk_delete_assignments assignment.bulk_delete BulkDeleteRequest yok BulkDeleteResponse 200 (varsayılan) src/cluster_erp/modules/owned_organisations/employees/routes.py:253
DELETE /api/v1/owned_organisations/assignments/{assignment_id} delete_assignment assignment.delete yok yok yok 204 src/cluster_erp/modules/owned_organisations/employees/routes.py:265

Hata kodları

Tablo, src/cluster_erp/modules/owned_organisations/ 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 departments, employees, organisations src/cluster_erp/modules/owned_organisations/departments/routes.py:95
VALIDATION_ERROR 422 employees, organisations src/cluster_erp/modules/owned_organisations/employees/services.py:205

Yayımlanan olaylar

Tablo, src/cluster_erp/modules/owned_organisations/ 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
EmployeeAdded 1 src/cluster_erp/modules/owned_organisations/employees/services.py:232
OrganisationCreated 1 src/cluster_erp/modules/owned_organisations/organisations/services.py:103
OrganisationUpdated 1 src/cluster_erp/modules/owned_organisations/organisations/services.py:139
PartyRoleSet 2 src/cluster_erp/modules/owned_organisations/employees/services.py:94

İlgili sayfalar


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

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