Theme switcher

Get the data structure of a node

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)

Path Parameters

processIdstring Required

processId of the definition.

versionstring Required

Version of the definition.

uniqueIdstring Required

BPMN element id of the node (uniqueId from the nodes list).

Response

200
Object

nodeId, nodeName, input and output template.

Response Attributes

nodeIdstring
nodeNamestring
inputobject

Show child attributes

outputobject

Show child attributes

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

Node not found or definition not readable.

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?