You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Init external flow 

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

{"configurationId": "{configurationId}}"

Description

Initialises the external container component on the HOST runtime.

Parameters

URL SegmentExpected TypeDescription
sessionIdAquimaSessionSession for which the external container was expanded.

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

URL SegmentExpected TypeDescription
sessionIdAquimaSessionThe Id of the AquimaSession from the host runtime.  
configurationIdstringUnique id for the external container configuration.

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

URL SegmentExpected TypeDescription
sessionIdAquimaSessionThe Id of the AquimaSession from the target runtime.  
configurationIdstringUnique id for the external container configuration.

Response

If successful, status code 200 OK

The

  • No labels