Call step action

Saves and executes form actions, populates custom processor mappings and executes script.

Syntax

Copy 
POST <host_address>/ftosapi/digital-journeys/<digital_journey_name>/step-action/{stepActionId}/{externalId}
 
Parameter Description
host_address The URL of the FintechOS platform server.
digital_journey_name The name of the digital journey.
externalId The unique identifier of the digital journey.
stepActionId The value of the Button Id, as defined in the UI Designer.

Response

Copy 
{
  "instanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "externalId": "string",
  "nextStep": {
    "journeyItem": "string",
    "journeyStep": "string"
}

Examples

In this example, we call a form action.

  • https://app-studio2-issue2441-rc.azurewebsites.net is the URL of the FintechOS server.
  • 415f5348-d5df-4a5d-82ff-7ec0adb1c6c3 is the externalId (unique identifier) of the digital journey.
  • actionx is the buttonId.
  • The request is successful and executes the form action, navigating to the next step of the digital journey (Step2).

Request

Copy 
POST /ftosapi/digital-journeys/TestDJapi/step-action/actionx/415f5348-d5df-4a5d-82ff-7ec0adb1c6c3
Host: app-studio2-issue2441-rc.azurewebsites.net
Content-Type: application/json

Response

Copy 
{
  "instanceId": "415f5348-d5df-4a5d-82ff-7ec0adb1c6c3",
  "externalId": "415f5348-d5df-4a5d-82ff-7ec0adb1c6c3",
  "nextStep": {
    "journeyItem": "af_flow1",
    "journeyStep": "Step2"
}

Errors

HTTP code Message

Context
400 Bad Request The request has no values. The values property must be sent in the request.