exec_report
La función exec_report se usa para ejecutar un informe.
svc=report/exec_report¶ms={"reportResourceId":<long>,
"reportTemplateId":<long>,
"reportObjectId":<long>,
"reportObjectSecId":<long>,
"reportObjectIdList":[<uint>, ...]},
"interval":{
"from":<uint>,
"to":<uint>,
"flags":<uint>
},
"remoteExec":<uint>,
"reportTemplate":<object>}
En una sesión puede haber solo un resultado de informe. Por lo tanto, si hay algún resultado de informe en la sesión, usted tiene que borrarlo antes de ejecutar uno nuevo. Para hacerlo, use la función **[cleanup\_result](/es/api/user-guide/api-reference/report/cleanup_result)**.No puede ejecutar esta solicitud simultáneamente con las siguientes solicitudes:
Parámetros
Nombre | Descripción |
---|---|
reportResourceId | ID del recurso. Este parámetro es obligatorio. El informe se ejecuta en nombre del creador del recurso si reportTemplateId es 0. |
reportTemplateId | ID de la plantilla. |
reportObjectId | ID del objeto. |
reportObjectSecId | ID del objeto subordinado (conductor, remolque o sus grupos); 0 si el objeto no tiene objetos subordinados. |
reportObjectIdList | Matriz de los ID de objetos adicionales (para el informe por grupos de unidades). |
interval | Ajustes del intervalo de informe. |
from | Inicio del intervalo, tiempo Unix. |
to | Fin del intervalo, tiempo Unix. |
flags | Marcas de intervalo. |
remoteExec | Especifique el valor 1 para este parámetro para ejecutar el informe en el servidor Webreport. El parámetro es opcional y solo se utiliza si la solicitud report/get_report_status se ejecuta más tarde. Si la respuesta JSON incluye Especifique 0 u omita este parámetro para ejecutar el informe en el servidor Web. En este caso, el tiempo de ejecución se limita a 3 minutos. |
reportTemplate | JSON de la plantilla de informe que puede obtener después de la solicitud get_report_data. El parámetro es opcional y solo se utiliza si reportTemplateId es 0. |
Las marcas de intervalo son:
Marca | Descripción |
---|---|
0x00 | Intervalo especificado. |
0x01 | Empezando desde... hasta hoy. |
0x02 | Por n días anteriores. |
0x04 | Por n semanas anteriores. |
0x08 | Por n meses anteriores. |
0x10 | Por n años anteriores. |
0x20 | Incluyendo corriente. |
0x40 | Por n horas anteriores. |
0x80 | Por n minutos anteriores. |
Resultado devuelto
{
"reportResult":{ /* resultado de ejecución de informe */
"msgsRendered":<int>, /* mensajes cargados: 0, no; 1, sí */
"stats":[ /* matriz de parámetros de estadísticas */
["<text>","<text>"] /* [nombre de parámetro, valor] */
],
"tables":[ /* matriz de tablas */
{
"name":"<text>", /* tipo de tabla */
"label":"<text>", /* nombre */
"grouping": {
"type":"<text>" /* tipo de agrupación */
},
"flags":<uint>, /* marcas de tabla (vea más abajo) */
"rows":<uint>, /* cantidad de líneas */
"level":<uint>, /* nivel máximo en la tabla */
"columns":<uint>, /* cantidad de columnas */
"header":["<text>"], /* matriz de encabezados de tabla */
"total":[ /* total */
"<text>" /* matriz de celdas */
],
"header_type" ["<text>"], /* matriz de tipos de encabezados de tabla */
"totalRaw" [ /* matriz de valores de la línea "Total" */
{
"v":<double>, /* valor inicial de celda */
"vt":<double>, /* tipo de valor */
},
...
]
}
],
"attachments":[ /* matriz de datos adjuntos (gráficas, fotos) */
{ /* para gráficas */
"name":"<text>", /* nombre */
"type":"<text>", /* tipo: gráfica, foto */
"datasets":["<text>"] /* matriz con nombres de líneas curvas de gráfica */
"axis_y": ["<text>"] /* matriz con etiquetas de eje 'Y' */
"axis_x": "<text>", /* nombre de eje 'X' */
"flags": <uint>, /* formato de eje, vea la descripción más abajo */
"p":"<text>", /* ajustes de gráfica */
},
{ /* para foto y vídeo */
"name":"<text>", /* nombre y siguientes parámetros separados por ";" */
"ftm":"<text>", /* fecha formateada */
"uid":"<text>", /* ID de unidad */
"tm":"<text>", /* tiempo Unix */
"idx":"<text>", /* índice de datos adjuntos del mismo tipo registrados simultáneamente */
"lat":"<text>", /* latitud */
"lon":"<text>", /* longitud */
"type":"<text>", /* tipo de datos adjuntos */
"zone":<JSON>, /* información de geocercas */
"tags":<JSON>, /* información sobre etiquetas */
}
]
},
"reportLayer":{ /* capa gráfica */
"name":"<text>", /* nombre de capa */
"bounds":[
<double>, /* latitud mínima */
<double>, /* longitud mínima */
<double>, /* latitud máxima */
<double> /* longitud máxima */
]
},
"layerCount":<uint> /* cantidad de capas que deben ser combinadas en la capa de informe */
}
Para obtener todos los tipos de tablas disponibles, utilice la función get_report_tables.
Para los detalles del campo zone, vea la página get_zone_data.
Para los detalles del campo tags, vea la página update_tag.
Marcas de tablas:
Marca | Descripción |
---|---|
0x1 | Agrupación por días. |
0x2 | Limitación por tiempo. |
0x4 | Agrupación por semanas. |
0x8 | Agrupación por meses. |
0x10 | Total. |
0x20 | Gráficas: dividir sensores. |
0x100 | Especificación: parcial. |
0x200 | Gráficas: contar desde cero. |
0x400 | Acumular intervalos. |
0x800 | Especificación: completa. |
0x1000 | Numeración de líneas. |
0x2000 | Ejecutar la tabla solo por objeto del informe (no por objetos subordinados). |
0x4000 | Agrupar registros en turnos. |
0x8000 | Cortar intervalos en la tabla. |
0x200000 | Agrupación por viajes. |
0x400000 | Agrupación por tipo de infracción. |
0x10000000 | Agrupación por día de la semana. |
0x20000000 | Agrupación por día del mes. |
0x40000000 | Agrupación por años. |
Marcas de gráficas:
Marca | Marca adicional | Descripción |
---|---|---|
0x4 | Máximo ajustable para el eje Y. | |
0x10 | Formato especificado en los ajustes de plantilla. | |
0x1 | Adicional para 0x10 (establecer formato como "H:M:S"). | |
0x2 | Adicional para 0x10 (establecer formato como "Y-m-E"). | |
0x80 | Tipo genérico. | |
0x100 | Formato de 24 horas. | |
0x20 | Formato de 24 horas (adicional para 0x100). | |
0x2 | Formato de 12 horas (adicional para 0x20). | |
0x40 | Mostrar días de la semana (adicional para 0x100). |
Los códigos de errores posibles son:
Código | Descripción |
---|---|
7 | Error al obtener el objeto del informe y recurso del informe con la ACL deseada (ADF_ACL_ITEM_EXECUTE_REPORTS, ADF_ACL_AVL_RES_VIEW_REPORTS). |
6 | Error no definido. |
4 | Parámetros de entrada incorrectos. |