> ## 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 VaR run information by run identifier.

> Looks up VaR run information using `ReportId`. Caller, organisation, access, and effective restriction
context are server-managed; unavailable metadata is reported through the response envelope.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/VarReport/GetReportInfoById
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/VarReport/GetReportInfoById:
    post:
      tags:
        - VarReport
      summary: Retrieve VaR run information by run identifier.
      description: >-
        Looks up VaR run information using `ReportId`. Caller, organisation,
        access, and effective restriction

        context are server-managed; unavailable metadata is reported through the
        response envelope.
      operationId: GetReportInfoById
      requestBody:
        description: >-
          The body containing the opaque `ReportId`; it may also carry optional
          `PortfolioType`, `ConfidenceLevel`, `RowQuery`, and
          `WeightingVarDefinition`, while the run identifier determines this
          lookup.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetVarReportInfoByIdRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetVarReportInfoByIdRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetVarReportInfoByIdRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetVarReportInfoByIdRequest'
      responses:
        '200':
          description: >-
            Returns information for the identified VaR report run, or an
            unsuccessful response envelope when it is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetVarReportInfoByIdResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetVarReportInfoByIdRequest:
      required:
        - $type
      type: object
      additionalProperties: false
      description: Selector for retrieving one VaR report-run summary by run identifier.
      properties:
        confidence_level:
          type: number
          description: >-
            Optional VaR confidence-level override expressed as a decimal
            fraction; null retains the report's configured level.
          format: double
          nullable: true
          example: 0.99
        row_query:
          $ref: '#/components/schemas/FilterBase'
        weighting_var_definition:
          $ref: '#/components/schemas/WeightingVarDefinition'
        row_restriction_filter:
          $ref: '#/components/schemas/FilterBase'
        full_report_filter:
          $ref: '#/components/schemas/MultiFilter'
        report_configuration:
          $ref: '#/components/schemas/VarReportConfiguration'
        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
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdRequest,
              Derivitec.Web.Core
    ApiGetVarReportInfoByIdResponse:
      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
        report_info:
          $ref: '#/components/schemas/VarReportInfo'
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiGetVarReportInfoByIdResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Response envelope containing one VaR report-run summary.
    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'
    WeightingVarDefinition:
      required:
        - $type
      type: object
      properties:
        active:
          type: boolean
          description: Whether the VaR weighting configuration is enabled.
        window_length:
          type: integer
          description: Window-length value; no unit is established here.
          format: int32
        decay_period:
          type: integer
          description: Decay-period value; no unit is established here.
          format: int32
        scheme:
          enum:
            - exponentially_weighted
            - filtered_historical
          type: string
          description: Weighting scheme selected for the historical VaR configuration.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.WeightingVarDefinition,
              Derivitec.Web.Core
      additionalProperties: false
      description: Configuration used to select VaR weighting behaviour.
    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.
    VarReportConfiguration:
      required:
        - $type
      type: object
      properties:
        name:
          type: string
          description: Display name for this report-query or export configuration.
          nullable: true
          example: Default
        row_query:
          $ref: '#/components/schemas/FilterBase'
        confidence_level:
          type: number
          description: >-
            Optional VaR confidence-level override expressed as a decimal
            fraction; null retains the report's configured level.
          format: double
          nullable: true
          example: 0.99
        weighting_var_definition:
          $ref: '#/components/schemas/WeightingVarDefinition'
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.VarReportConfiguration, Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Optional named overrides used when querying or exporting a historical
        VaR report.
    VarReportInfo:
      required:
        - $type
      type: object
      properties:
        confidence_level:
          type: number
          description: >-
            Confidence level associated with the VaR report; no scale is
            established here.
          format: double
        first_observation_date:
          type: string
          description: >-
            Explicit first historical observation date, when supplied or
            recorded.
          format: date-time
          nullable: true
        historical_start_date_rule:
          type: string
          description: Rule selected for resolving the first historical observation date.
          nullable: true
        id:
          type: string
          description: Opaque identifier of the report run.
          nullable: true
        mkt_data_date:
          type: string
          description: Market-data date used or recorded for the report run.
          format: date-time
        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
        pricing_date:
          type: string
          description: >-
            Date used to price positions for the report; no time-zone convention
            is established by this contract.
          format: date-time
        real_time_mkt_data:
          type: boolean
          description: Whether the report uses the exposed real-time market-data selection.
        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
        report_definition_id:
          type: string
          description: Opaque identifier for the report definition.
          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
        time_stamp:
          type: string
          description: >-
            Timestamp recorded for the report run; no time-zone convention is
            established by this contract.
          format: date-time
        var_horizon:
          type: integer
          description: Horizon recorded for the VaR report; no unit is established here.
          format: int32
        portfolio_type:
          enum:
            - derivitec
            - enfusion
            - orchestrade
            - liquidity_book
            - maia
            - fund_studio
            - not_set
          type: string
          description: >-
            Portfolio category recorded for the report run or saved launcher
            item.
        market_data_provider_ids:
          type: array
          items:
            type: string
          description: >-
            Opaque identifiers of market-data providers associated with the
            report run.
          nullable: true
        market_data_environment_names:
          type: array
          items:
            type: string
          description: >-
            Names of market-data environments associated with the report run or
            saved launcher item.
          nullable: true
        weighting_var_definition:
          $ref: '#/components/schemas/WeightingVarDefinition'
        last_observation_date:
          type: string
          description: >-
            Explicit last historical observation date, when supplied or
            recorded.
          format: date-time
          nullable: true
        historical_end_date_rule:
          type: string
          description: Rule selected for resolving the last historical observation date.
          nullable: true
        portfolio_date_time:
          type: string
          description: >-
            Portfolio snapshot date and time used or recorded for the report; no
            time-zone convention is established here.
          format: date-time
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.Reports.VarReportInfo, Derivitec.Web.Core
      additionalProperties: false
      description: Summary of a VaR report run.
    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.
    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

````