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

# Create a temporary download for a report Excel export.

> Creates the workbook synchronously and, on success, returns a generated export identifier and download
URL. The temporary download remains available for five minutes and is separate from the report-run
identifier. Only `ReportId` and `IncludePivotTable` affect this action.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /Export/Excel/Create
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:
  /Export/Excel/Create:
    post:
      tags:
        - Report
      summary: Create a temporary download for a report Excel export.
      description: >-
        Creates the workbook synchronously and, on success, returns a generated
        export identifier and download

        URL. The temporary download remains available for five minutes and is
        separate from the report-run

        identifier. Only `ReportId` and `IncludePivotTable` affect this action.
      operationId: ExportToExcel
      requestBody:
        description: >-
          The body containing the opaque `ReportId` and `IncludePivotTable`,
          which defaults to `false`.
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiExportReportAsExcelRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiExportReportAsExcelRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiExportReportAsExcelRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiExportReportAsExcelRequest'
      responses:
        '200':
          description: >-
            Returns the temporary export identifier and download URL, or an
            unsuccessful response envelope with export messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiExportReportToExcelResponse'
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiExportReportAsExcelRequest:
      description: >-
        Report-run, format, and filter selections for requesting an Excel
        export.
      discriminator:
        propertyName: $type
        mapping:
          Derivitec.Web.Core.Reports.ApiExportReportAsExcelRequest, Derivitec.Web.Core: '#/components/schemas/ApiExportReportAsExcelRequestMintlifyShape'
          Derivitec.Web.Core.Reports.ApiExportHistoricalPnlReportAsExcelRequest, Derivitec.Web.Core: '#/components/schemas/ApiExportHistoricalPnlReportAsExcelRequest'
      oneOf:
        - $ref: '#/components/schemas/ApiExportReportAsExcelRequestMintlifyShape'
        - $ref: '#/components/schemas/ApiExportHistoricalPnlReportAsExcelRequest'
    ApiExportReportToExcelResponse:
      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
        download_url:
          type: string
          description: >-
            Temporary download location when export creation succeeds; otherwise
            no location is returned.
          nullable: true
        export_id:
          type: string
          description: >-
            Opaque temporary-export identifier when export creation succeeds;
            otherwise no identifier is returned.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiExportReportToExcelResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: Response envelope for creating a temporary report export.
    ApiExportReportAsExcelRequestMintlifyShape:
      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
        include_pivot_table:
          type: boolean
          description: Whether the exported workbook should include the report pivot table.
        prefilter:
          $ref: '#/components/schemas/FilterBase'
        request_id:
          type: string
          description: >-
            Client-generated identifier for the export request; it is not a
            report-run identifier.
          nullable: true
        report_type:
          enum:
            - risk
            - var
            - pnl
            - time_series
          type: string
          description: >-
            Report category that selects the applicable result or metadata
            shape.
        legacy_view_state:
          $ref: '#/components/schemas/LegacyExportViewState'
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiExportReportAsExcelRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Report-run, format, and filter selections for requesting an Excel
        export.
    ApiExportHistoricalPnlReportAsExcelRequest:
      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
        include_pivot_table:
          type: boolean
          description: Whether the exported workbook should include the report pivot table.
        prefilter:
          $ref: '#/components/schemas/FilterBase'
        request_id:
          type: string
          description: >-
            Client-generated identifier for the export request; it is not a
            report-run identifier.
          nullable: true
        report_type:
          enum:
            - risk
            - var
            - pnl
            - time_series
          type: string
          description: >-
            Report category that selects the applicable result or metadata
            shape.
        legacy_view_state:
          $ref: '#/components/schemas/LegacyExportViewState'
        observation_date:
          type: string
          description: Observation date of the historical P&L report selected for export.
          format: date-time
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.Reports.ApiExportHistoricalPnlReportAsExcelRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        Observation-date selection for exporting a historical P&L report to
        Excel.
    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'
    LegacyExportViewState:
      required:
        - $type
      type: object
      properties:
        table_id:
          type: string
          description: Table whose state this is.
          nullable: true
        filters:
          type: array
          items:
            $ref: '#/components/schemas/LegacyTableFilterWire'
          description: Filter conditions.
          nullable: true
        sorts:
          type: array
          items:
            $ref: '#/components/schemas/LegacyTableSortWire'
          description: Ordered sort instructions.
          nullable: true
        active_pivot_keys:
          type: array
          items:
            type: string
          description: Pivot keys to activate, in order.
          nullable: true
        expanded_paths:
          type: array
          items:
            $ref: '#/components/schemas/LegacyTablePivotPathWire'
          description: Expanded pivot paths.
          nullable: true
        expansion_depth:
          type: integer
          description: Depth every node should be expanded to.
          format: int32
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.LegacyReportQuery.LegacyExportViewState,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        The grid state a current-view export must reproduce. Null means "export
        the default view".
    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
    LegacyTableFilterWire:
      required:
        - $type
      type: object
      properties:
        column_key:
          type: string
          description: >-
            The key of the column to filter, as given by the table definition. A
            column the

            definition does not mark filterable is rejected rather than ignored.
          nullable: true
        operator:
          enum:
            - is_equal_to
            - is_not_equal_to
            - starts_with
            - ends_with
            - contains
            - is_greater_than
            - is_greater_than_or_equal_to
            - is_less_than
            - is_less_than_or_equal_to
          type: string
          description: >-
            The comparison to apply. An operator the column does not list as
            supported is

            rejected rather than ignored.
        value:
          type: string
          description: >-
            The value to compare against, formatted culture-invariantly: a
            round-trip ISO

            timestamp for a date column, and a plain decimal point for a numeric
            one.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.LegacyReportQuery.LegacyTableFilterWire,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        One filter condition on one column. The legacy grid allowed a single
        condition per column,

        and conditions across columns combine with AND.
    LegacyTableSortWire:
      required:
        - $type
      type: object
      properties:
        column_key:
          type: string
          description: >-
            The key of the column to sort by, as given by the table definition.
            A column the

            definition does not know is rejected rather than ignored.
          nullable: true
        descending:
          type: boolean
          description: >-
            Whether to sort descending rather than ascending. Sorting is by
            signed value; sorting

            by absolute value is not offered for this table.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.LegacyReportQuery.LegacyTableSortWire,
              Derivitec.Web.Core
      additionalProperties: false
      description: One sort instruction on one column.
    LegacyTablePivotPathWire:
      required:
        - $type
      type: object
      properties:
        path:
          type: array
          items:
            type: string
          description: >-
            The pivot values from the root down, one per level. Values are the
            displayed strings,

            which is what identifies a group: positional indexes shift whenever
            the sort or filter

            changes, so they are never exchanged.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.LegacyReportQuery.LegacyTablePivotPathWire,
              Derivitec.Web.Core
      additionalProperties: false
      description: One expanded pivot path, as pivot value strings from the root down.
  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

````