Theme switcher

Get process structure data

Header Parameters

Authorizationstring

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

filterstring

Only for type=nodes: comma-separated list of node types, case-insensitive.

Path Parameters

processIdstring Required

processId of the definition. For type=diagram the processInstanceId of the instance.

versionstring Required

Version of the definition.

typestring Required
  • data: start data template
  • nodes: nodes of the definition
  • diagram: SVG diagram of an instance
Enum values:
datanodesdiagram

Response

200
Object

Result depending on type: object (data), EccProcessNode[] (nodes) or SVG string (diagram).

Response Attributes

purchaseobject

Show child attributes

object

Show child attributes

responsestring
400
Object

Unknown type.

Response Attributes

successboolean

true for 2xx responses, false for errors.

httpStatusinteger

HTTP status code, same as the response status.

httpStatusReasonPhrasestring

HTTP reason phrase.

messageCodestring

Message code for application errors with a defined code (EccException), e.g. EAP0001.

messagestring

Message text. Localized for coded application errors, otherwise the technical exception message.

dataTypestring

Simple class name of the error or its data (errors only).

datastring

Payload. Type depends on the endpoint. For coded application errors the EccException.

401
Object

Missing, invalid or expired access token.

Response Attributes

successboolean

true for 2xx responses, false for errors.

httpStatusinteger

HTTP status code, same as the response status.

httpStatusReasonPhrasestring

HTTP reason phrase.

messageCodestring

Message code for application errors with a defined code (EccException), e.g. EAP0001.

messagestring

Message text. Localized for coded application errors, otherwise the technical exception message.

dataTypestring

Simple class name of the error or its data (errors only).

datastring

Payload. Type depends on the endpoint. For coded application errors the EccException.

403
Object

Not Allowed

500
Object

Unexpected error, e.g. the BPM engine or MongoDB is not reachable. The message contains the cause.

Response Attributes

successboolean

true for 2xx responses, false for errors.

httpStatusinteger

HTTP status code, same as the response status.

httpStatusReasonPhrasestring

HTTP reason phrase.

messageCodestring

Message code for application errors with a defined code (EccException), e.g. EAP0001.

messagestring

Message text. Localized for coded application errors, otherwise the technical exception message.

dataTypestring

Simple class name of the error or its data (errors only).

datastring

Payload. Type depends on the endpoint. For coded application errors the EccException.

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?