Page Status: draft updated 2025-01-10
Special operations
Page index
Introduction
OperationDefinition resources are used to define special operations and named queries.
Operations can execute on three different levels:
- system level (
POST or GET [base]/[operation]), - resource type level (
POST or GET [base]/[resource]/[operation]) or - instance level (
POST or GET [base]/[resource]/[id]/[operation]).
It is specified on each OperationDefinition on what level and what, if any, resource it can be used on. It is also specified on each resource in the guide if there are any special operations available for that resource.
Defined operations
| Operation | Level | Resource |
|---|---|---|
| $organizational-units-with-business | Resource type ([base]/Organization/$organizational-units-with-business) |
Resource: HVOOrganizationalUnitsWithBusiness, Implementation Guide: HVOOrganizationalUnit |
| $organizational-units-with-business-by-id | Instance ([base]/Organization/[id]/$organizational-units-with-business-by-id) |
Resource: HVOOrganizationalUnitsWithBusinessById, Implementation Guide: HVOOrganizationalUnit |