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

# Start a full database view export from a structured request.

> Start a full database view export from a structured request. The request is scoped to the authenticated instance and enforces View access and lifecycle state.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/databases/views/{databaseViewId}/exportData
openapi: 3.0.0
info:
  title: RevoEngine Platform API
  description: Official RevoEngine Platform API documentation.
  version: 1.5.1
  contact:
    name: Support
    email: support@revoengine.com
  termsOfService: https://docs.revoengine.com/tos
servers:
  - url: https://api.revoengine.com
    description: Production
security: []
tags:
  - name: Accounts
    description: Users, service accounts, API keys, status, and platform access.
    externalDocs:
      description: Identity and access guide
      url: https://docs.revoengine.com/operate/identity-and-access
  - name: Activity
    description: Snapshot-backed activity and version history.
    externalDocs:
      description: Observability guide
      url: https://docs.revoengine.com/operate/observability
  - name: Agent Memory
    description: Administrative access to durable Agent memory.
    externalDocs:
      description: Agent memory and workspaces guide
      url: https://docs.revoengine.com/ai/memory-and-workspaces
  - name: Agent Plugins
    description: Agent plugin definitions, synchronization, testing, and lifecycle.
    externalDocs:
      description: Agent plugins guide
      url: https://docs.revoengine.com/ai/plugins
  - name: Agents
    description: >-
      Agent definitions, runs, sessions, inboxes, memory, tools, workspaces, and
      lifecycle.
    externalDocs:
      description: Autonomous Agents guide
      url: https://docs.revoengine.com/ai/agents
  - name: Assistant
    description: >-
      Assistant threads, messages, responses, goals, reports, sharing,
      attachments, and control.
    externalDocs:
      description: Assistant guide
      url: https://docs.revoengine.com/ai/assistant
  - name: Automation
    description: >-
      Jobs, templates, schedules, events, webhooks, execution history, and
      lifecycle.
    externalDocs:
      description: Automation guide
      url: https://docs.revoengine.com/operate/automation
  - name: Chat
    description: Collaborative chat threads, messages, reactions, uploads, and attachments.
    externalDocs:
      description: Team Chat guide
      url: https://docs.revoengine.com/operate/chat
  - name: Component deployments
    description: >-
      Custom Node.js runtime deployment attempts, readiness, activation, and
      rollback.
    externalDocs:
      description: Custom Node.js guide
      url: https://docs.revoengine.com/build/custom-nodejs
  - name: Components
    description: Components, elements, versions, validation, activation, and lifecycle.
    externalDocs:
      description: Components guide
      url: https://docs.revoengine.com/build/components
  - name: Config
    description: Instance configuration, usage, logs, and cache administration.
    externalDocs:
      description: Instance settings guide
      url: https://docs.revoengine.com/platform/instance-settings
  - name: Database Cache
    description: Instance Database cache values and statistics.
    externalDocs:
      description: Database Cache guide
      url: https://docs.revoengine.com/operate/database-cache
  - name: Database Views
    description: Database Views, previews, refreshes, exports, and controlled data actions.
    externalDocs:
      description: Database Views guide
      url: https://docs.revoengine.com/operate/database-views
  - name: Databases
    description: Database definitions, data, audits, exports, cloning, and lifecycle.
    externalDocs:
      description: Databases guide
      url: https://docs.revoengine.com/operate/databases
  - name: Endpoints
    description: >-
      Endpoint definitions, activation, validation, generated OpenAPI, and
      statistics.
    externalDocs:
      description: Endpoints guide
      url: https://docs.revoengine.com/operate/endpoints
  - name: Files
    description: Compatibility file listing, preview, download, and deletion operations.
    externalDocs:
      description: Files compatibility guide
      url: https://docs.revoengine.com/operate/files
  - name: Groups
    description: Groups, membership, avatars, and lifecycle.
    externalDocs:
      description: Groups guide
      url: https://docs.revoengine.com/operate/groups
  - name: Me
    description: Current user profile, keys, avatar, and session information.
    externalDocs:
      description: Authentication guide
      url: https://docs.revoengine.com/developers/authentication
  - name: Preferences
    description: User and instance preference values.
    externalDocs:
      description: Platform UI guide
      url: https://docs.revoengine.com/platform/ui-tour
  - name: Role Groups
    description: Role groups, members, assigned roles, and lifecycle.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Roles
    description: Available platform roles and role details.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Search
    description: Cross-domain search over objects visible to the caller.
    externalDocs:
      description: Search and discovery guide
      url: https://docs.revoengine.com/platform/search
  - name: Secrets
    description: >-
      Secret definitions, revisions, activation, reveal, disable, and
      destruction.
    externalDocs:
      description: Secrets guide
      url: https://docs.revoengine.com/operate/secrets
  - name: Storage
    description: >-
      Storage workspaces, folders, objects, upload sessions, signed access, and
      lifecycle.
    externalDocs:
      description: Storage guide
      url: https://docs.revoengine.com/operate/storage
