> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve available P&L data for a report run.

> Returns currently available data and status for the specified run without waiting for completion. Clients
should inspect `Status`, `StatusMessage`, `IsSuccess`, and `ErrorMessages`. Only the
report-run identifier selects data for this operation; exposed row-filter, table-query, portfolio-type,
market-data, and caller-context fields do not alter the result.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/PnLReport/GetPnLReportDataById
openapi: 3.0.4
info:
  title: Derivitec Api 1.0
  version: '1.0'
servers:
  - url: https://api.riskportal.activeviam.com
security:
  - oauth2: []
  - apikey: []
tags:
  - name: AdminUser
  - name: AtotiReport
  - name: AtotiSession
  - name: BloombergOAuth
  - name: Bond
  - name: BondYieldCurvePage
  - name: BookAccess
  - name: Books
  - name: Commodity
  - name: Counterparties
  - name: Currencies
  - name: Equity
  - name: EquityDividend
  - name: EquityPage
  - name: FeatureFlag
  - name: Fx
  - name: FxPage
  - name: GroupAccess
  - name: Home
  - name: LegacyPosition
  - name: MarketData
  - name: MarketDataProvider
  - name: MarketDataProviderAccess
  - name: Meta
  - name: Notification
  - name: Organisation
  - name: PnLReport
  - name: PortfolioAccess
  - name: Portfolios
  - name: Position
  - name: PositionFilter
  - name: PricingEnvironment
  - name: PricingEnvironmentAccess
  - name: RateAsset
  - name: RateAssetPage
  - name: Report
  - name: ReportDefinition
  - name: ReportHistoryLauncherQuery
  - name: ReportLauncher
  - name: ReportQuery
  - name: ReportQueryViewUser
  - name: ReportRestriction
  - name: ReportView
  - name: RiskReport
  - name: Tradable
  - name: TradeBooking
  - name: User
  - name: VarReport
  - name: VarReportQuery
  - name: YieldCurvePage
