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

Compliance Requirement Schema

Schema-ID
compliance_requirement
Collection
compliance_requirements
Permissions
  • Lesencompliance_requirement_view
  • Anlegencompliance_requirement_create
  • Änderncompliance_requirement_edit
  • Löschencompliance_requirement_delete

Felder

Compliance Requirement Schema

compliance_requirements4 Permissions

Schema for validating compliance requirement entities within a framework

frameworkIduuiderforderlich

Parent compliance framework UUID

parentIduuidoptional

Parent requirement UUID (for tree structure)

nullable
referenceIdstringerforderlich

Official reference ID (e.g. "A.5.1", "ORP.1.A1", "Art. 21(2)(a)")

1–100 Zeichen
titlestringerforderlich

Requirement title

1–500 Zeichen
descriptionstringoptional

Requirement description (own wording, not copied from standard)

nullable
guidancestringoptional

Implementation guidance (own wording)

nullable
levelnumberoptional

Depth in the tree (0 = root category)

0 – 10Default: 0
sortOrdernumberoptional

Sort order among siblings

Default: 0
isCategorybooleanoptional

True = grouping node, not an assessable requirement

Default: false
prioritystringoptional

Requirement priority level

Werte
CRITICALHIGHMEDIUMLOW
nullable
tagsstring[]optional

Requirement 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_requirements — Liste, paginiert + filterbar
  • GET /api/v1/compliance_requirements/<id> — Einzelne Entity
  • POST /api/v1/compliance_requirements — Anlegen
  • PATCH /api/v1/compliance_requirements/<id> — Teil-Update
  • DELETE /api/v1/compliance_requirements/<id> — Soft-Delete
  • GET /api/v1/compliance_requirements/<id>/timeline — Audit + Aktivitäten

Suche