Skip to main content
POST
Retrieve report metadata by run identifier.

Authorizations

Authorization
string
header
required

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

Body

The body containing the required opaque ReportId; optional PortfolioType, ReportRestrictionId, ReportRowFilter, and ReportType. Do not supply caller or server-selected market-data context.

Selector for retrieving metadata for a report category.

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

Opaque identifier of the report run to retrieve or query. The value must not be null or empty.

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
report_type
enum<string>

Report category that selects the applicable result or metadata shape.

Available options:
risk,
var,
pnl,
time_series

Response

Returns report metadata and the Bloomberg-authorisation-failure indicator, with business or access 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.