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.

Parameters

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

Example Response

If successful, status 200 OK and : 

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

Start external flow 

POST /api/v2/externalflow/start

{"configurationId": "{configurationId}}"

Description

Starts the external flow container on the TARGET runtime.

Parameters

A JSON containing the configuration ID of type string.

Example Response

If successful, status 200 OK and : 

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

Complete external flow 

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

Description

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

Parameters

Example Response

If successful, status 200 OK and : 

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

End external flow 

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

Description

Closes the external session

Parameters

Response

If successful, status code 200 OK