Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
Clarified whether a host or target session is meant
Init external flow
Code Block | ||
---|---|---|
| ||
POST /api/v2/session/{sessionId}/externalflow/init {"configurationId": "{configurationId}}" |
Description
Initialize the external container component on the HOST runtime.
Parameters
URL Segment | Expected Type | Description |
---|---|---|
sessionId | AquimaSession | Session (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:
Code Block |
---|
{
"configurationId" : "123-456-789"
"baseUrl" : <optional absolute or relative URL to TARGET Runtime>
} |
Start external flow
Code Block | ||
---|---|---|
| ||
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:
Code Block |
---|
{ "sessionId" : "123-456-789" <id of the TARGET session> } |
Complete external flow
Code Block | ||
---|---|---|
| ||
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 Segment | Expected Type | Description |
---|---|---|
sessionId | AquimaSession | The Id of the AquimaSession from the host HOST runtime. |
configurationId | string | Automatically generated unique id for the external flow container configuration. |
Request body
Code Block |
---|
{ "parameters": { <param1_name>: ["value1","value2"] }, "elementKey": <elementKey>, "fields": [ { "key": <key>, "values": ["value1", "value2"] } ] } |
Example response
If successful, status 200 OK and response body:
Code Block |
---|
{ "events": [ { "sessionId": <sessionId> <id of the HOST session>, "changes": {"changes": []}, "type": "page" }, ... ] } |
End external flow
Code Block | ||
---|---|---|
| ||
POST /api/v2/session/{sessionId}/externalflow/{configurationId}/end |
Description
Close 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 TARGET runtime. |
configurationId | string | Automatically generated unique id for the external flow container configuration. |
Request body
None
Response
If successful, status code 200 OK
The
Table of Contents |
---|
Overview
Content Tools