GET /api-web/api/bpm/process-definitions

As of Version

product version 2022 Spring | component version

Request Method GET

Response Format JSON

Description

Retrieves the process definitions a user is allowed to use to start a process.

This Web-API request uses the internal BPM-engine request GET /bpm-engine/api/process-definitions.

Parameter	Type	Description
`latest`	boolean	Returns only the latest process definition versions. Default is `true`.
`page`	integer($int32)	Result page you want to retrieve (0…N). Default is `0` which means the first page.
`size`	integer($int32)	Number of objects per page. Default is 20.

The response body contains a list of process instance data embedded in a JSON structure.

Response HTTP status codes:

HTTP Status Code	Meaning
`200`	The request was successful and the process instances are returned.
`400`	A parameter was passed in the wrong format. The status message contains additional information.

Request Example

https://<host>/api-web/api/bpm/process-definitions?latest=true&page=0&size=3

No request body

Response Example

200 OK

response body

{
  "objects": [
    {
      "id": "dms-lite-adhoc:1:9689a57f-2cf7-11ec-84cf-867d35831bc9",
      "category": "http://www.flowable.org/processdef",
      "key": "dms-lite-adhoc",
      "name": "DMS Lite Adhoc Workflow v1",
      "description": "DMS Lite Ad-Hoc Workflow",
      "version": 1,
      "global": false,
      "startFormDefined": true,
      "suspended": false
    },
    {
      "id": "dms-lite-standard:1:889414e6-ff4e-11eb-97f3-86f2decdc2b4",
      "category": "http://www.flowable.org/processdef",
      "key": "dms-lite-standard",
      "name": "DMS Lite Standard Workflow",
      "description": "DMS Lite Taskflow",
      "version": 1,
      "global": false,
      "startFormDefined": false,
      "suspended": false
    },
    {
      "id": "dms-lite-taskflow:1:9689a57e-2cf7-11ec-84cf-867d35831bc9",
      "category": "http://www.flowable.org/processdef",
      "key": "dms-lite-taskflow",
      "name": "DMS Lite Taskflow",
      "description": "DMS Lite Taskflow",
      "version": 1,
      "global": false,
      "startFormDefined": false,
      "suspended": false
    }
  ],
  "numItems": 3,
  "totalNumItems": 3,
  "hasMoreItems": false
}