AdvReport

Genera en el momento una suscripción de un informe avanzado y devuelve su archivo, en el formato de la suscripción. Otro sistema lo usa para obtener el informe cuando lo necesita, en lugar de recibirlo por correo electrónico, por FTP o por API web. Para un informe de consulta, use QueryReport.

Solo se puede obtener una suscripción que tenga Enable API Access activado. El propietario del informe o un administrador del sistema lo activa en las opciones de la suscripción al crearla o modificarla. Consulte también Obtener un informe a través de la API.

Cómo enviar la clave y leer la respuesta: Claves de API, Respuestas.

GET /api/public/AdvReport?APIKey=your-api-key&SubID=your-subscription-id

Envíe la clave en el parámetro APIKey de la cadena de consulta. La clave debe tener permiso para obtener informes avanzados (advrep.getreport); lo configura el soporte de TrakIT. Codifique para URL ambos valores. La clave forma parte de la dirección, así que no incluya estas URL en los registros que comparta.

Parámetro	Obligatorio	Significado
APIKey	Sí	La clave de API.
SubID	Sí	El identificador de la suscripción. Para obtenerlo, abra la suscripción con Modify y seleccione Copy ID junto a Enable API Access.

Ambos deben estar en la cadena de consulta: si falta alguno, TrakIT responde con HTTP 404.

La solicitud no puede cambiar el informe: se aplican los filtros propios de la suscripción, los filtros del informe, y el formato y las opciones de la suscripción.

Reglas

Regla	Info si no se cumple
APIKey no está vacío.	API Key is missing
La clave está activa y tiene permiso para obtener informes avanzados.	Key is disabled, not recognized or permission denied
SubID no está vacío.	SubID is missing
SubID es un identificador de suscripción.	Invalid SubID
La suscripción existe.	Unable to load
La suscripción tiene Enable API Access activado.	Report not enabled for API access
El informe avanzado está activo: consulte Modificar el informe.	Report is not active
El informe o la suscripción tiene al menos un filtro activo.	No filters found

Después hay que generar el informe. Si no se puede, por ejemplo porque ninguna orden de trabajo ni ningún expediente coincide con los filtros y Generate Empty Report está desactivado, o porque la misma suscripción se está generando en ese momento, la respuesta es el sobre JSON en lugar del archivo, con un Code distinto de 1.

Respuesta

Una respuesta correcta es el archivo del informe, generado de la misma forma que la vista previa de la suscripción. Un rechazo es JSON, así que distinga uno de otro por el Content-Type:

HTTP/1.1 200 OK
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="Weekly status_2610201430.xlsx"

El nombre del archivo es el título de la suscripción, seguido de la fecha y la hora en UTC con el formato yyMMddHHmm y de la extensión del Report Type de la suscripción:

Report Type	Archivo
Form Template PDF	.pdf
Comma Separated Values (CSV)	.csv
HTML File (HTM)	.htm
Excel Spreadsheet (XLSX)	.xlsx
Plain Text (TXT)	.txt
JSON	.json

El archivo nunca se comprime en ZIP, ni siquiera con Zip Report (.zip format) activado, y no se conserva en la pestaña History del informe.

Notas

• Cada llamada que llega a generar el informe aparece en la cola de informes, con API Call como modo de entrega.
• La llamada responde una vez generado el informe, lo que tarda lo mismo que una vista previa de la suscripción. Téngalo en cuenta en el tiempo de espera de su cliente.
• Una suscripción no se puede generar dos veces al mismo tiempo. Si sus llamadas pueden solaparse entre sí, con una vista previa o con un envío programado de la misma suscripción, espere un momento y vuelva a llamar cuando no reciba el archivo.