List current instruments in a book.
Lists current non-deleted, non-archived position entries in an accessible book with tradable identifier,
display name, and quantity. This is read-only. Although StartRow and EndRow are accepted,
they are not currently applied, so this operation is not paginated.
Authorizations
OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header
Body
Required BookName; StartRow and EndRow are signed 32-bit integers that default to 0, have no declared range constraint, and currently have no effect.
Book selection and accepted row-boundary values for listing its current instrument positions.
Derivitec.Web.Core.Book.ApiListBookInstrumentsRequest, Derivitec.Web.Core Organisation-scoped name of the book to select. The value must not be null or empty.
"Example book"
Accepted starting-row value; the current listing does not use it to limit the returned holdings. Defaults to 0.
0
Accepted ending-row value; the current listing does not use it to limit the returned holdings. Defaults to 0.
0
Response
Returns instrument rows, or an unsuccessful envelope when display information is unavailable.
Current instrument positions held by the selected book.
Derivitec.Web.Core.Book.ApiListBookInstrumentsResponse, Derivitec.Web.Core Whether the operation completed successfully. The default is true; error outcomes set it to false.
true
Messages explaining operation-level failures. The collection is empty by default.
Current, non-archived instrument positions in the selected book; an empty collection is valid.