Retrieve all

GET 
/scenarios/:scenarioId/persons/:personId/assets/portfolio/:portfolioId/allocation

List all Financial Portfolios allocations in a given scenario and for a given person.

Request

Path Parameters

scenarioId stringrequired

The scenario's id

personId stringrequired

The person's id

portfolioId stringrequired

The portfolio's id

Query Parameters

page integer

Zero-based page index (0..N)

size integer

Default value: 20

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200

OK

application/json

Schema

Schema

content object[]
Array [
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.
]
empty boolean
first boolean
last boolean
number int32
numberOfElements int32
pageable object
offset int64
pageNumber int32
pageSize int32
paged boolean
sort object
empty boolean
sorted boolean
unsorted boolean
unpaged boolean
size int32
sort object
empty boolean
sorted boolean
unsorted boolean
totalElements int64
totalPages int32

Example (from schema)

{
  "content": [
    {
      "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"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}

404

Not Found

500

Internal Server Error

Loading...