Process definitions
The Process Orchestration APIs are currently available as a Non-Production Preview (NPP) feature and are not available to all clients. For more information, see Process Orchestration.
Process Definitions store the BPMN and DMN files that encode your orchestration logic. This API supports retrieving, searching, and deleting deployed definitions. Uploading a new definition and managing the maker-checker approval workflow — where a Maker uploads a definition and a different Checker must approve it before it becomes current — is handled by the Staged Process Definitions API.
Both BPMN (process flow) and DMN (decision table) files go through the same staged upload and approval flow — there is no separate endpoint for DMN files.
Definition lifecycle
Upload (POST /stagedprocessdefinitions) → PENDING_APPROVAL → [Approve] → APPROVED → [Make current] → CURRENT
→ [Reject] → REJECTED
A definition must be made current before it can be started or linked to a CBE extension point. See the Staged Process Definitions API for the upload, approve, make-current, and reject endpoints.
Endpoint summary
| Method | Path | Description |
|---|---|---|
GET | /processdefinitions/{key} | Get a specific definition (latest current version) |
GET | /processdefinitions/{key}/{version} | Get a specific version of a definition |
POST | /processdefinitions:search | Search process definitions |
DELETE | /processdefinitions/{key} | Delete all versions of a definition |
Uploading a definition
Definitions are uploaded through the Staged Process Definitions API as a raw binary body — multipart/form-data is not supported:
POST /api/stagedprocessdefinitions
Accept: application/vnd.mambu.v2+json
Content-Type: application/octet-stream
Authorization: Basic <base64-encoded username:password>
[raw BPMN or DMN file bytes]
The response contains a numeric staged definition id — use it for the :approve, :make-current, and :reject calls on the Staged Process Definitions API.
Deletion constraint
DELETE removes all versions of a process definition by key. It fails with 409 Conflict if any active process instances still reference the definition — cancel or complete them first.