2. BPM Endpoints

The BPM service for enaio® is divided into two sections:

Normal endpoints without the need of special system roles for the calling user.
Administrative endpoints where the calling user need the system roles 20 (Workflow Administrator start) or 21 (Workflow Editor start)

On this page, the two sections are divided. First, there is an overview of the normal endpoints and afterward an overview about the administrative ones. Due to the extensive development of the webbased workflow administration tools, currently only a few normal endpoints and many administrative ones exist. We are continuously further developing the BPM service for enaio® and more normal endpoints will follow soon for enaio 12.0 and future versions.

Normal Endpoint Schema

Normal Endpoint Overview

HTTP Method	Endpoint	Description	Core	As of

HTTP Method	Endpoint	Description	Core	As of
GET	/api/bpm/organizations	Returns all organizations.	no	1.0.0

POST	/api/bpm/tasks/{id}	Performs an action on the specified task.	no	1.0.0
GET	/api/bpm/tasks/{id}/canditates	Returns all candidates for a task.	no	1.0.0
POST	/api/bpm/tasks/{id}/canditates	Sets a list of users and/or roles as the candidates of a running task.	no	1.0.0

GET	/api/bpm/dms/objects/{objectId}/processes	Returns all processes which contain a specified object in their files	no	1.3.0

GET	/api/bpm/routing-lists/templates	Returns ad hoc templates.	no	1.5.0

GET	/api/bpm/info	Retrieves basic information about platform and version.	no	1.0.0

Administrative Endpoint Schema

The following graphic shows all REST endpoints that are available in the BPM service API.

Administrative Endpoint Overview

HTTP Method	Endpoint	Description	Core	As of

HTTP Method	Endpoint	Description	Core	As of
GET	/api/bpm/process-definitions	Returns all process definitions.	no	1.0.0
POST	/api/bpm/process-definitions	Creates new process definition.	no	1.5.0
POST	/api/bpm/process-definitions/{id}/copy	Copies a process definition.	no	1.5.0
GET	/api/bpm/process-definitions/{id}/file	Returns a process definition.	no	1.5.0
PUT	/api/bpm/process-definitions/{id}/file	Updates a process definition.	no	1.6.0
DELETE	/api/bpm/process-definitions/{id}	Deletes a process definition.	no	1.5.0
PUT	/api/bpm/process-definitions/{id}/state	Changes a state of a workflow model.	no	1.5.0

GET	/api/bpm/families	Returns all families.	no	1.4.0
POST	/api/bpm/families	Creates new families.	no	1.4.0
PUT	/api/bpm/families/{id}	Updates a family.	no	1.4.0
DELETE	/api/bpm/families/{id}	Deletes a family.	no	1.4.0

POST	/api/bpm/organizations	Creates a new organization.	no	1.4.0
POST	/api/bpm/organizations/convert	Returns the export file converted to the current enaio format as an XML file download.	no	1.5.0
POST	/api/bpm/organizations/import	Imports organization.	no	1.5.0
GET	/api/bpm/organizations/{id}	Returns all objects that make up the organization structure.	no	1.0.0
DELETE	/api/bpm/organizations/{id}	Deletes an organization.	no	1.4.0
PATCH	/api/bpm/organizations/{id}	Updates an organization.	no	1.4.0
POST	/api/bpm/organizations/{id}/export	Returns the exported organization as an XML file.	no	1.5.0

GET	/api/bpm/processes	Returns all processes for the provided process definition.	no	1.0.0
PATCH	/api/bpm/processes	To suspend, cancel, resume, delete or unlock a batch of processes.	no	1.0.0
POST	/api/bpm/processes/report	Returns xml or csv file with detailed information about the specified processes.	no	1.4.0
GET	/api/bpm/processes/count	Returns counts of processes per state for the provided process definition.	no	1.4.0
GET	/api/bpm/processes/{id}	Returns essential information for the provided process – complete history, tasks, timers, inboxes	no	1.0.0
GET	/api/bpm/processes/{id}/history	Returns all activities processed by the specified user.	no	1.0.0
GET	/api/bpm/processes/{id}/activities	Returns all activities for the provided process.	no	1.0.0
GET	/api/bpm/processes/{id}/process-definition	Returns information for rendering the workflow graph.	no	1.0.0

POST	/api/bpm/tasks/{id}	Performs an action on the specified task.	no	1.0.0
GET	/api/bpm/tasks/{id}/history	Returns all history entries for a task.	no	1.0.0
GET	/api/bpm/tasks/{id}/variables	Returns all variables for a task or historical entry.	no	1.0.0
PUT	/api/bpm/tasks/{id}/variables	Updates to task variables.	no	1.0.0

GET	/api/bpm/timers/{id}/history	Returns all history entries for a timer.	no	1.0.0

GET	/api/bpm/db/tables	Returns information about the database tables	no	1.2.0
PATCH	/api/bpm/db/tables	To unlock a batch of tables.	no	1.2.0
GET	/api/bpm/queues	Returns all elements which are currently in worker queue.	no	1.2.0

GET	/api/bpm/statistics/report-configurations	Returns all report configurations.	no	1.4.0
POST	/api/bpm/statistics/report-configurations	Creates new statistics report configurations.	no	1.4.0
PUT	/api/bpm/statistics/report-configurations/{id}	Updates an existing statistics report configuration.	no	1.4.0
DELETE	/api/bpm/statistics/report-configurations/{id}	Deletes a statistics report configuration.	no	1.4.0
GET	/api/bpm/statistics/report-configurations/{id}/reports	Returns all reports for the provided configuration.	no	1.4.0
POST	/api/bpm/statistics/report-configurations/{id}/reports	Creates new reports for the provided configuration.	no	1.4.0

GET	/api/bpm/statistics/reports/{id}	Returns report data.	no	1.4.0
DELETE	/api/bpm/statistics/reports/{id}	Deletes a report.	no	1.4.0