Create
POST/scenarios/:scenarioId/persons/:personId/assets/portfolio/:portfolioId/allocation
To create a risk profile allocation to a portfolio under a person, use the extended URI including the person after the household.
Request
Path Parameters
The scenario's id
The person's id
The portfolio's id
- application/json
Body
required
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.
Responses
- 201
- 404
- 500
Created
- 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