GET /bpm-engine/api/process-definitions/{processDefinitionID}

Owned by Technische Redaktion
Dec 01, 2022
1 min read
As of Version

product version 2021 Autumn | component version 

Request MethodGET
Response FormatJSON
Description

Retrieves the process definitions specified by processDefinitionId.

Meaning of HTTP status codes:

HTTP Status CodeDescription
200The process definition was found and returned.
401The calling user is not authorized.
404The requested process specified by processDefinitionId was not found.
Request HeaderContent-Type: application/json
Request Example
https://<host>/bpm-engine/api/process-definitions/onesteptest_proc:1:00000000-0000-0000-0000-000000000001
Response Example
{
  "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
}