Skip to main content
GET
List portfolio and book relationships.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Response

Returns accessible portfolio and book relationship records; an empty collection is valid.

Accessible portfolio and book hierarchy with direct parent and child relationships.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Portfolios.ApiGetPortfolioBookRelationshipsResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

portfolio_book_relationships
object[] | null

Accessible portfolio and book entries with their direct parent and child links; an empty collection is valid.