> ## 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 the summary for a risk report run.

> Returns available run metadata and status without returning table or chart rows and without waiting for a
running report. The report run must be accessible to the current caller. Report, portfolio, market-data,
restriction, user, and organisation context are server-managed.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/RiskReport/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/RiskReport/GetReportInfoById:
    post:
      tags:
        - RiskReport
      summary: Retrieve the summary for a risk report run.
      description: >-
        Returns available run metadata and status without returning table or
        chart rows and without waiting for a

        running report. The report run must be accessible to the current caller.
        Report, portfolio, market-data,

        restriction, user, and organisation context are server-managed.
      operationId: GetReportInfoById
      requestBody:
        description: >-
          The body containing the required opaque risk report-run `ReportId`.
          Row filter, portfolio type, available portfolio types, market-data
          environment, restriction, and caller fields are server-managed rather
          than client-selected access controls.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetRiskReportInfoByIdRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetRiskReportInfoByIdRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetRiskReportInfoByIdRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetRiskReportInfoByIdRequest'
      responses:
        '200':
          description: >-
            Returns the risk run summary, including run and portfolio identity,
            dates, status, reporting currency, and environment names, or an
            unsuccessful envelope with no summary when unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetRiskReportInfoByIdResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetRiskReportInfoByIdRequest:
      required:
        - $type
      type: object
      additionalProperties: false
      description: Selector for retrieving one risk report-run summary by run identifier.
      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
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiGetRiskReportInfoByIdRequest,
              Derivitec.Web.Core
    ApiGetRiskReportInfoByIdResponse:
      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/RiskReportInfo'
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiGetRiskReportInfoByIdResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Response envelope containing one risk report-run summary.
    RiskReportInfo:
      required:
        - $type
      type: object
      properties:
        description:
          type: string
          description: >-
            Human-readable description associated with the report definition or
            run.
          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
        reporting_currency:
          type: string
          description: >-
            Currency used to express monetary report values; the code format is
            not constrained here.
          nullable: true
        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.
        report_definition_id:
          type: string
          description: Opaque identifier for the report definition.
          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
        time_stamp:
          type: string
          description: >-
            Timestamp recorded for the report run; no time-zone convention is
            established by this contract.
          format: date-time
        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
        run_by_user:
          type: string
          description: User display value recorded as having run or scheduled the report.
          nullable: true
        $type:
          type: string
          enum:
            - Derivitec.Web.Core.Reports.RiskReportInfo, Derivitec.Web.Core
      additionalProperties: false
      description: Summary of a risk report run.
  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

````