Flow API

Flow is a special case of HTTP proxy functionality used for the connection with the process engines IGUASU and INUBIT. This API provides endpoints to make GET, POST, PUT and DELETE requests using these specialized proxies.

Method Endpoint

Method	Endpoint
`GET`	`/cxf/bpc-flow/flow/{instanceId}\{targetPath: (/.*)?}`
Description Perform an HTTP GET on the given flow instance.
Path Parameter `instanceId` the id of the flow instance `targetPath` the path to call on the Flow system
Query Parameter `targetUrl` optional URL parameter. Function equals targetPath
Returns The response of the called Flow system
Required Access Rights A logged in user or API Key is required.
`POST`	`/cxf/bpc-flow/flow/{instanceId}\{targetPath: (/.*)?}`
Description Perform an HTTP POST on the given flow instance.
Path Parameter `instanceId` the id of the flow instance `targetPath` the path to call on the Flow system
Query Parameter `targetUrl` optional URL parameter. Function equals targetPath
Returns The response of the called Flow system
Required Access Rights A logged in user or API Key is required.
`PUT`	`/cxf/bpc-flow/flow/{instanceId}\{targetPath: (/.*)?}`
Description Perform an HTTP PUT on the given flow instance.
Path Parameter `instanceId` the id of the flow instance `targetPath` the path to call on the Flow system
Query Parameter `targetUrl` optional URL parameter. Function equals targetPath
Returns The response of the called Flow system
Required Access Rights A logged in user or API Key is required.
`DELETE`	`/cxf/bpc-flow/flow/{instanceId}\{targetPath: (/.*)?}`
Description Perform an HTTP DELETE on the given flow instance.
Path Parameter `instanceId` the id of the flow instance `targetPath` the path to call on the Flow system
Query Parameter `targetUrl` optional URL parameter. Function equals targetPath
Returns The response of the called Flow system
Required Access Rights A logged in user or API Key is required.

GET

/cxf/bpc-flow/flow/{instanceId}\{targetPath: (/.*)?}

Description

Perform an HTTP GET on the given flow instance.

Path Parameter