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

DMS Annotation Schema

Schema-ID
dms_annotation
Collection
dms_annotations
Permissions
  • Lesendms_annotation_view
  • Anlegendms_annotation_create
  • Änderndms_annotation_edit
  • Löschendms_annotation_delete

Felder

DMS Annotation Schema

dms_annotations4 Permissions

Schema for validating DMS PDF annotations (PDF-Annotationen)

documentIduuiderforderlich

Reference to dms_document

pageNumbernumbererforderlich

Page number (1-based)

≥ 1
typestringerforderlich

Annotation type

Werte
HIGHLIGHTCOMMENTSTAMPSIGNATUREFREEHANDRECTANGLE
contentstringoptional

Text content (for COMMENT type)

nullable
positionobjecterforderlich
xnumbererforderlich

X position (percentage 0-100)

ynumbererforderlich

Y position (percentage 0-100)

widthnumbererforderlich

Width (percentage 0-100)

heightnumbererforderlich

Height (percentage 0-100)

colorstringoptional

Color in hex (e.g. #FFFF00)

nullable
opacitynumberoptional
0 – 1Default: 1nullable
stampTypestringoptional

Stamp type (only for STAMP annotations)

Werte
APPROVEDREJECTEDDRAFTCONFIDENTIALCUSTOM
nullable
stampTextstringoptional

Custom stamp text (only for CUSTOM stampType)

nullable
freehandPathstringoptional

SVG path data for FREEHAND annotations

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

Suche