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
The scenario's id
The portfolio's id
The allocation's id
Responses
- 200
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array of custom allocation percentages, overrides profile.
Description of the resource.
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
.
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
The id of the resource.
The name of the resource.
The risk profile of the portfolio.
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
.
Possible values: [USER_DEFINED
, ON_RETIREMENT
, ON_DEATH
]
Can be any of USER_DEFINED, ON_RETIREMENT, ON_DEATH.
{
"allocation": [
0.12,
0.05,
0.12,
0.15,
0.45,
0.11,
0,
0,
0
],
"description": "My resource's description",
"endDate": "2023-07-26T12:27:29.363Z",
"endsOn": "ON_RETIREMENT",
"id": "1",
"name": "My resource",
"profile": "medium",
"startDate": "2023-07-26T12:27:29.363Z",
"startsOn": "USER_DEFINED"
}
Not Found
Internal Server Error