Cómo generar y acceder a un reporte con la API REST

Esta guía te mostrará cómo obtener y acceder a un reporte que contiene datos, utilizando REST API.

Requisitos

El recurso de REST API de Reporte requiere la siguiente información al usarlo:

Recursos utilizados

  • Reporte > reports - para obtener el reportID
  • Reporte > renderings - para obtener el renderingID
  • Reporte > renderingsID:long - para obtener el enlace del reporte (donde se encuentran los datos del reporte).

Obtener el reportID

El primer paso es obtener el reportID.

1. Inicia sesión en http://host_name/comGpsGate/api/v.1/test

Nota: reemplaza host_name con la dirección IP de tu servidor o el nombre DNS real.

2. Haz clic en el nombre del recurso reports, y selecciona Try it out

/applications/{applicationid:int}/reports

mceclip1.png

3. Rellena el applicationID, luego haz clic en Execute

mceclip2.png

4. Obtendrás una lista de reportes con sus parámetros predeterminados.

Guarda el applicationID para usarlo más tarde.

mceclip3.png

Nota: mantén el modelo abierto para usar los datos para el siguiente recurso.

Obtener el renderID

Ahora necesitamos generar un render del reporte y obtener su renderID. Para eso utilizaremos el siguiente recurso:

/applications/{applicationid:int}/reports/{reportid:int}/renderings

1. Haz clic en Try it out

mceclip4.png

2. Rellena los datos del modelo (con los parámetros requeridos) para obtener el renderID, luego haz clic en Execute.

Nota: si necesitas ayuda con tu modelo, te recomendamos usar el recurso: /applications/{applicationid:int}/reports/{reportid:long} este recurso genera un modelo con los parámetros necesarios en este paso.

  • Use el parámetro "reportFormatId": 2 si deseas generar tu reporte en formato CSV.

mceclip5.png

3. Deberías obtener una respuesta. El renderID es el marcado en rojo:

mceclip6.png

Obtener el reporte

Finalmente, utilizaremos el siguiente recurso para obtener el reporte

1. Haz clic en Probar

mceclip7.png

2. Rellena el ApplicationID, ReportID y RenderingID obtenidos en pasos anteriores:

3. Haz clic en Ejecutar

mceclip0.png

4. En los resultados obtendrás el enlace del reporte.

mceclip2.png

5. Compón la URL usando tu servidor + el enlace

mceclip3.png