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

Policy Schema

Schema-ID
policy
Collection
policies
Permissions
  • Lesenpolicy_view
  • Anlegenpolicy_create
  • Ändernpolicy_edit
  • Löschenpolicy_delete

Felder

Policy Schema

policies4 Permissions

Schema for Konzepte & Richtlinien (all 47 policy types)

titlestringerforderlich
1–500 Zeichen
policyTypestringerforderlich
Werte
CODE_OF_CONDUCTCOMPLIANCE_POLICYQUALITY_POLICYRISK_MANAGEMENT_POLICYWHISTLEBLOWING_POLICYDOCUMENT_CONTROL_POLICYISMS_POLICYACCESS_CONTROL_POLICYPASSWORD_POLICYCRYPTOGRAPHY_POLICYNETWORK_SECURITY_POLICYVULNERABILITY_MANAGEMENTPATCH_MANAGEMENTLOGGING_MONITORINGSSDLC_POLICYCLOUD_SECURITY_POLICYDATA_CLASSIFICATIONAI_USAGE_POLICYDATA_PROTECTION_POLICYDELETION_CONCEPT
policyVersionstringerforderlich

Document version, semver-style (e.g. "1.0.0"). Distinct from the system `version` optimistic-concurrency counter.

1–50 Zeichen
statusstringerforderlich
Werte
DRAFTIN_REVIEWAPPROVEDACTIVEARCHIVEDSUPERSEDED
sectionsobject[]erforderlich
Default: []
sectionKeystringerforderlich
titlestringerforderlich
contentstringerforderlich
isCompletebooleanerforderlich
ordernumbererforderlich
typedFieldsobjectoptional
nullable
authorIdstringoptional
nullable
reviewerIdsstring[]optional
Default: []
approverIdstringoptional
nullable
ownerDepartmentstringoptional
nullable
approvalCommentstringoptional
nullable
effectiveDatedatetimeoptional
nullable
reviewDatedatetimeoptional
nullable
expiryDatedatetimeoptional
nullable
reviewCycleMonthsnumberoptional
Default: 12
targetCustomerTenantIdstringoptional
nullable
dmsDocumentIdstringoptional
nullable
dmsFolderPathstringoptional
nullable
frameworkMappingsobject[]optional
Default: []
frameworkstringerforderlich
controlstringerforderlich
descriptionstringoptional
applicableScopesstring[]optional
Default: []
aiComplianceScorenumberoptional
0 – 100nullable
aiLastCheckeddatetimeoptional
nullable
aiFindingsobject[]optional
Default: []
severitystringerforderlich
Werte
HIGHMEDIUMLOWINFO
sectionKeystringoptional
codestringerforderlich
messagestringerforderlich
suggestionstringoptional
supersededByPolicyIdstringoptional
nullable
relatedPolicyIdsstring[]optional
Default: []
linkedRiskIdsstring[]optional
Default: []
linkedTomIdsstring[]optional
Default: []
linkedAssetIdsstring[]optional
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/policies — Liste, paginiert + filterbar
  • GET /api/v1/policies/<id> — Einzelne Entity
  • POST /api/v1/policies — Anlegen
  • PATCH /api/v1/policies/<id> — Teil-Update
  • DELETE /api/v1/policies/<id> — Soft-Delete
  • GET /api/v1/policies/<id>/timeline — Audit + Aktivitäten

Suche