externalDocs:
  description: Documentation
  url: https://docs.revoengine.com
paths:
  /api/v1/databases/views/{databaseViewId}/exportData:
    post:
      tags:
        - Database Views
      summary: Start a full database view export from a structured request.
      description: >-
        Start a full database view export from a structured request. The request
        is scoped to the authenticated instance and enforces View access and
        lifecycle state.
      operationId: DatabaseViewController_exportDataRequest
      parameters:
        - name: databaseViewId
          required: true
          in: path
          description: Provide databaseViewId.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatabaseExportBodyRequestDto'
      responses:
        '202':
          description: Export accepted.
        '403':
          description: Forbidden.
        '404':
          description: Not found.
      security:
        - bearer: []
components:
  schemas:
    DatabaseExportBodyRequestDto:
      type: object
      properties:
        count:
          type: boolean
          description: >-
            Include the total count in the response envelope. Accepts boolean
            query values such as true or false.
          example: true
        filter:
          type: object
          description: Structured QueryWrapper filter tree.
          example: >-
            {"and":[{"field":"name","op":"ilike","value":"Ops"},{"field":"deletedAt","op":"isNull"}]}
        sort:
          description: Structured sort definition or ordered sort fields.
          example: '{"name":"ASC","lastUpdateAt":"DESC"}'
          oneOf:
            - type: object
            - type: array
              items:
                type: string
        distinct:
          type: array
          description: Structured distinct field selection.
          example: category,global
          items:
            type: string
        fields:
          type: array
          description: Selected plain or computed QueryWrapper fields.
          example: >-
            ["databaseId","name",{"fn":"COUNT","args":["users.userId"],"as":"userCount","filterType":"number"}]
          items:
            oneOf:
              - type: string
              - type: object
                additionalProperties: true
        joins:
          type: array
          description: Structured dynamic database joins.
          example: >-
            [{"table":"groups_users","alias":"gu","type":"left","on":{"left":"gu.groupsGroupId","op":"=","right":"g.groupId"}}]
          items:
            type: object
            additionalProperties: true
        groupBy:
          type: array
          description: Structured group-by field selection.
          example: '["category","global"]'
          items:
            type: string
        cast:
          type: object
          description: Structured selected-field cast mapping.
          example: '{"userCount":"INTEGER"}'
        with:
          type: array
          description: Structured CTE definitions when the export source permits them.
          example: >-
            [{"name":"active_groups","query":{"from":{"table":"groups","alias":"g","definition":[]}}}]
          items:
            type: object
            additionalProperties: true
        debug:
          type: boolean
          description: >-
            Enable QueryWrapper debug output for the request, including compiled
            SQL, bound params, and bounded EXPLAIN plans when the underlying
            query service supports it.
          example: false
        join:
          type: object
          description: Legacy dynamic database join map.
          example: '{"orders":["customerId","customerId","left"]}'
        format:
          type: string
          description: >-
            Output format. CSV remains the default; XLSX uses the native
            streaming Storage writer.
          enum:
            - csv
            - xlsx
          example: xlsx
          default: csv
        retention:
          description: >-
            Export file retention. Omit for the destination default, set null
            for no expiration, or provide exactly one of ttlSeconds and
            expiresAt.
          nullable: true
          example:
            ttlSeconds: 604800
          type: object
          allOf:
            - $ref: '#/components/schemas/StorageRetentionDto'
        delimiter:
          type: string
          description: >-
            CSV field delimiter. Defaults to a comma and must contain fewer than
            10 characters.
          example: '|'
        boolType:
          type: string
          description: CSV boolean representation.
          example: boolean
          enum:
            - emoji
            - number
            - boolean
        emptyNull:
          type: boolean
          description: Write null values as empty CSV fields instead of the string null.
          example: true
        encodedJson:
          type: boolean
          description: Base64-encode JSON and JSONB values in the CSV output.
          example: false
        storageDestination:
          type: string
          description: >-
            Optional storage destination. Omit to retain the private per-user
            export namespace, use ROOT for the explorer root, or provide an
            accessible explorer folder storageEntryId.
          example: ROOT
        fileName:
          type: string
          description: >-
            Dedicated export file name. Path separators are not allowed. Omit to
            generate a database-and-timestamp name with the selected format
            extension.
          example: contracts-full.xlsx
        restricted:
          type: boolean
          description: >-
            Whether the exported storage entry is restricted. Defaults to true.
            Restricted ancestors still apply when exporting into a folder.
          example: false
          default: true
    StorageRetentionDto:
      type: object
      properties:
        ttlSeconds:
          type: number
          description: >-
            Positive lifetime in seconds. The lifetime starts when the file is
            finalized.
          minimum: 1
        expiresAt:
          type: string
          description: Absolute future expiration timestamp in ISO 8601 format.
          example: '2026-08-01T12:00:00.000Z'
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      description: Bearer JWT token or API Key (sk-*).
      type: http

````