Request

The request body contains the following elements:

Key

Type

Required/Optional

Description

strategy_name

String

Required

Name of the strategy to use for the decision. Uses the strategy system name (not display name)

strategy_status

String

Required

Status of the strategy to use, either Active or Testing corresponding to the status set in Strategy Activation

application_id

String

Optional

Application ID to associate the application with

return_data_sources

Boolean

Optional

If true, API returns the complete raw data file received from each data integration (as a string) and saves this file to the system, if false, the raw data is not returned.

variables

Object

Required

Data required by the strategy requested. Variables are provided as key value pairs with the key being the variable's system name (not display name)

case_name

String

Optional

A user-defined name for the decision case, which appears in the DigiFi user interface.

Response

The response body contains the following elements:

Key

Type

Description

strategy_name

String

Name of the strategy used for the decision

strategy_version

Number

Version number of the strategy used for the decision

strategy_status

String

Status of the strategy used for the decision (either active or testing)

application_id

String

Application ID associated with results (only returned if application_id is provided in request)

case_id

String

The ID assigned to the case by the system

results

Object

Contains information on the decision results. Only shown in successful responses. See below for detail

The results element contains the following sub-elements:

Key

Type

Description

passed

Boolean

Indicates if the decision passed or failed. Returns true if all Requirements Rules modules passed and false if any fail. If Strategy contains no Requirements Rules modules it will return true

decline_reasons

String (Array)

Shows the assigned decline reasons in the case the decision fails and decline reasons have been set up within the Strategy

input_variables

Object

Contains all Input Variables provided in the API request. Variables are populated as key value pairs with the key being the variable's system name (not display name). Only returned if return_input_variables is set to true in the request

output_variables

Object

Contains all Output Variables assigned by the Strategy. Variables are populated as key value pairs with the key being the variable's system name (not display name). There will be as many data items as there are Output Variables assigned by the Strategy

data_sources

Object

Contains the raw data received from each data integration. The data is returned as a string with " characters escaped. Only returned if the option return_data_sources is set to true in the request

Language