Saltar al contenido principal
GET
/
v1
/
reports
/
{id}
Obtener un informe
curl --request GET \
  --url https://reporter.sandbox.lerian.net/v1/reports/{id}
{
  "id": "0196b268-620d-7d09-afa3-85e4d5369eg3",
  "templateId": "0196b264-24d4-7e0b-ad5c-9028cc05138d",
  "filters": null,
  "status": "Processing",
  "completedAt": "2025-05-09T00:18:27.507Z",
  "createdAt": "2025-05-09T00:18:27.469Z",
  "updatedAt": "2025-05-09T00:18:27.469Z",
  "deletedAt": null
}

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.

​
X-Organization-id
string

The unique identifier of the Organization associated with the request.

Parámetros de ruta

​
id
string
requerido

Unique identifier for the report that you want to check.

Respuesta

Los detalles del informe.

Información sobre el informe.

​
id
string

Identificador único del informe.

​
templateId
string

Identificador único de la plantilla usada para generar el informe.

​
templateOutputFormat
string

Formato de salida configurado en la plantilla usada para generar el informe.

Ejemplo:

"XML"

​
templateDescription
string

Descripción configurada en la plantilla usada para generar el informe.

Ejemplo:

"Cadoc"

​
filters
object

Objeto que define los criterios de filtrado aplicados a los datos utilizados en el informe. Ahora admite operadores de filtrado avanzados, como equality, comparison, range y condiciones basadas en listas.

​
status
enum<string>

Estado del informe.

Opciones disponibles:
PendingExtraction,
Processing,
Finished
​
createdAt
string

Marca de tiempo que indica cuándo se creó esta solicitud de informe.

​
completedAt
string

Marca de tiempo que indica cuándo se completó el procesamiento del informe.

​
updatedAt
string

Marca de tiempo de la última actualización de esta solicitud de informe.

​
deletedAt
string

Marca de tiempo que indica cuándo esta solicitud de informe se eliminó lógicamente, si aplica.

​
metadata
object

Objeto que contiene información adicional sobre el informe como pares clave-valor. Los valores pueden ser cadenas simples u objetos anidados. Para informes fallidos, este objeto incluye una entrada error que describe la falla (código, título, mensaje y detalles).