Load metadata

Returns all the metadata of a digital journey, such as the form driven flow(s), the steps within them, the attributes, etc.

Syntax

Copy

GET <host_address>/ftosapi/digital-journeys/<digital_journey_name>/load-metadata

Parameter	Description
`host_address`	The URL of the FintechOS platform server.
`digital_journey_name`	The name of the digital journey.

Response

Copy

{
  "formDrivenFlows": [
    {
      "name": "string",
      "steps": [
        {
          "properties": {
            "nextButton": {
              "label": "string",
              "show": true
            },
            "previousButton": {
              "label": "string",
              "show": true
            }
          },
          "fields": [
            {
              "name": "string",
              "displayName": "string",
              "type": "string",
              "value": "string",
              "requiredLevel": 0,
              "isReadOnly": true,
              "optionSetValues": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "displayName": "string",
                "name": "string",
                "value": 0,
                "orderIndex": 0
              },
              "virtualType": "string"
            }
          ],
          "stepActions": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "displayName": "string",
              "type": "string",
              "endpointName": "string",
              "formActionName": "string",
              "navigateNextStep": true
            }
          ],
          "isLastStep": true,
          "isFirstStep": true,
          "journeyStepType": "string",
          "journeyName": "string",
          "journeyItem": "string",
          "journeyStep": "string"
        }
      ]
    }
  ],
  "journeyName": "string"

Examples

Load journey metadata

In this example, we request the metadata of our digital journey.

https://app-openapi-ftosmaster-rc.azurewebsites.net is the URL of the FintechOS platform server.
The request is successful and returns the metadata for our digital journey (Oi_DJF).

Request

Copy

GET /ftosapi/digital-journeys/Oi_DJF/load-metadata/
Host: https://app-openapi-ftosmaster-rc.azurewebsites.net
Content-Type: application/json

Response

Copy

{
  "journeyName": "Oi_DJF",
  "formDrivenFlows": [
    {
      "name": "OvdBankFLOW",
      "steps": [
        {
          "isLastStep": false,
          "isFirstStep": true,
          "properties": {
            "nextButton": {
              "label": "",
              "show": true
            },
            "previousButton": {
              "label": "",
              "show": false
            }
          },
          "stepActions": [],
          "journeyStepType": "default",
          "journeyName": null,
          "journeyItem": null,
          "journeyStep": "Start",
          "fields": [],
          "instanceId": null,
          "externalId": null
        },
        {
          "isLastStep": false,
          "isFirstStep": false,
          "properties": {
            "nextButton": {
              "label": "",
              "show": true
            },
            "previousButton": {
              "label": "",
              "show": true
            }
          },
          "stepActions": [],
          "journeyStepType": "default",
          "journeyName": null,
          "journeyItem": null,
          "journeyStep": "CustomerConsent",
          "fields": [
            {
              "name": "DataProcessingAgreement",
              "displayName": "Data Processing Agreement",
              "type": "bool",
              "value": null,
              "isReadOnly": false,
              "requiredLevel": 0,
              "optionSetValues": null
            },
            {
              "name": "FirstName",
              "displayName": "First Name",
              "type": "text",
              "value": null,
              "isReadOnly": false,
              "requiredLevel": 0,
              "optionSetValues": null
            },
            {
              "name": "LastName",
              "displayName": "Last Name",
              "type": "text",
              "value": null,
              "isReadOnly": false,
              "requiredLevel": 0,
              "optionSetValues": null
            }
          ],
          "instanceId": null,
          "externalId": null
        },
        {
          "isLastStep": false,
          "isFirstStep": false,
          "properties": {
            "nextButton": {
              "label": "",
              "show": true
            },
            "previousButton": {
              "label": "",
              "show": true
            },
            {
              "name": "SocialSecurityNumber",
              "displayName": "Social Security Number",
              "type": "whole_number",
              "value": null,
              "isReadOnly": false,
              "requiredLevel": 0,
              "optionSetValues": null
            }
          ],
          "instanceId": null,
          "externalId": null
        },
        {
          "isLastStep": false,
          "isFirstStep": false,
          "properties": {
            "nextButton": {
              "label": "",
              "show": true
            },
            "previousButton": {
              "label": "",
              "show": true
            }
          },
          "stepActions": [],
          "journeyStepType": "default",
          "journeyName": null,
          "journeyItem": null,
          "journeyStep": "CustomerFinancialData",
          "fields": [
            {
              "name": "CustomerDocuments",
              "displayName": "Customer Documents",
              "type": "file",
              "value": null,
              "isReadOnly": false,
              "requiredLevel": 0,
              "optionSetValues": null
            },
            {
              "name": "LoanAmount",
              "displayName": "Loan Amount",
              "type": "numeric",
              "value": null,
              "isReadOnly": false,
              "requiredLevel": 0,
              "optionSetValues": null
            },
            {
              "name": "MonthlyIncome",
              "displayName": "Monthly Income",
              "type": "numeric",
              "value": null,
              "isReadOnly": false,
              "requiredLevel": 0,
              "optionSetValues": null
            }
          ],
          "instanceId": null,
          "externalId": null
        },
        {
          "isLastStep": false,
          "isFirstStep": false,
          "properties": {
            "nextButton": {
              "label": "",
              "show": true
            },
            "previousButton": {
              "label": "",
              "show": true
            }
          },
          "stepActions": [
            {
              "id": "contractIdd",
              "displayName": "Contract",
              "type": "default",
              "endpointName": null,
              "formActionName": null,
              "navigateNextStep": false
            }
          ],
          "journeyStepType": "default",
          "journeyName": null,
          "journeyItem": null,
          "journeyStep": "Contract",
          "fields": [],
          "instanceId": null,
          "externalId": null
        },
        {
          "isLastStep": true,
          "isFirstStep": false,
          "properties": {
            "nextButton": {
              "label": "",
              "show": false
            },
            "previousButton": {
              "label": "",
              "show": true
            }
          },
          "stepActions": [],
          "journeyStepType": "default",
          "journeyName": null,
          "journeyItem": null,
          "journeyStep": "FarewellMessage",
          "fields": [],
          "instanceId": null,
          "externalId": null
        }
      ]
    }
  ]
}

Errors

HTTP code	Message	Context
400 Bad Request	No valid record found attached to the instance step.	Occurs if no form driven flow is attached to the digital journey item.