paths:
  /api/PnLReport/GetPnLReportDataById:
    post:
      tags:
        - PnLReport
      summary: Retrieve available P&L data for a report run.
      description: >-
        Returns currently available data and status for the specified run
        without waiting for completion. Clients

        should inspect `Status`, `StatusMessage`, `IsSuccess`, and
        `ErrorMessages`. Only the

        report-run identifier selects data for this operation; exposed
        row-filter, table-query, portfolio-type,

        market-data, and caller-context fields do not alter the result.
      operationId: GetPnLReportDataById
      requestBody:
        description: >-
          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.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetReportDataByIdRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetReportDataByIdRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetReportDataByIdRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetReportDataByIdRequest'
      responses:
        '200':
          description: >-
            Returns available P&L report data, run status, reporting currency,
            result tables, timestamp, and current-user time-zone identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiReportDataResponse'
        '400':
          description: >-
            Returns the text `Report does not exist` when the specified P&L
            report does not exist.
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetReportDataByIdRequest:
      required:
        - $type
      type: object
      properties:
        report_id:
          type: string
          description: >-
            Opaque identifier of the report run to retrieve or query. The value
            must not be null or empty.
          nullable: true
        portfolio_type:
          enum:
            - derivitec
            - enfusion
            - orchestrade
            - liquidity_book
            - maia
            - fund_studio
            - not_set
          type: string
          description: >-
            Portfolio category used to resolve the requested portfolio. It may
            be omitted when the portfolio name resolves unambiguously.
          nullable: true
        data_table_query:
          $ref: '#/components/schemas/DataTableQuery'
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiGetReportDataByIdRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Selectors and optional formatting query for retrieving one report run.
    ApiReportDataResponse:
      required:
        - $type
      type: object
      properties:
        is_success:
          type: boolean
          description: >-
            Whether the operation completed successfully. The default is `true`;
            error outcomes set it to `false`.
          example: true
        error_messages:
          type: array
          items:
            type: string
          description: >-
            Messages explaining operation-level failures. The collection is
            empty by default.
          nullable: true
        market_data_error_summary:
          $ref: '#/components/schemas/MarketDataErrorSummary'
        portfolio_id:
          type: integer
          description: Opaque identifier of the portfolio associated with the report run.
          format: int32
        portfolio_name:
          type: string
          description: >-
            Portfolio name associated with the report run or saved launcher
            item.
          nullable: true
        report_id:
          type: string
          description: Opaque identifier of the report run.
          nullable: true
        reporting_currency:
          type: string
          description: >-
            Currency used to express monetary report values; the code format is
            not constrained here.
          nullable: true
        report_name:
          type: string
          description: >-
            Name of the report definition associated with the run, schedule,
            restriction, or launcher item.
          nullable: true
        status:
          enum:
            - none
            - succeeded
            - failed
            - running
            - warning
          type: string
          description: Lifecycle state recorded for the report run or scheduled item.
        status_message:
          type: string
          description: >-
            Human-readable diagnostic associated with the recorded report or
            schedule state.
          nullable: true
        tables:
          type: array
          items: {}
          description: Formatted result tables returned for the report run.
          nullable: true
        time_stamp:
          type: string
          description: >-
            Timestamp recorded for the report run; no time-zone convention is
            established by this contract.
          format: date-time
        user_time_zone_id:
          type: string
          description: >-
            Time-zone identifier associated with presentation of report
            timestamps; accepted identifier formats are not defined here.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiReportDataResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Report-run result tables, status, portfolio context, and market-data
        diagnostics.
    DataTableQuery:
      required:
        - $type
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/FilterBase'
        columns:
          type: array
          items:
            type: string
          description: >-
            Columns selected for formatted report data or defined in a report
            view.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.Reports.DataTableQuery, Derivitec.Web.Core
      additionalProperties: false
      description: Optional filter and column selection for formatted report data.
    MarketDataErrorSummary:
      required:
        - $type
      type: object
      properties:
        bond_vol_surface_errors:
          type: array
          items:
            $ref: '#/components/schemas/BondVolSurfaceError'
          description: >-
            Failures collected while resolving bond volatility-surface market
            data.
          nullable: true
        bond_yield_curve_errors:
          type: array
          items:
            $ref: '#/components/schemas/BondYieldCurveError'
          description: Failures collected while resolving bond yield-curve market data.
          nullable: true
        bond_yield_curve_spread_errors:
          type: array
          items:
            $ref: '#/components/schemas/BondYieldCurveSpreadError'
          description: >-
            Failures collected while resolving bond yield-curve spread market
            data.
          nullable: true
        credit_event_errors:
          type: array
          items:
            $ref: '#/components/schemas/CreditEventError'
          description: Failures collected while resolving credit-event market data.
          nullable: true
        calendar_errors:
          type: array
          items:
            type: string
          description: Failures collected while resolving calendar market data.
          nullable: true
        cmdty_vol_surface_errors:
          type: array
          items:
            $ref: '#/components/schemas/CmdtyVolSurfaceError'
          description: >-
            Failures collected while resolving commodity volatility-surface
            market data.
          nullable: true
        commodity_errors:
          type: array
          items:
            $ref: '#/components/schemas/CommodityError'
          description: Failures collected while resolving commodity market data.
          nullable: true
        credit_index_correlation_errors:
          type: array
          items:
            $ref: '#/components/schemas/CreditIndexCorrelationError'
          description: >-
            Failures collected while resolving credit-index correlation market
            data.
          nullable: true
        credit_swaption_vol_cube_errors:
          type: array
          items:
            $ref: '#/components/schemas/CreditSwaptionVolCubeError'
          description: >-
            Failures collected while resolving credit swaption volatility-cube
            market data.
          nullable: true
        discount_curve_errors:
          type: array
          items:
            $ref: '#/components/schemas/DiscountCurveError'
          description: Failures collected while resolving discount-curve market data.
          nullable: true
        equity_asset_errors:
          type: array
          items:
            $ref: '#/components/schemas/EquityAssetError'
          description: Failures collected while resolving equity-asset market data.
          nullable: true
        equity_equity_correlation_errors:
          type: array
          items:
            $ref: '#/components/schemas/EquityEquityCorrelationError'
          description: >-
            Failures collected while resolving equity-to-equity correlation
            market data.
          nullable: true
        equity_fx_correlation_errors:
          type: array
          items:
            $ref: '#/components/schemas/EquityFxCorrelationError'
          description: >-
            Failures collected while resolving equity-to-FX correlation market
            data.
          nullable: true
        eq_ir_correlation_errors:
          type: array
          items:
            $ref: '#/components/schemas/EqIRCorrelationError'
          description: >-
            Failures collected while resolving equity-to-interest-rate
            correlation market data.
          nullable: true
        fx_fx_correlation_errors:
          type: array
          items:
            $ref: '#/components/schemas/FxFxCorrelationError'
          description: Failures collected while resolving FX-to-FX correlation market data.
          nullable: true
        equity_vol_index_errors:
          type: array
          items:
            $ref: '#/components/schemas/EquityVolIndexError'
          description: >-
            Failures collected while resolving equity volatility-index market
            data.
          nullable: true
        equity_vol_index_vol_surface_errors:
          type: array
          items:
            $ref: '#/components/schemas/EquityVolIndexVolSurfaceError'
          description: >-
            Failures collected while resolving equity volatility-index surface
            market data.
          nullable: true
        equity_vol_surface_errors:
          type: array
          items:
            $ref: '#/components/schemas/EquityVolSurfaceError'
          description: >-
            Failures collected while resolving equity volatility-surface market
            data.
          nullable: true
        equity_vol_of_var_curve_errors:
          type: array
          items:
            $ref: '#/components/schemas/EquityVolOfVarCurveError'
          description: >-
            Failures collected while resolving equity volatility-of-variance
            curve market data.
          nullable: true
        dividend_index_errors:
          type: array
          items:
            $ref: '#/components/schemas/DividendIndexError'
          description: Failures collected while resolving dividend-index market data.
          nullable: true
        dividend_index_vol_surface_errors:
          type: array
          items:
            $ref: '#/components/schemas/DividendIndexVolSurfaceError'
          description: >-
            Failures collected while resolving dividend-index volatility-surface
            market data.
          nullable: true
        fx_vol_of_var_curve_errors:
          type: array
          items:
            $ref: '#/components/schemas/FxVolOfVarCurveError'
          description: >-
            Failures collected while resolving FX volatility-of-variance curve
            market data.
          nullable: true
        fx_cross_errors:
          type: array
          items:
            $ref: '#/components/schemas/FxCrossError'
          description: Failures collected while resolving FX-cross market data.
          nullable: true
        fx_vol_surface_errors:
          type: array
          items:
            $ref: '#/components/schemas/FxVolSurfaceError'
          description: >-
            Failures collected while resolving FX volatility-surface market
            data.
          nullable: true
        andersen_buffum_parameters_errors:
          type: array
          items:
            $ref: '#/components/schemas/AndersenBuffumParametersError'
          description: >-
            Failures collected while resolving Andersen-Buffum parameter market
            data.
          nullable: true
        ir_futures_vol_cube_errors:
          type: array
          items:
            $ref: '#/components/schemas/IrFuturesVolCubeError'
          description: >-
            Failures collected while resolving interest-rate futures
            volatility-cube market data.
          nullable: true
        rate_asset_errors:
          type: array
          items:
            $ref: '#/components/schemas/RateAssetError'
          description: Failures collected while resolving rate-asset market data.
          nullable: true
        recovery_rate_errors:
          type: array
          items:
            $ref: '#/components/schemas/RecoveryRateError'
          description: Failures collected while resolving recovery-rate market data.
          nullable: true
        probability_of_default_errors:
          type: array
          items:
            $ref: '#/components/schemas/ProbabilityOfDefaultError'
          description: >-
            Failures collected while resolving probability-of-default market
            data.
          nullable: true
        amortisation_rate_errors:
          type: array
          items:
            $ref: '#/components/schemas/AmortisationRateError'
          description: Failures collected while resolving amortisation-rate market data.
          nullable: true
        survival_curve_errors:
          type: array
          items:
            $ref: '#/components/schemas/SurvivalCurveError'
          description: Failures collected while resolving survival-curve market data.
          nullable: true
        swaption_vol_cube_errors:
          type: array
          items:
            $ref: '#/components/schemas/SwaptionVolCubeError'
          description: >-
            Failures collected while resolving swaption volatility-cube market
            data.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.MarketDataErrorSummary,
              Derivitec.Web.Core
      additionalProperties: false
      description: Market-data failures grouped by the affected data category.
    FilterBase:
      description: Base selection criterion for a named report-data field.
      discriminator:
        propertyName: $type
        mapping:
          Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core: '#/components/schemas/FilterMintlifyShape'
          Derivitec.Web.Core.Filters.FilterBase, Derivitec.Web.Core: '#/components/schemas/FilterBaseMintlifyShape'
          Derivitec.Web.Core.Filters.MultiFilter, Derivitec.Web.Core: '#/components/schemas/MultiFilter'
          Derivitec.Web.Core.Filters.StringFilter, Derivitec.Web.Core: '#/components/schemas/StringFilter'
      oneOf:
        - $ref: '#/components/schemas/FilterMintlifyShape'
        - $ref: '#/components/schemas/FilterBaseMintlifyShape'
        - $ref: '#/components/schemas/MultiFilter'
        - $ref: '#/components/schemas/StringFilter'
    BondVolSurfaceError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        futures_market_id:
          type: string
          description: Futures market whose bond volatility surface failed.
          nullable: true
        bond_short_name:
          type: string
          description: Short name of the bond whose volatility surface failed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.BondVolSurfaceError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies a bond volatility surface that could not be returned or
        processed.
    BondYieldCurveError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        currency:
          type: string
          description: Currency dimension of the curve that failed.
          nullable: true
        issuer_id:
          type: string
          description: Issuer selector.
          nullable: true
        debt_type:
          type: string
          description: >-
            Debt seniority or debt-type classification used to distinguish
            issuer curves.
          nullable: true
        issuer_name:
          type: string
          description: Issuer name included to locate the failed curve.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.BondYieldCurveError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies an issuer, currency, and debt-type curve that could not be
        returned or processed.
    BondYieldCurveSpreadError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        bond_id:
          type: string
          description: Bond selector.
          nullable: true
        isin:
          type: string
          description: ISIN included to locate the bond whose spread failed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.BondYieldCurveSpreadError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies a bond for which a curve spread could not be produced.
    CreditEventError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        bond_id:
          type: string
          description: Bond selector.
          nullable: true
        default_date:
          type: string
          description: Default date for this observation.
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.CreditEventError, Derivitec.Web.Core
      additionalProperties: false
      description: Identifies a bond and default date for credit-event processing failure.
    CmdtyVolSurfaceError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        commodity_id:
          type: string
          description: Commodity whose volatility-surface processing failed.
          nullable: true
        commodity_name:
          type: string
          description: Name of the commodity whose volatility surface failed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.CmdtyVolSurfaceError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies a commodity volatility surface that could not be returned or
        processed.
    CommodityError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        commodity_id:
          type: string
          description: Commodity whose data processing failed.
          nullable: true
        commodity_name:
          type: string
          description: Name of the commodity whose data processing failed.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.CommodityError, Derivitec.Web.Core
      additionalProperties: false
      description: Identifies commodity data that could not be returned or processed.
    CreditIndexCorrelationError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        index_id:
          type: string
          description: Credit index whose correlation processing failed.
          nullable: true
        index_name:
          type: string
          description: Name of the credit index whose correlation processing failed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.CreditIndexCorrelationError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies a credit index whose correlation data could not be processed.
    CreditSwaptionVolCubeError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        credit_id:
          type: string
          description: Credit index whose volatility-cube processing failed.
          nullable: true
        name:
          type: string
          description: Display name.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.CreditSwaptionVolCubeError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies a credit-swaption volatility cube that could not be returned
        or processed.
    DiscountCurveError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        currency:
          type: string
          description: Currency of the curve that could not be returned or processed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.DiscountCurveError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies a currency curve that could not be returned or processed.
    EquityAssetError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        asset_id:
          type: string
          description: Asset identifier of the affected equity.
          nullable: true
        asset_ric:
          type: string
          description: RIC recorded for the affected equity asset.
          nullable: true
        asset_x_ignite_code:
          type: string
          description: Xignite code recorded for the affected equity asset.
          nullable: true
        asset_edi_code:
          type: string
          description: EDI code recorded for the affected equity asset.
          nullable: true
        notes:
          type: string
          description: Diagnostic notes returned for the equity-asset failure.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.EquityAssetError, Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies an equity asset whose market data failed and carries
        diagnostic notes.
    EquityEquityCorrelationError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        asset1_id:
          type: string
          description: Asset identifier of the first equity in the failed pair.
          nullable: true
        asset1_name:
          type: string
          description: Display name of the first equity in the failed pair.
          nullable: true
        asset2_id:
          type: string
          description: Asset identifier of the second equity in the failed pair.
          nullable: true
        asset2_name:
          type: string
          description: Display name of the second equity in the failed pair.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.EquityEquityCorrelationError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies an equity pair for which correlation data failed.
    EquityFxCorrelationError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        eq_asset_id:
          type: string
          description: Asset identifier of the equity in the failed pair.
          nullable: true
        eq_asset_name:
          type: string
          description: Display name of the equity in the failed pair.
          nullable: true
        fx_cross_id:
          type: string
          description: FX-cross identifier in the failed pair.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.EquityFxCorrelationError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies an equity and FX cross for which correlation data failed.
    EqIRCorrelationError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        equity_id:
          type: string
          description: Equity identifier involved in the failed correlation lookup.
          nullable: true
        equity_name:
          type: string
          description: Display name of the equity involved in the failure.
          nullable: true
        fixing_instrument_id:
          type: string
          description: Interest-rate fixing-instrument code involved in the failure.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.EqIRCorrelationError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies an equity and fixing instrument for which
        equity-to-interest-rate correlation data failed.
    FxFxCorrelationError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        fx_cross1_id:
          type: string
          description: Identifier of the first FX cross in the failed pair.
          nullable: true
        fx_cross1_name:
          type: string
          description: Display name of the first FX cross in the failed pair.
          nullable: true
        fx_cross2_id:
          type: string
          description: Identifier of the second FX cross in the failed pair.
          nullable: true
        fx_cross2_name:
          type: string
          description: Display name of the second FX cross in the failed pair.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.FxFxCorrelationError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies an FX-pair combination for which correlation data failed.
    EquityVolIndexError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        eq_vol_index_id:
          type: string
          description: Identifier of the affected equity volatility index.
          nullable: true
        eq_vol_index_name:
          type: string
          description: Display name of the affected equity volatility index.
          nullable: true
        eq_vol_index_ric:
          type: string
          description: RIC recorded for the affected equity volatility index.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.EquityVolIndexError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies an equity volatility index whose market data failed.
    EquityVolIndexVolSurfaceError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        eq_vol_index_id:
          type: string
          description: Identifier of the affected equity volatility index.
          nullable: true
        eq_vol_index_ric:
          type: string
          description: RIC recorded for the affected equity volatility index.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.EquityVolIndexVolSurfaceError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies an equity volatility-index surface whose market data failed.
    EquityVolSurfaceError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        asset_id:
          type: string
          description: Asset identifier of the affected equity.
          nullable: true
        asset_ric:
          type: string
          description: RIC recorded for the affected equity.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.EquityVolSurfaceError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies an equity volatility surface whose market data failed.
    EquityVolOfVarCurveError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        eq_vol_of_var_index_id:
          type: string
          description: Identifier of the affected equity volatility-of-variance index.
          nullable: true
        eq_vol_of_var_index_ric:
          type: string
          description: RIC recorded for the affected equity volatility-of-variance index.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.EquityVolOfVarCurveError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies an equity volatility-of-variance curve whose market data
        failed.
    DividendIndexError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        dividend_index_id:
          type: string
          description: Dividend index whose processing failed.
          nullable: true
        dividend_index_name:
          type: string
          description: Name of the dividend index whose processing failed.
          nullable: true
        dividend_index_ric:
          type: string
          description: RIC of the dividend index whose processing failed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.DividendIndexError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies a dividend index whose data could not be returned or
        processed.
    DividendIndexVolSurfaceError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        dividend_index_id:
          type: string
          description: Dividend index whose volatility-surface processing failed.
          nullable: true
        dividend_index_ric:
          type: string
          description: RIC of the dividend index whose volatility surface failed.
          nullable: true
        futures_expiry_code:
          type: string
          description: >-
            Underlying futures expiry for a mid-curve option error; otherwise
            null or empty.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.DividendIndexVolSurfaceError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies a dividend-index volatility surface, including an underlying
        futures expiry when relevant, that could not be processed.
    FxVolOfVarCurveError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        fx_vol_of_var_index_id:
          type: string
          description: Identifier of the affected FX volatility-of-variance index.
          nullable: true
        fx_vol_of_var_index_ric:
          type: string
          description: RIC recorded for the affected FX volatility-of-variance index.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.FxVolOfVarCurveError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies an FX volatility-of-variance curve whose market data failed.
    FxCrossError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        fx_cross_id:
          type: string
          description: FX-cross identifier whose market data failed.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.FxCrossError, Derivitec.Web.Core
      additionalProperties: false
      description: Identifies an FX cross whose market data failed.
    FxVolSurfaceError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        fx_cross_id:
          type: string
          description: FX-cross identifier whose volatility surface failed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.FxVolSurfaceError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies an FX volatility surface whose market data failed.
    AndersenBuffumParametersError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        equity_id:
          type: string
          description: Equity whose parameter processing failed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.AndersenBuffumParametersError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies an equity whose Andersen–Buffum parameters could not be
        processed.
    IrFuturesVolCubeError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        futures_market_id:
          type: string
          description: Code of the futures market whose cube failed.
          nullable: true
        name:
          type: string
          description: Display name recorded for the failed interest-rate futures cube.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.IrFuturesVolCubeError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies an interest-rate futures volatility cube whose market data
        failed.
    RateAssetError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the rate-asset failure.
          nullable: true
        rate_asset_id:
          type: string
          description: Rate-asset identifier to which the failure applies.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.MarketData.RateAssetError, Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Interest-rate asset failure with its asset code, date, and diagnostic
        message.
    RecoveryRateError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        bond_id:
          type: string
          description: Bond identifier involved in the recovery-rate failure.
          nullable: true
        issuer_id:
          type: string
          description: Issuer identifier involved in the failure.
          nullable: true
        issuer_name:
          type: string
          description: Display name of the issuer involved in the failure.
          nullable: true
        debt_type:
          type: string
          description: Debt-type label involved in the failure.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.RecoveryRateError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies issuer, debt, and bond context for a recovery-rate failure.
    ProbabilityOfDefaultError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        asset_id:
          type: string
          description: Asset identifier whose probability-of-default data failed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.ProbabilityOfDefaultError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies an asset whose probability-of-default market data failed.
    AmortisationRateError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        asset_id:
          type: string
          description: Asset selector.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.AmortisationRateError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies an asset whose amortisation-rate input could not be
        processed.
    SurvivalCurveError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        currency:
          type: string
          description: Currency code involved in the survival-curve failure.
          nullable: true
        debt_type:
          type: string
          description: Debt-type label involved in the failure.
          nullable: true
        default_type:
          type: string
          description: Default-type label involved in the failure.
          nullable: true
        issuer_id:
          type: string
          description: Issuer identifier involved in the failure.
          nullable: true
        issuer_name:
          type: string
          description: Display name of the issuer involved in the failure.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.SurvivalCurveError,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Identifies issuer, currency, debt, and default context for a
        survival-curve failure.
    SwaptionVolCubeError:
      required:
        - $type
      type: object
      properties:
        message:
          type: string
          description: Diagnostic message explaining the market-data failure.
          nullable: true
        reference_date:
          type: string
          description: Market-data reference date to which the failure applies.
        rate_asset_id:
          type: string
          description: Rate-asset identifier whose swaption volatility cube failed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.MarketData.SwaptionVolCubeError,
              Derivitec.Web.Core
      additionalProperties: false
      description: Identifies a rate asset whose swaption volatility cube failed.
    FilterMintlifyShape:
      required:
        - $type
      type: object
      properties:
        field:
          type: string
          description: Name of the report-data field evaluated by this criterion.
          nullable: true
        type:
          type: string
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.Filters.Filter, Derivitec.Web.Core
      additionalProperties: false
    FilterBaseMintlifyShape:
      required:
        - $type
      type: object
      properties:
        field:
          type: string
          description: Name of the report-data field evaluated by this criterion.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.Filters.FilterBase, Derivitec.Web.Core
      additionalProperties: false
      description: Base selection criterion for a named report-data field.
    MultiFilter:
      required:
        - $type
      type: object
      properties:
        field:
          type: string
          description: Name of the report-data field evaluated by this criterion.
          nullable: true
        operator:
          enum:
            - not_set
            - and
            - or
          type: string
          description: Logical rule used to combine the child criteria.
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/FilterBase'
          description: >-
            Child criteria evaluated by the selected logical operator; nested
            groups are permitted.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.Filters.MultiFilter, Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Nested filter group that combines child criteria with a logical
        operator.
    StringFilter:
      required:
        - $type
      type: object
      properties:
        field:
          type: string
          description: Name of the report-data field evaluated by this criterion.
          nullable: true
        type:
          type: string
          nullable: true
        filter:
          type: string
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.Filters.StringFilter, Derivitec.Web.Core
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth2 access-token requested from AWS Cognito and provided as a Auth
        Bearer header
      flows:
        implicit:
          authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize
          scopes: {}
    apikey:
      type: apiKey
      description: API-Key requested via the site and provided as a header
      name: x-api-key
      in: header

````