API endpoints in Ventoo Case Management

Ventoo Case Management provides twelve API pages for integration with external systems (e.g. external registration systems, diagnostic tools, or custom portals).

Endpoint

The APIs follow the Business Central standard for custom APIs:

Attribute	Value
Publisher	`ventoo`
Group	`caseManagement`
Version	`v1.0`

The base path is therefore:

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

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

Authentication and calls work as with all BC APIs (OAuth). Access is subject to the app's BC permission sets.

Available entities

Entity set	Entity	Methods
`cases`	Case	GET, POST, PATCH
`engagements`	Engagement	GET, POST, PATCH
`scopes`	Scope	GET, POST, PATCH
`scopeSchemas`	Scope Schema	GET, POST, PATCH
`activities`	Activity	GET, POST, PATCH
`tasks`	Task	GET, POST, PATCH
`parties`	Party	GET, POST, PATCH
`relationships`	Relationship	GET, POST, PATCH
`roles`	Role	GET, POST, PATCH
`attributes`	Attribute	GET (read-only)
`attributeValues`	Attribute Value	GET, POST, PATCH
`caseLedgerEntries`	Case Ledger Entry	GET (read-only)

The exact methods supported per page follow from their settings (e.g. delete is disabled on several pages; attributes and caseLedgerEntries are read-only). Case ledger entries are a posted ledger and therefore read-only.

Typical use cases

External case creation – an external registration system creates cases with parties and scope directly via API.
Time and result feedback – a diagnostic/third-party tool writes activities and attribute values back onto existing cases.
Evaluation – case ledger entries are read out to present metrics in an external system.

For tenant-specific integrations, the app additionally offers integration events at key points (case creation, status change, posting) to which tenant-specific extensions can attach.