chatbot
clear chat
Skip to main content

Diagnose

POST 
/scenarios/commands/diagnose

Creates transient household scenario with its financial data and diagnoses a Scenario Goal using the Envizage Query Language.

The payload accepts JSON expressions using the Envizage Query Language specification. The language specification can be found in the Simulation Results section.

It returns HTTP 200 with the simulation results if the goal diagnose was performed and the results were generated successfully.

Request​

Query Parameters

    resultMode string

    Possible values: [NOMINAL, REAL]

    Default value: NOMINAL

    Simulation result mode

Body

arrayrequired
  • Array [
    • filter string
    method stringrequired

    Possible values: [POST, PUT, DELETE, FIND, FIND_BY_ID, EXECUTE, DIAGNOSE]

    name string
    payload object
    resource stringrequired

    Possible values: [SCENARIO, SCENARIO_PREFERENCE, SCENARIO_PRIMARY, SCENARIO_PARTNER, SCENARIO_CHILD, SCENARIO_PARENT, SCENARIO_PERSON, SCENARIO_ASSET_FINANCIAL_PORTFOLIO, SCENARIO_PERSON_ASSET_FINANCIAL_PORTFOLIO, SCENARIO_PORTFOLIO_ASSET_FINANCIAL, SCENARIO_PERSON_PORTFOLIO_ASSET_FINANCIAL, SCENARIO_ASSET_PHYSICAL, SCENARIO_ASSET_PROPERTY_INVESTMENT, SCENARIO_PERSON_ASSET_PROPERTY_INVESTMENT, SCENARIO_ASSET_PROPERTY_RESIDENTIAL, SCENARIO_PERSON_ASSET_PROPERTY_RESIDENTIAL, SCENARIO_EXPENSE_EMPLOYEE_PENSION_CONTRIBUTION, SCENARIO_PERSON_EXPENSE_EMPLOYEE_PENSION_CONTRIBUTION, SCENARIO_EXPENSE_PORTFOLIO_CONTRIBUTION, SCENARIO_PERSON_EXPENSE_PORTFOLIO_CONTRIBUTION, SCENARIO_PERSON_EXPENSE_INSURANCE_PREMIUM, SCENARIO_EXPENSE_LIVING, SCENARIO_PERSON_EXPENSE_LIVING, SCENARIO_EXPENSE_MORTGAGE, SCENARIO_PERSON_EXPENSE_MORTGAGE, SCENARIO_EXPENSE_RENT, SCENARIO_PERSON_EXPENSE_RENT, SCENARIO_GOAL_BUY_A_CAR, SCENARIO_PERSON_GOAL_BUY_A_CAR, SCENARIO_GOAL_BUY_A_HOUSE, SCENARIO_PERSON_GOAL_BUY_A_HOUSE, SCENARIO_GOAL_BUY_TO_LET, SCENARIO_PERSON_GOAL_BUY_TO_LET, SCENARIO_GOAL_ELIMINATE_DEBT, SCENARIO_PERSON_GOAL_ELIMINATE_DEBT, SCENARIO_GOAL_GET_MARRIED, SCENARIO_PERSON_GOAL_GET_MARRIED, SCENARIO_GOAL_GO_TO_SCHOOL, SCENARIO_PERSON_GOAL_GO_TO_SCHOOL, SCENARIO_GOAL_GROW_MY_WEALTH, SCENARIO_PERSON_GOAL_GROW_MY_WEALTH, SCENARIO_GOAL_HAVE_A_CHILD, SCENARIO_PERSON_GOAL_HAVE_A_CHILD, SCENARIO_GOAL_INVEST_IN_A_BUSINESS, SCENARIO_PERSON_GOAL_INVEST_IN_A_BUSINESS, SCENARIO_GOAL_MOVE_OUT, SCENARIO_PERSON_GOAL_MOVE_OUT, SCENARIO_GOAL_RELOCATE, SCENARIO_PERSON_GOAL_RELOCATE, SCENARIO_GOAL_RETIREMENT, SCENARIO_PERSON_GOAL_RETIREMENT, SCENARIO_GOAL_SABBATICAL, SCENARIO_PERSON_GOAL_SABBATICAL, SCENARIO_GOAL_TRAVEL, SCENARIO_PERSON_GOAL_TRAVEL, SCENARIO_GOAL_USER_DEFINED, SCENARIO_PERSON_GOAL_USER_DEFINED, SCENARIO_GOAL_RECURRING_USER_DEFINED, SCENARIO_PERSON_GOAL_RECURRING_USER_DEFINED, SCENARIO_TYPED_GOAL, SCENARIO_PERSON_TYPED_GOAL, SCENARIO_PERSON_INCOME_EARNED, SCENARIO_INCOME_EMPLOYER_PENSION_CONTRIBUTION, SCENARIO_PERSON_INCOME_EMPLOYER_PENSION_CONTRIBUTION, SCENARIO_INCOME_INSURANCE, SCENARIO_PERSON_INCOME_INSURANCE, SCENARIO_PERSON_INCOME_PENSION_ANNUITY, SCENARIO_PERSON_INCOME_PENSION_DRAW_DOWN, SCENARIO_PERSON_INCOME_PENSION_LUMP_SUM, SCENARIO_PERSON_INCOME_PENSION_STATE, SCENARIO_INCOME_RENT, SCENARIO_PERSON_INCOME_RENT, SCENARIO_INCOME_UNEARNED, SCENARIO_PERSON_INCOME_UNEARNED, SCENARIO_PERSON_INSURANCE_CRITICAL_ILLNESS, SCENARIO_PERSON_INSURANCE_DISABILITY, SCENARIO_PERSON_INSURANCE_LIFE, SCENARIO_PERSON_INSURANCE_MORTGAGE_LIFE, SCENARIO_LIABILITY_MORTGAGE, SCENARIO_PERSON_LIABILITY_MORTGAGE, SCENARIO_LIABILITY_OTHER_SECURED_DEBT, SCENARIO_PERSON_LIABILITY_OTHER_SECURED_DEBT, SCENARIO_LIABILITY_UNSECURED_DEBT, SCENARIO_PERSON_LIABILITY_UNSECURED_DEBT]

    scenarioId string
    subfilter string
  • ]

