Get Process Diagram
Retrieves the diagram of a process definition.
If the process definition’s deployment contains an image resource with the same file name as the process definition, the deployed image will be returned by the Get Diagram endpoint. Example: someProcess.bpmn and someProcess.png. Supported file extentions for the image are: svg, png, jpg, and gif.
Method
GET /process-definition/{id}/diagram
GET /process-definition/key/{key}/diagram (returns the diagram for the latest version of the process definition which belongs to no tenant)
GET /process-definition/key/{key}/tenant-id/{tenant-id}/diagram (returns the diagram for the latest version of process definition for tenant)
Parameters
Path Parameters
| Name | Description |
|---|---|
| id | The id of the process definition. |
| key | The key of the process definition (the latest version thereof) to be retrieved. |
| tenant-id | The id of the tenant the process definition belongs to. |
Result
The image diagram of this process.
Response Codes
| Code | Media type | Description |
|---|---|---|
| 200 | image/png, image/gif, ... (defaults to application/octet-stream if the file suffix is unknown | Request successful. |
| 204 | The process definition doesn't have an associated diagram. | |
| 404 | application/json | Process definition with given id or key does not exist. See the Introduction for the error response format. |
Example
Request
GET /process-definition/invoice:1:9f86d61f-9ee5-11e3-be3b-606720b6f99c/diagram
GET /process-definition/key/invoice/diagram