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

# Baixar um relatório

> Baixa o arquivo do relatório gerado.



## OpenAPI

````yaml pt/openapi/v3-current/reporter.yaml get /v1/reports/{id}/download
openapi: 3.1.0
info:
  contact:
    name: Discord community
    url: https://discord.gg/DnhqKwkGv3
  description: >-
    Esta é a documentação OpenAPI do Reporter. O binário unificado do Reporter
    serve a API REST (RUN_MODE=api) e/ou o worker de geração de relatórios do
    RabbitMQ (RUN_MODE=worker); RUN_MODE=all executa ambos em um único processo
    para desenvolvimento local. Todos os endpoints REST documentados aqui são
    servidos somente quando RUN_MODE=api ou all (porta :4005); o worker (porta
    :4006) expõe apenas health/readyz.
  license:
    name: Lerian Studio General License
  title: API do Midaz Reporter
  version: 4.0.0
servers:
  - url: http://localhost:4005
  - url: https://localhost:4005
security:
  - BearerAuth: []
tags:
  - description: Instâncias de relatórios gerados e seu ciclo de vida.
    name: Reports
  - description: Definições reutilizáveis de relatórios.
    name: Templates
  - description: Construção interativa de templates de relatório.
    name: Template Builder
  - description: Acompanhamento de datas de vencimento de relatórios agendados.
    name: Deadlines
  - description: Entradas configuradas que fornecem dados para relatórios.
    name: Data Sources
  - description: Métricas agregadas de relatórios.
    name: Metrics
  - description: Catálogo de eventos de negócio publicados e políticas de entrega.
    name: Streaming
paths:
  /v1/reports/{id}/download:
    get:
      tags:
        - Reports
      summary: Baixar um relatório
      description: Baixa o arquivo do relatório gerado.
      operationId: downloadReport
      parameters:
        - description: ID do relatório
          example: 00000000-0000-0000-0000-000000000000
          in: path
          name: id
          required: true
          schema:
            description: ID do relatório
            type: string
      responses:
        '200':
          content:
            application/pdf:
              schema:
                contentMediaType: application/octet-stream
                format: binary
                type: string
            application/xml:
              schema:
                contentMediaType: application/octet-stream
                format: binary
                type: string
            text/csv:
              schema:
                contentMediaType: application/octet-stream
                format: binary
                type: string
            text/html:
              schema:
                contentMediaType: application/octet-stream
                format: binary
                type: string
            text/plain:
              schema:
                contentMediaType: application/octet-stream
                format: binary
                type: string
          description: Arquivo do relatório gerado
          headers:
            Content-Disposition:
              schema:
                description: Nome do arquivo do anexo
                type: string
            Content-Type:
              schema:
                description: Tipo de mídia do relatório gerado
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Requisição inválida
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Não autorizado
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Proibido
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Não encontrado
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Entidade não processável
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro interno do servidor
        '503':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Serviço indisponível
components:
  schemas:
    Detail:
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, no escopo
            do serviço emissor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: Explicação legível específica para esta ocorrência do problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalhes individuais do erro
          examples:
            - - location: body.templateId
                message: expected string to match 'uuid' format
                value: not-a-uuid
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: Referência URI que identifica a ocorrência específica do problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de status HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Resumo curto e legível do tipo de problema. Esse valor não deve
            mudar entre ocorrências do erro.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: Referência URI para a documentação legível do erro.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ErrorDetail:
      properties:
        location:
          description: >-
            Local em que o erro ocorreu, por exemplo, 'body.items[3].tags' ou
            'path.thing-id'
          examples:
            - body.templateId
          type: string
        message:
          description: Texto da mensagem de erro
          examples:
            - expected string to match 'uuid' format
          type: string
        value:
          description: O valor no local informado
          examples:
            - not-a-uuid
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: Token bearer JWT emitido pelo provedor de identidade.
      scheme: bearer
      type: http

````