chatbot
clear chat
Skip to main content

Batch

POST 
/scenarios/:scenarioId/commands/batch

Execute a Batch Command

Request​

Path Parameters

    scenarioId stringrequired

    The scenario's id

Body

arrayrequired
  • Array [
    • filter string
    method stringrequired

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

    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 stringrequired
    subfilter string
  • ]

Responses​

Created

Schema
  • Array [
    • filter string
    method stringrequired

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

    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 stringrequired
    subfilter string
  • ]
Loading...