GetPortfolio

GET

/portfolios/{portfolioId}

Retrieves the information of a given portfolio.

Authorizations

• aws.auth.sigv4

Parameters

Path Parameters

portfolioId

required

Portfolio unique ID.

string

/^[A-Za-z0-9-]+$/

Portfolio unique ID.

Responses

200

GetPortfolio 200 response

object

portfolioId

required

Portfolio unique ID.

string

/^[A-Za-z0-9-]+$/

portfolioName

Portfolio name.

string

openTimestamp

Timestamp when the portfolio was opened.

string

startBookDate

Portfolio start book date.

string

endBookDate

Portfolio end book date.

string

400

ValidationException 400 response

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

object

message

required

A summary of the validation failure.

string

fieldList

A list of specific failures encountered while validating the input. A member can appear in this list more than once if it failed to satisfy multiple constraints.

Array<object>

Describes one specific validation failure for an input member.

object

path

required

A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.

string

message

required

A detailed description of the validation failure.

string

401

UnauthorizedError 401 response

object

message

required

string

403

ForbiddenError 403 response

object

message

required

string

404

NotFoundError 404 response

object

message

required

string

500

InternalServerError 500 response

object

message

required

string

503

ServiceUnavailableError 503 response

object

message

required

string