Init external flow
| Code Block |
|---|
|
POST /api/v2/session/{sessionId}/externalflow/init
{"configurationId": "{configurationId}}" |
Description
Initialises the external container component on the HOST runtime.
Parameters
| 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
Example Response
If successful, status 200 OK and :
| Code Block |
|---|
{
"configurationId" : "123-456-789"
} |
Start external flow
| Code Block |
|---|
|
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 :
| Code Block |
|---|
{
"sessionId" : "123-456-789"
} |
Complete external flow
| Code Block |
|---|
|
POST /api/v2/session/{sessionId}/externalflow/{configurationId}/complete |
Description
Completes the external flow and executes the mapping between the interface and source profile. This endpoint should be called on the HOST runtime.
Parameters
| URL Segment | Expected Type | Description |
|---|
| sessionId | AquimaSession | The Id of the AquimaSession from the host runtime. |
| configurationId | string | Unique id for the external flow container configuration. |
Example Response
If successful, status 200 OK and :
| Code Block |
|---|
{
"events": [
{
"sessionId": <sessionId>,
"changes": {"changes": []},
"type": "page"
},
...
]
} |
End external flow
| Code Block |
|---|
|
POST /api/v2/session/{sessionId}/externalflow/{configurationId}/end |
Description
Closes the external session. This endpoint should be called on the TARGET runtime.
Parameters
| URL Segment | Expected Type | Description |
|---|
| sessionId | AquimaSession | The Id of the AquimaSession from the target runtime. |
| configurationId | string | Unique id for the external flow container configuration. |
Response
If successful, status code 200 OK