Responses​

Created

Schema
  • Array [
    • id string

    The id of the resource.

    name string

    The name of the resource.

    description string

    Description of the resource.

    scenarioId stringrequired
    simulationId string
    clientId stringrequired
    username string
    results object[]required
  • Array [
    • name string
    results object[]
  • Array [
    • lifeId int32
    timestepId int32
    goalId string
    data object
    property name* object
  • ]
  • ]
    • goalId string
    diagnosticType string

    Possible values: [EXPENSE_LIVING_EXPENSES_DECREASE, EXPENSE_RENT_VS_MORTGAGE_ON_RESIDENTIAL_PROPERTY, EXPENSE_MORTGAGE_ON_RESIDENTIAL_PROPERTY_VS_RENT, INCOME_EARNED_INCOME_INCREASE_PRIMARY, INCOME_EARNED_INCOME_INCREASE_PARTNER, INCOME_WORK_PART_TIME_AFTER_RETIREMENT_PRIMARY, INCOME_WORK_PART_TIME_AFTER_RETIREMENT_PARTNER, GOAL_SWITCH_OFF_EARLIER_GOALS, GOAL_SPEND_LESS_MONEY_ON_GOAL, GOAL_MOVE_IT_TO_THE_FUTURE, GOAL_BUY_A_HOUSE_DOWNPAYMENT, GOAL_BUY_A_HOUSE_MORTGAGE_AFFORDABILITY, GOAL_BORROW, GOAL_SAVE_IN_YEARS, PROPERTY_MOVE_TO_SMALLER_PROPERTY, PROPERTY_SELL_BUY_TO_LET_PROPERTIES, DEBT_RESIDENTIAL_PROPERTIES_REMORTGAGE, DEBT_INVESTMENT_PROPERTIES_REMORTGAGE, DEBT_ELIMINATE_DEBT, WRAPPER_TAX_ADVANTAGED_RISK_INCREASE_PRIMARY, WRAPPER_TAX_ADVANTAGED_RISK_INCREASE_PARTNER, WRAPPER_TAX_ADVANTAGED_RISK_DECREASE_PRIMARY, WRAPPER_TAX_ADVANTAGED_RISK_DECREASE_PARTNER, WRAPPER_GIA_RISK_INCREASE_PRIMARY, WRAPPER_GIA_RISK_INCREASE_PARTNER, WRAPPER_GIA_RISK_DECREASE_PRIMARY, WRAPPER_GIA_RISK_DECREASE_PARTNER, WRAPPER_PENSION_RISK_INCREASE_PRIMARY, WRAPPER_PENSION_RISK_INCREASE_PARTNER, WRAPPER_PENSION_RISK_DECREASE_PRIMARY, WRAPPER_PENSION_RISK_DECREASE_PARTNER, WRAPPER_PENSION_CONTRIBUTION_INCREASE_PRIMARY, WRAPPER_PENSION_CONTRIBUTION_INCREASE_PARTNER, SAVINGS_TAX_ADVANTAGED_INVESTMENTS_ENABLE_PRIMARY, SAVINGS_TAX_ADVANTAGED_INVESTMENTS_ENABLE_PARTNER, SAVINGS_GIA_INVESTMENTS_ENABLE_PRIMARY, SAVINGS_GIA_INVESTMENTS_ENABLE_PARTNER, INSURANCE_TERM_LIFE_INSURANCE_INCREASE_PRIMARY, INSURANCE_TERM_LIFE_INSURANCE_INCREASE_PARTNER, INSURANCE_DISABILITY_INSURANCE_INCREASE_PRIMARY, INSURANCE_DISABILITY_INSURANCE_INCREASE_PARTNER, INSURANCE_CRITICAL_ILLNESS_INSURANCE_INCREASE_PRIMARY, INSURANCE_CRITICAL_ILLNESS_INSURANCE_INCREASE_PARTNER, INSURANCE_MORTGAGE_LIFE_INSURANCE_INCREASE, LIFESTYLE_TOO_UNHEALTHY_PRIMARY, LIFESTYLE_TOO_UNHEALTHY_PARTNER, NONE]

  • ]
Loading...