Wialon para desarrolladores Manual de usuario Documentación de API report export_result

export_result

El método report/export_result permite exportar los resultados del informe a un archivo.

Endpoint

Copied!
svc=report/export_result&params={
  "format": <uint>,
  "pageOrientation": "<text>",
  "hideGoogleLinks": <uint>,
  "pageSize": "<text>",
  "pageWidth": <uint>,
  "coding": "<text>",
  "delimiter": "<text>",
  "headings": <uint>,
  "compress": <uint>,
  "attachMap": <uint>,
  "extendBounds": <uint>,
  "hideMapBasis": <uint>,
  "outputFileName": "<text>",
  "splitChart": "<text>",
  "appendTreeAnchorRows": <uint>
}

El método es una solicitud que consume muchos recursos, por lo que se le aplica la restricción de solicitudes simultáneas de este tipo durante una sesión. Si se alcanza la restricción, se devuelve el error 1003 con la causa LIMIT api_concurrent. Para ver la lista de solicitudes que consumen muchos recursos, consulte Restricciones.

Parámetros

Parámetro Descripción
format Máscara de bits de formato de archivo (consulte la lista a continuación). Para exportar varios formatos a la vez, sume sus valores (por ejemplo, 2 + 4 = 6 para PDF + XLS). En ese caso, el resultado se comprime automáticamente en un archivo ZIP.

Parámetros opcionales:

Parámetro Descripción Valor predeterminado
compress Compresión del archivo del informe:
  • 0: no;
  • 1: sí. Se fuerza a 1 cuando la exportación produce más de un archivo.
 1
pageOrientation Orientación de la página (PDF): portrait, landscap. portrait
pageSize Formato de página (PDF): a4, a3, letter, legal. a4
pageWidth Ancho de página (PDF):
  • 0: fijo;
  • 1: compacto;
  • 2: sin ajuste.
 0
coding Codificación (CSV): utf8, cp1251. utf8
delimiter Delimitador (CSV). Valores posibles: semicolon (aplica ;), colon (aplica ,). Para usar una coma como delimitador, establezca el valor en colon o déjelo vacío ("delimiter":""). colon
headings Mostrar encabezados:
  • 0: no;
  • 1: sí.
 0
attachMap Adjuntar el mapa (solo PDF y HTML):
  • 0: no;
  • 1: sí.
 0
extendBounds Ampliar el mapa para incluir geocercas:
  • 0: no;
  • 1: sí.
 0
hideMapBasis Ocultar la capa del mapa:
  • 0: no;
  • 1: sí.
 0
outputFileName Nombre del archivo. Online_report
hideGoogleLinks Ocultar enlaces de Google en las celdas de coordenadas (PDF y XLSX):
  • 0: no;
  • 1: sí.
 0
splitChart Dividir por día (day) o semana (week). <empty>
appendTreeAnchorRows Agregar filas de anclaje del árbol con una fila vacía:
  • 0: no;
  • 1: sí.
 0

Según la lógica del parámetro extendBounds, de forma predeterminada el mapa se ajusta para incluir recorridos, marcadores e iconos. Cuando la opción está activada, el mapa también se ajusta para incluir geocercas. Si no hay elementos gráficos (ni recorridos, marcadores e iconos en la situación predeterminada, ni geocercas para la opción extendBounds activada), el mapa no se muestra.

Valores del formato de archivo (máscara de bits):

  • 1: HTML;
  • 2: PDF;
  • 4: XLS;
  • 8: XLSX;
  • 16: XML;
  • 32: CSV.

Resultado devuelto

Devuelve un archivo del formato solicitado.

Si la solicitud falla, la respuesta contiene el texto «Report has not been saved» seguido del código de error, por ejemplo:

Copied!
Report has not been saved{"error":5}

Códigos de error

Código de error Descripción
4 Parámetros de entrada incorrectos: falta el parámetro format o no se creó el archivo (por ejemplo, format no contiene ninguno de los valores admitidos o el resultado del informe no contiene datos).
5 La sesión no tiene ningún resultado de informe (la solicitud report/exec_report no se ejecutó o su resultado se borró) o se produjo un error de lectura/escritura del archivo del informe.
6 Error al obtener el usuario.

Si nota un error en el texto, por favor resáltelo y presione Ctrl+Intro.