GET /bpm-engine/api/process-definitions
As of Version | product version 2021 Autumn | component version | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request Method | GET | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Response Format | JSON | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Retrieves a list of process definitions matching the conditions defined in various query parameters. The following query parameters can optionally be added to the request URL.
Meaning of HTTP status codes:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Header | Content-Type: application/json | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Request Example | https://<host>/bpm-engine/api/process-definitions/?page=0&size=50&sort=desc&version=1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Response Example | { "objects": [ { "id": "follow-up:1:00000000-0000-0000-0000-000000000000", "category": "examplecategory", "key": "follow-up", "name": "Follow-up", "description": "Follow up any document (NOTE: The start-form enforces 1 parameter (expiryDateTime) and 1 optional parameter (whatAbout))", "version": 1, "global": false, "startFormDefined": true, "suspended": false }, { "id": "onesteptest_proc:1:00000000-0000-0000-0000-000000000001", "category": "exampleprocess", "key": "onesteptest_proc", "name": "One step test process", "description": null, "version": 1, "global": false, "startFormDefined": false, "suspended": false }, { "id": "twosteptest_proc:1:00000000-0000-0000-0000-000000000002", "category": "exampleprocess", "key": "twosteptest_proc", "name": "Process-definition-name: Two step test process", "description": "This is description from model editor (high level, not the visual editor of process). The first step goes to initiator, second to no one (can be played with id-links). There is one form reference (get group id) in the first task.", "version": 1, "global": false, "startFormDefined": false, "suspended": false } ], "numItems": 3, "totalNumItems": 3, "hasMoreItems": false } |