API-Schnittstellen in Ventoo Case Management

Ventoo Case Management stellt zwölf API-Seiten für die Integration mit externen Systemen bereit (z. B. externe Anmeldesysteme, Diagnosewerkzeuge oder eigene Portale).

Endpunkt

Die APIs folgen dem Business-Central-Standard für benutzerdefinierte APIs:

Merkmal	Wert
Publisher	`ventoo`
Group	`caseManagement`
Version	`v1.0`

Der Basispfad lautet damit:

/api/ventoo/caseManagement/v1.0/<entitySet>

Beispiel: /api/ventoo/caseManagement/v1.0/cases

Authentifizierung und Aufruf erfolgen wie bei allen BC-APIs (OAuth). Der Zugriff unterliegt den BC-Berechtigungssätzen der App.

Verfügbare Entitäten

Entitätsmenge	Entität	Methoden
`cases`	Fall	GET, POST, PATCH
`engagements`	Mandat	GET, POST, PATCH
`scopes`	Leistungsumfang	GET, POST, PATCH
`scopeSchemas`	Leistungsschema	GET, POST, PATCH
`activities`	Aktivität	GET, POST, PATCH
`tasks`	Aufgabe	GET, POST, PATCH
`parties`	Beteiligter	GET, POST, PATCH
`relationships`	Beziehung	GET, POST, PATCH
`roles`	Rolle	GET, POST, PATCH
`attributes`	Attribut	GET (nur Lesen)
`attributeValues`	Attributwert	GET, POST, PATCH
`caseLedgerEntries`	Fallposten	GET (nur Lesen)

Die genauen unterstützten Methoden je Seite ergeben sich aus deren Einstellungen (z. B. ist das Löschen auf mehreren Seiten deaktiviert, attributes und caseLedgerEntries sind schreibgeschützt). Fallposten sind ein gebuchtes Ledger und daher lesend.

Typische Anwendungsfälle

Fallanlage von aussen – Ein externes Anmeldesystem legt Fälle mit Beteiligten und Leistungsumfang direkt per API an.
Zeit- und Ergebnis-Rückfluss – Ein Diagnose-/Fremdwerkzeug schreibt Aktivitäten und Attributwerte auf bestehende Fälle zurück.
Auswertung – Fallposten werden lesend abgezogen, um Kennzahlen in einem externen System darzustellen.

Für kundenspezifische Integrationen bietet die App zusätzlich Integrationsevents an wichtigen Stellen (Fallerstellung, Statuswechsel, Buchung), an die sich mandantenspezifische Erweiterungen anhängen können.