API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · compliance_frameworks

Compliance Framework Schema

Schema-ID
compliance_framework
Collection
compliance_frameworks
Permissions
  • Lesencompliance_framework_view
  • Anlegencompliance_framework_create
  • Änderncompliance_framework_edit
  • Löschencompliance_framework_delete

Felder

Compliance Framework Schema

compliance_frameworks4 Permissions

Schema for validating compliance framework entities

titlestringerforderlich

Framework title

1–500 Zeichen
shortNamestringerforderlich

Short machine-readable name (unique per tenant)

1–100 ZeichenPattern
descriptionstringoptional

Framework description

nullable
frameworkVersionstringoptional

Framework version (e.g. "2022", "2023-Q4")

max 50 Zeichennullable
localestringoptional

Primary locale of the framework content

Werte
deen
Default: "de"
categorystringoptional

Framework category

Werte
INFORMATION_SECURITYDATA_PROTECTIONRISK_MANAGEMENTBUSINESS_CONTINUITYINDUSTRY_SPECIFICOPERATIONAL_RESILIENCEOTHER
nullable
publisherstringoptional

Publishing organization (e.g. "ISO", "BSI", "EU")

max 200 Zeichennullable
publicUrlstringoptional

Link to official source

nullable
statusstringerforderlich

Framework status

Werte
DRAFTACTIVEDEPRECATEDARCHIVED
isSystemTemplatebooleanoptional

True if platform-provided (read-only for tenants)

Default: false
importedFromTemplateIduuidoptional

ID of the system template this was cloned from

nullable
requirementCountnumberoptional

Denormalized count of requirements (protected)

Default: 0read-only
tagsstring[]optional

Framework tags

Default: []

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/compliance_frameworks — Liste, paginiert + filterbar
  • GET /api/v1/compliance_frameworks/<id> — Einzelne Entity
  • POST /api/v1/compliance_frameworks — Anlegen
  • PATCH /api/v1/compliance_frameworks/<id> — Teil-Update
  • DELETE /api/v1/compliance_frameworks/<id> — Soft-Delete
  • GET /api/v1/compliance_frameworks/<id>/timeline — Audit + Aktivitäten

Suche