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

Report Schema

Schema-ID
report
Collection
reports
Permissions
  • Lesenreport_view
  • Anlegenreport_create
  • Ändernreport_edit
  • Löschenreport_delete

Felder

Report Schema

reports4 Permissions

Schema for validating GRC report entities

titlestringerforderlich

Report title

1–500 Zeichen
reportTypestringerforderlich

Type of report

Werte
GOBD_STATUSVERFAHRENSDOKUMENTATIONHASH_CHAIN_VERIFICATIONRETENTION_ADHERENCEACCESS_AUDITSIGNATURE_STATUSTAX_AUDITOR_EXPORTRISK_REGISTERRISK_MATRIXCOMPLIANCE_POSTUREGAP_ANALYSISPROCESSING_ACTIVITIES_REGISTERTOM_DOCUMENTATIONINCIDENT_REPORTBREACH_NOTIFICATION_LOGAUDIT_EXECUTIVE_SUMMARYVENDOR_RISK_OVERVIEWCUSTOM
statusstringerforderlich

Report generation status

Werte
PENDINGGENERATINGCOMPLETEDFAILED
dateFromdatetimeoptional

Report period start date

nullable
dateTodatetimeoptional

Report period end date

nullable
frameworkstringoptional

Compliance framework (e.g. ISO 27001, BSI IT-Grundschutz)

nullable
partyIduuidoptional

Associated party UUID

nullable
summaryobjectoptional

Report summary data

nullable
findingsobject[]optional

Report findings

Default: []
severitystringerforderlich

Finding severity

codestringerforderlich

Finding code

messagestringerforderlich

Finding message

detailsstringoptional

Finding details

nullable
entityIdstringoptional

Related entity UUID

nullable
entityTypestringoptional

Related entity type

nullable
contentMarkdownstringoptional

Report content in Markdown

nullable
s3Keystringoptional

S3 key for generated report file

nullable
fileNamestringoptional

Generated report file name

nullable
fileSizeBytesnumberoptional

File size in bytes

nullable
hashChainValidbooleanoptional

Whether the hash chain is valid

nullable
lastVerifiedHashstringoptional

Last verified hash value

nullable
brokenChainAtdatetimeoptional

Timestamp where hash chain broke

nullable
metricsobjectoptional

Report metrics

nullable
totalControlsnumberoptional

Total number of controls

implementedControlsnumberoptional

Number of implemented controls

compliancePercentagenumberoptional

Compliance percentage

openRisksnumberoptional

Number of open risks

criticalRisksnumberoptional

Number of critical risks

openFindingsnumberoptional

Number of open findings

overdueActionsnumberoptional

Number of overdue actions

trendComparedToPreviousnumberoptional

Trend compared to previous report (percentage change)

nullable
startedAtdatetimeoptional

When report generation started

nullable
completedAtdatetimeoptional

When report generation completed

nullable
errorMessagestringoptional

Error message if generation failed

nullable

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

Suche