Get process structure data
Header Parameters
Keycloak access token (OAuth2). Replace [HOST] and [YOUR_REALM] with the values of your installation. OAuth2 flows: Implicit (authorization URL: https://[HOST]/realms/[YOUR_REALM]/protocol/openid-connect/auth)
Query Parameters
Only for type=nodes: comma-separated list of node types, case-insensitive.
Path Parameters
processId of the definition. For type=diagram the processInstanceId of the instance.
Version of the definition.
data: start data templatenodes: nodes of the definitiondiagram: SVG diagram of an instance
datanodesdiagramResponse
Result depending on type: object (data), EccProcessNode[] (nodes) or SVG string (diagram).
Response Attributes
Show child attributes
Show child attributes
Unknown type.
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.
Missing, invalid or expired access token.
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.
Not Allowed
Unexpected error, e.g. the BPM engine or MongoDB is not reachable. The message contains the cause.
Response Attributes
true for 2xx responses, false for errors.
HTTP status code, same as the response status.
HTTP reason phrase.
Message code for application errors with a defined code (EccException), e.g. EAP0001.
Message text. Localized for coded application errors, otherwise the technical exception message.
Simple class name of the error or its data (errors only).
Payload. Type depends on the endpoint. For coded application errors the EccException.