Get lookup values

Returns information about the Lookup-type attribute(s) found on the current step of the journey.

Syntax

Copy

GET <host_address>/ftosapi/digital-journeys/<digital_journey_name>/load-metadata/lookup-values/{attributeName}/{externalId}

Parameter	Description
`host_address`	The URL of the FintechOS platform server.
`digital_journey_name`	The name of the digital journey.
`attributeName`	The name of the lookup attribute.
`externalId`	The unique identifier of the digital journey.

Response

Copy

{
  "lookupValues": [
    {
      "displayName": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Examples

Getting the lookup values in a step

In this example, we request the lookup values of a record in the digital journey.

https://app-openapi-mytestbank1-uat.azurewebsites.net is the URL of the FintechOS server.
toAnother2 is the name of the lookup attribute.
The request is successful and returns the IDs and the names of the two look-up type attributes found on the step.

Request

Copy

GET /app-openapi-mytestbank1-uat.azurewebsites.net/ftosapi/digital-journeys/Oi_DJF/lookup-values/toAnother2/1a119a69-3020-4688-8126-1a61f568c202
Host: https://app-openapi-mytestbank1-uat.azurewebsites.net
Content-Type: application/json

Response

Copy

{
  "lookupValues": [
    {
      "id": "f8c6918b-77a7-4e2a-9357-6294ea52e39a",
      "displayName": "abcd"
    },
    {
      "id": "e4b64853-c690-4149-a8d2-c474c5735252",
      "displayName": "test"
    }
  ],
  "instanceId": "1a119a69-3020-4688-8126-1a61f568c202",
  "externalId": "1a119a69-3020-4688-8126-1a61f568c202"
}

Errors

HTTP code	Message	Context
400 Bad Request	Cannot lookup attribute from different record.	Occurs if the the attribute of type "lookup" requested is not on the current step.
400 Bad Request	Cannot get lookup values from non-lookup type attribute.	Occurs if the requested attribute is not of type "lookup".