> ## 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.

# Check a risk report run's current status.

> Returns a point-in-time status for an authorised report run. Use the run identifier returned by the
deprecated `RunReport` operation to poll this snapshot. The possible status values are `None`,
`Succeeded`, `Failed`, `Running`, and `Warning`; no wait interval or cancellation input is
provided.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/Report/GetReportStatusById
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/Report/GetReportStatusById:
    post:
      tags:
        - Report
      summary: Check a risk report run's current status.
      description: >-
        Returns a point-in-time status for an authorised report run. Use the run
        identifier returned by the

        deprecated `RunReport` operation to poll this snapshot. The possible
        status values are `None`,

        `Succeeded`, `Failed`, `Running`, and `Warning`; no wait interval or
        cancellation input is

        provided.
      operationId: GetReportStatusById
      requestBody:
        description: >-
          The body containing the required opaque report-run `ReportId` and
          optional `PortfolioType` and `RowFilter`. Caller identity,
          organisation, time zone, and market-data context are server-managed.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiGetReportStatusByIdRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiGetReportStatusByIdRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiGetReportStatusByIdRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiGetReportStatusByIdRequest'
      responses:
        '200':
          description: >-
            Returns the report run's current status in the normal response
            envelope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiGetReportStatusByIdResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetReportStatusByIdRequest:
      required:
        - $type
      type: object
      additionalProperties: false
      description: Selector for checking the current state of one report run.
      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.ApiGetReportStatusByIdRequest,
              Derivitec.Web.Core
    ApiGetReportStatusByIdResponse:
      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
        status:
          enum:
            - none
            - succeeded
            - failed
            - running
            - warning
          type: string
          description: Lifecycle state recorded for the report run or scheduled item.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiGetReportStatusByIdResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Current state returned for the selected 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

````