Skip to main content
POST
Retrieve available P&L data for a report run.

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 P&L report-run ReportId. Other fields exposed by the inherited request schema are not effective selectors for this operation.

Selectors and optional formatting query for retrieving one report run.

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

Optional filter and column selection for formatted report data.

Response

Returns available P&L report data, run status, reporting currency, result tables, timestamp, and current-user time-zone identifier.

Report-run result tables, status, portfolio context, and market-data diagnostics.

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

market_data_error_summary
object

Market-data failures grouped by the affected data category.

portfolio_id
integer<int32>

Opaque identifier of the portfolio associated with the report run.

portfolio_name
string | null

Portfolio name associated with the report run or saved launcher item.

report_id
string | null

Opaque identifier of the report run.

reporting_currency
string | null

Currency used to express monetary report values; the code format is not constrained here.

report_name
string | null

Name of the report definition associated with the run, schedule, restriction, or launcher item.

status
enum<string>

Lifecycle state recorded for the report run or scheduled item.

Available options:
none,
succeeded,
failed,
running,
warning
status_message
string | null

Human-readable diagnostic associated with the recorded report or schedule state.

tables
any[] | null

Formatted result tables returned for the report run.

time_stamp
string<date-time>

Timestamp recorded for the report run; no time-zone convention is established by this contract.

user_time_zone_id
string | null

Time-zone identifier associated with presentation of report timestamps; accepted identifier formats are not defined here.