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

# Subir una plantilla

> Usa este endpoint para cargar una nueva plantilla en el sistema. Acepta un archivo `.tpl` que define la estructura y la lógica del informe.

El archivo debe tener el formato del tipo de salida deseado (HTML, XML, CSV, PDF o TXT) y utilizar los bloques del plugin [Reporter](/es/reporter) cuando corresponda.

Independientemente del formato, el archivo **siempre** debe guardarse con la extensión `.tpl` para que la plantilla funcione correctamente.

<Tip>
  ¿Necesitas un ejemplo para probar este punto de conexión?  <b><a href="https://drive.google.com/file/d/1i8QP2Uk4ZGMy7Zk28b_c9e2Zwb9i65-X/view?usp=sharing" target="_blank" rel="noopener noreferrer">Haz clic aquí para descargar un archivo .tpl de ejemplo.</a></b>
</Tip>


## OpenAPI

````yaml es/openapi/v3-current/reporter.yaml post /v1/templates
openapi: 3.1.0
info:
  contact:
    name: Discord community
    url: https://discord.gg/DnhqKwkGv3
  description: >-
    Esta es la documentación OpenAPI de Reporter. El binario unificado de
    Reporter ejecuta la API REST (RUN_MODE=api), el worker de generación de
    informes de RabbitMQ (RUN_MODE=worker) o ambos; RUN_MODE=all ejecuta los dos
    en un único proceso para el desarrollo local. Todos los endpoints REST
    documentados aquí solo están disponibles cuando RUN_MODE=api o RUN_MODE=all
    (puerto :4005); el worker (puerto :4006) expone únicamente los endpoints de
    health y readyz.
  license:
    name: Lerian Studio General License
  title: Midaz Reporter API
  version: 4.0.0
servers:
  - url: http://localhost:4005
  - url: https://localhost:4005
security:
  - BearerAuth: []
tags:
  - description: Instancias de informes generados y su ciclo de vida.
    name: Informes
  - description: Definiciones de informes reutilizables.
    name: Plantillas
  - description: Creación interactiva de plantillas de informes.
    name: Constructor de plantillas
  - description: Seguimiento de las fechas de vencimiento de informes programados.
    name: Plazos
  - description: Entradas configuradas que proporcionan datos a los informes.
    name: Fuentes de datos
  - description: Métricas agregadas de informes.
    name: Métricas
  - description: Catálogo publicado de eventos de negocio y políticas de entrega.
    name: Streaming
paths:
  /v1/templates:
    post:
      tags:
        - Plantillas
      summary: Subir una plantilla
      description: >-
        Usa este endpoint para cargar una nueva plantilla en el sistema. Acepta
        un archivo `.tpl` que define la estructura y la lógica del informe.


        El archivo debe tener el formato del tipo de salida deseado (HTML, XML,
        CSV, PDF o TXT) y utilizar los bloques del plugin
        [Reporter](/es/reporter) cuando corresponda.


        Independientemente del formato, el archivo **siempre** debe guardarse
        con la extensión `.tpl` para que la plantilla funcione correctamente.
      operationId: createTemplate
      parameters:
        - description: >-
            Clave de idempotencia proporcionada por el cliente que evita la
            creación duplicada de plantillas.
          example: template-request-2026-01
          in: header
          name: X-Idempotency
          schema:
            description: >-
              Clave de idempotencia proporcionada por el cliente que evita la
              creación duplicada de plantillas.
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                description:
                  description: Descripción legible de la plantilla.
                  examples:
                    - Monthly financial report
                  type: string
                outputFormat:
                  description: Formato de salida del informe generado.
                  examples:
                    - html
                  type: string
                template:
                  contentMediaType: application/octet-stream
                  description: Archivo de plantilla Pongo2.
                  examples:
                    - monthly-report.tpl
                  format: binary
                  type: string
              required:
                - description
                - outputFormat
                - template
              type: object
        description: Formulario multipart de la plantilla.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateResponse'
          description: Creado
          headers:
            X-Idempotency-Replayed:
              schema:
                description: >-
                  Se establece en `true` cuando la respuesta reproduce una
                  solicitud idempotente completada.
                examples:
                  - 'true'
                type:
                  - string
                  - 'null'
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Solicitud incorrecta
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: No autorizado
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Prohibido
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Conflicto
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Entidad no procesable
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error interno del servidor
components:
  schemas:
    TemplateResponse:
      properties:
        createdAt:
          description: Marca de tiempo que indica cuándo se creó la plantilla.
          examples:
            - '2021-01-01T00:00:00Z'
          format: date-time
          type: string
        description:
          description: Descripción breve de la plantilla. Opcional.
          examples:
            - Monthly financial report
          type: string
        fileName:
          description: >-
            Nombre del archivo de plantilla tal como está guardado en el
            sistema. Sigue el formato `<template_id>.tpl`.
          examples:
            - 0196159b-4f26-7300-b3d9-f4f68a7c85f3_1744119295.tpl
          type: string
        id:
          description: ID único que identifica la plantilla (formato UUID).
          examples:
            - 00000000-0000-0000-0000-000000000000
          type: string
        outputFormat:
          description: Formato de salida generado (por ejemplo, HTML, CSV, PDF, TXT, XML).
          examples:
            - HTML
          type: string
        updatedAt:
          description: >-
            Marca de tiempo que indica la última vez que se actualizó la
            plantilla.
          examples:
            - '2021-01-01T00:00:00Z'
          format: date-time
          type: string
        warnings:
          description: >-
            Se devuelve cuando la validación de esquema no pudo validar
            completamente una o más fuentes de datos referenciadas por la
            plantilla. La operación de creación o actualización se completa de
            todas formas. Ausente cuando no se produjeron advertencias.
          examples:
            - - code: DATA_SOURCE_UNAVAILABLE
                field: account.balance
                message: data source is temporarily unavailable
          items:
            $ref: '#/components/schemas/ValidationWarning'
          type:
            - array
            - 'null'
      type: object
    Detail:
      properties:
        code:
          description: >-
            Código de error de dominio estable y legible por máquina, limitado
            al servicio emisor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: Explicación legible específica de esta instancia del problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalles individuales del error
          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: Referencia URI que identifica la instancia específica del problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de estado HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Resumen breve y legible del tipo de problema. Este valor no debe
            cambiar entre instancias del error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: Referencia URI a la documentación legible del error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ValidationWarning:
      properties:
        code:
          description: Código de advertencia legible por máquina.
          examples:
            - DATA_SOURCE_UNAVAILABLE
          type: string
        field:
          description: >-
            Referencia al campo o a la fuente de datos afectada por la
            advertencia.
          examples:
            - customers.email
          type: string
        message:
          description: Descripción legible de la advertencia.
          examples:
            - Data source is temporarily unavailable.
          type: string
      type: object
    ErrorDetail:
      properties:
        location:
          description: >-
            Lugar donde ocurrió el error, por ejemplo, 'body.items[3].tags' o
            'path.thing-id'
          examples:
            - body.templateId
          type: string
        message:
          description: Texto del mensaje de error
          examples:
            - expected string to match 'uuid' format
          type: string
        value:
          description: Valor en la ubicación indicada
          examples:
            - not-a-uuid
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: >-
        Autenticación mediante token Bearer. Formato: 'Bearer {access_token}'.
        Solo es obligatoria cuando el plugin de autenticación está habilitado.
      scheme: bearer
      type: http

````