Skip to main content

Retrieve

GET 
/scenarios/:scenarioId/assets/portfolio/:portfolioId/allocation/:allocationId

Provides information on the allocations of a given portfolio to risk profile(s) from the specified scenario

Request​

Path Parameters

    scenarioId stringrequired

    The scenario's id

    portfolioId stringrequired

    The portfolio's id

    allocationId stringrequired

    The allocation's id

Responses​

OK

Schema
    allocation double[]

    Array of custom allocation percentages, overrides profile.

    description string

    Description of the resource.

    endDate date-timerequired

    The end date of the allocation. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Will be respected only in conjuction with endsOn equals to USER_DEFINED.

    endsOn stringrequired

    Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]

    Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.

    id string

    The id of the resource.

    name string

    The name of the resource.

    profile string

    The risk profile of the portfolio.

    startDate date-timerequired

    The start date of the allocation. Valid date string in simplified extended ISO-8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Will be respected only in conjuction with startsOn equals to USER_DEFINED.

    startsOn stringrequired

    Possible values: [USER_DEFINED, ON_RETIREMENT, ON_DEATH]

    Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.

Loading...