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

Init external flow 

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

{"configurationId": "{configurationId}}"

Description

Initialize the external container component on the HOST runtime.

Parameters

URL SegmentExpected TypeDescription
sessionIdAquimaSession(HOST) session for which the external container was expanded.

Request body

JSON containing property name configurationId with a value of type string.

Example response

If successful, status 200 OK and response body: 

{
	"configurationId" : "123-456-789"
	"baseUrl" : <optional absolute or relative URL to TARGET Runtime>
}

Start external flow 

POST /api/v2/externalflow/start

{"configurationId": "{configurationId}}"

Description

Start the external flow container on the TARGET runtime.

Parameters

None

Request body

JSON containing property name configurationId with a value of type string.

Example response

If successful, status 200 OK and response body: 

{
	"sessionId" : <id of the TARGET session>
}

Complete external flow 

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

Description

Complete the external flow and execute the mapping between the interface and source profile. This endpoint should be called on the HOST runtime.

Parameters

URL SegmentExpected TypeDescription
sessionIdAquimaSessionThe Id of the AquimaSession from the HOST runtime.  
configurationIdstringAutomatically generated unique id for the external flow container configuration.

Request body

{
   "parameters": {
     <param1_name>: ["value1","value2"]
   },
   "elementKey": <elementKey>,
   "fields": [
     {
       "key": <key>,
       "values": ["value1", "value2"]
     }
   ]
}


Example response

If successful, status 200 OK and response body: 

{
   "events": [
      {
       	"sessionId": <id of the HOST session>,
     	"changes": {"changes": []},
      	"type": "page"
      }, 
	  ...
	]
}

End external flow 

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

Description

Close the external session. This endpoint should be called on the TARGET runtime.

Parameters

URL SegmentExpected TypeDescription
sessionIdAquimaSessionThe Id of the AquimaSession from the TARGET runtime.  
configurationIdstringAutomatically generated unique id for the external flow container configuration.

Request body

None

Response

If successful, status code 200 OK

The