Load current step

The load method returns the data relating to the current step of the digital journey, for example whether the step is first or last, step name, type, Id, as well as information from the UI template of the current step of the digital journey.

Syntax

Copy 
GET <host_address>/ftosapi/digital-journeys/<digital_journey_name>/load/{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.

Response

If the request is successful, the response returns all the data that relates to the current step of the digital journey.

Examples

In this example, we request information on the current step of our digital journey.

  • The host address https://app-openapi-ftosmaster-rc.azurewebsites.net is the URL of the FintechOS server.
  • The journey is identified by the 95efacc9-8855-418d-89e1-72048c33c9ee externalId.
  • The request is successful and returns attribute data from the current step (CustomerConsent), as well as the digital journey name and associated form driven flow (OvdBankFLOW).

Request

Copy 
GET /ftosapi/digital-journeys/Oi_DJF/load/e2dd5506-6376-4159-bf84-ffcf83604d4f
Host: https://app-openapi-ftosmaster-rc.azurewebsites.net
Content-Type: application/json

Response

Copy 
{
  "isLastStep": false,
  "isFirstStep": true,
  "properties": {
    "nextButton": {
      "label": "",
      "show": true
    },
    "previousButton": {
      "label": "",
      "show": false
    }
  },
  "stepActions": [
    {
      "id": "StartFormActionTest",
      "displayName": "StartFormActionTest",
      "type": "callFormAction",
      "endpointName": null,
      "formActionName": null,
      "navigateNextStep": true
    },
    {
      "id": "NoNextFormAction",
      "displayName": "NoNextFormAction",
      "type": "callCustomProcessor",
      "endpointName": null,
      "formActionName": null,
      "navigateNextStep": false
    }
  ],
  "journeyStepType": "default",
  "journeyName": "Oi_DJF",
  "journeyItem": "OvdBankFLOW",
  "journeyStep": "Start",
  "fields": [],
  "instanceId": "e2dd5506-6376-4159-bf84-ffcf83604d4f",
  "externalId": "e2dd5506-6376-4159-bf84-ffcf83604d4f"
}

Note: In the example above, the "journeyStepType" is "default". Another step type value is "action", which is used to run a specific action, but it will not contain any fields, as it does not have a UI.

Errors

HTTP code Message

Context
400 Bad Request Cannot load an action with no record attached. Occurs when the main record Id is null and the step is of type "Action".

404 Not Found

Current step not found.

Occurs when there is no step found for the externalId.