External Flow Endpoints

Init external flow

POST /api/v2/session/{sessionId}/externalflow/init

{"configurationId": "{configurationId}}"

Description

Initialises the external container component on the HOST runtime.

URL Segment	Expected Type	Description
sessionId	AquimaSession	Session for which the external container was expanded.

The body must be a JSON containing the configuration ID of type string

If successful, status 200 OK and :

{
	"configurationId" : "123-456-789"
}

POST /api/v2/externalflow/start

{"configurationId": "{configurationId}}"

Description

Starts the external flow container on the TARGET runtime.

A JSON containing the configuration ID of type string.

If successful, status 200 OK and :

{
	"sessionId" : "123-456-789"
}

POST /api/v2/session/{sessionId}/externalflow/{configurationId}/complete

Description

Completes the external flow and executes the mapping between the interface and source profile.

URL Segment	Expected Type	Description
sessionId	AquimaSession	The Id of the AquimaSession from the host runtime.
configurationId	string	Unique id for the external container configuration.

If successful, status 200 OK and :

{
   "events": [
      {
       	"sessionId": <sessionId>,
     	"changes": {"changes": []},
      	"type": "page"
      }, 
	  ...
	]
}

POST /api/v2/session/{sessionId}/externalflow/{configurationId}/end

Description

Closes the external session

URL Segment	Expected Type	Description
sessionId	AquimaSession	The Id of the AquimaSession from the target runtime.
configurationId	string	Unique id for the external container configuration.

If successful, status code 200 OK

The