Skip to main content
POST
Retrieve metadata for the latest named report.

Authorizations

Authorization
string
header
required

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

Body

The body containing required ReportName and PortfolioName; optional PortfolioType, ReportingCurrency, accessible MarketDataEnvironmentNames, PnlLookback (Daily, MonthToDate, QuarterToDate, YearToDate, or Annual), and LiveScheduledReport, which defaults to false.

Additional selectors for resolving report metadata from a report name.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiReportMetaDataFromNameRequest, Derivitec.Web.Core
report_name
string | null

Organisation-scoped name of the report definition to use. The value must not be null or empty.

Example:

"Daily risk overview"

reporting_currency
string | null

Currency in which report values are expressed. When null, the service uses the caller's configured reporting currency or USD.

Example:

"USD"

market_data_environment_names
string[] | null

Names of market-data environments to use for the report. The list is empty by default.

portfolio_name
string | null

Name of the portfolio to select. The value must not be null or empty.

Example:

"Example portfolio"

portfolio_type
enum<string> | null

Portfolio category used to resolve the requested portfolio. It may be omitted when the portfolio name resolves unambiguously.

Available options:
derivitec,
enfusion,
orchestrade,
liquidity_book,
maia,
fund_studio,
not_set
pnl_lookback
enum<string> | null

Optional predefined P&L lookback selection.

Available options:
daily,
month_to_date,
quarter_to_date,
year_to_date,
annual
live_scheduled_report
boolean

Whether the latest-row request addresses the exposed live scheduled-report mode.

Response

Returns metadata for the selected report and the Bloomberg-authorisation-failure indicator, with lookup failures in the response envelope.

Metadata and market-data authorisation state returned for a report run.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.Reports.ApiReportMetaDataResponse, 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.

report_meta_data
object

Metadata describing a report run and its recorded state.

bloomberg_authorisation_failure
boolean

Whether report metadata records a Bloomberg market-data authorisation failure.