Saltar al contenido principal
PATCH
/
v1
/
templates
/
{id}
Actualizar una plantilla
curl --request PATCH \
  --url https://reporter.sandbox.lerian.net/v1/templates/{id} \
  --header 'Content-Type: multipart/form-data' \
  --form template='@example-file' \
  --form outputFormat=HTML \
  --form 'description=Informe financiero'
{
  "id": "0196b1d2-399c-7aff-8941-3ea99d1525d4",
  "outputFormat": "HTML",
  "description": "Informe financiero",
  "fileName": "0196b1d2-399c-7aff-8941-3ea99d1525d4.tpl",
  "createdAt": "2025-05-08T21:34:26.716Z",
  "updatedAt": "2025-05-08T21:50:24.844Z"
}

Encabezados

​
Authorization
string

El token de autorización en formato 'Bearer '.

Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

​
Content-Type
string

Tipo de contenido de la solicitud. Importante: para este endpoint debe ser multipart/form-data.

​
X-Organization-id
string

The unique identifier of the Organization associated with the request.

Parámetros de ruta

​
id
string
requerido

Unique identifier of the template that you want to retrieve (UUID).

Cuerpo

multipart/form-data
​
template
file

Nuevo archivo .tpl. Opcional. Cuando se envía sin outputFormat, el archivo se valida contra el outputFormat existente de la plantilla.

​
outputFormat
enum<string>

Formato de salida generado por la nueva plantilla. Opcional. Solo se acepta junto con un nuevo archivo template. Enviar outputFormat sin template devuelve un error 400.

Opciones disponibles:
HTML,
CSV,
XML,
PDF,
TXT
​
description
string

Descripción breve de la plantilla. Opcional.

Respuesta

Indica que la plantilla se actualizó correctamente.

Detalles de la plantilla que se creó o actualizó.

​
id
string

ID único que identifica la plantilla (formato UUID).

​
outputFormat
string

Formato de salida generado (por ejemplo, HTML, CSV, PDF, TXT, XML).

​
description
string

Describe brevemente para qué sirve la plantilla o qué contiene.

​
fileName
string

Nombre del archivo de plantilla tal como está guardado en el sistema. Sigue el formato <template_id>.tpl.

​
createdAt
string

Marca de tiempo que indica cuándo se creó la plantilla.

​
updatedAt
string

Marca de tiempo que indica la última vez que se actualizó la plantilla.

​
warnings
object[]

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.