Descripción general de los informes

Descripción general de los informes #

El recurso Reports proporciona la capacidad de consultar y ejecutar informes configurados en el área de trabajo a la que se hace referencia.

/{VERSIÓN}/espacios de trabajo/{WORKSPACE_ID}/informes

Interfaces disponibles #

Interfaz	Descripción
Obtener todo	Devuelve una colección de informes configurados.
Solicitud de publicación	Publica una solicitud para ejecutar el informe.
Obtener estado	Consulta el estado de la solicitud proporcionada.
Obtener resultados	Consulta los datos de resultado de la solicitud proporcionada.

Esquemas #

Informes #

Llave	Descripción	Tipo
identificación	Identificador único para hacer referencia a este informe	GUID
nombre	Nombre descriptivo para la instancia de informe	cuerda

Estado del informe #

Datos	Descripción	Tipo
fechaCreado	Marca de tiempo de la fecha de creación de la solicitud	FechaHora
tenantId	Identificador de inquilino del cliente de la solicitud	GUID
requestId	ID único para la solicitud.	GUID
reportId	ID único para la instancia de informe.	GUID
estado	Enumeración de la < de la solicitud de informe c0> Estado</c0>	cuerda
statusMessage	Mensaje expandido para el estado	cuerda
nombrePlantillaDeinforme	Nombre de plantilla para reportId. Cada tipo de plantilla contiene información de llamada diferente. (por ejemplo, listas, resúmenes, etc.)	cuerda
filaLímiteExcedido	Valor bool que indica si la salida del informe se trunca en función del límite de filas configurado.	Bool

Resultados del informe #

Pedir	Descripción	Tipo
requestId	ID único para la solicitud.	GUID
tenantId	Identificador de inquilino del cliente de la solicitud	GUID
pedir	El objeto de solicitud contiene detalles sobre el informe, incluida información sobre los campos devueltos, la ordenación y los filtros aplicados.	Objeto de solicitud
queryDuration	Tiempo necesario para extraer datos de la solicitud en milisegundos.	Int
totalDuración	Tiempo necesario para ejecutar la solicitud en milisegundos.	cuerda
queryCount	Número de registros procesados para el informe	Int
totalCount	Número de registros devueltos en el informe	cuerda
filaLímiteExcedido	Valor bool que indica si la salida del informe se trunca en función del límite de filas configurado	cuerda
datos	Matriz de filas de datos que contiene el resultado del informe. Use la información displayFields del objeto Request para identificar los detalles de los datos devueltos. Nota: Si se hace referencia a un campo concreto en ' displayFields' no existe en la fila de datos, está vacío (cadena) o falso (bool).	Arreglo
resumen	Si corresponde, contiene datos de fila de resumen para cada fila de la matriz de datos.	Arreglo

Objeto de solicitud #

Pedir	Descripción	Tipo
requestId	ID único para la solicitud.	GUID
fechaCreado	Marca de tiempo de la fecha de creación de la solicitud	FechaHora
tenantId	Identificador de inquilino del cliente de la solicitud	GUID
reportId	ID único para la instancia de informe.	GUID
nombrePlantillaDeinforme	Nombre de plantilla para reportId. Cada tipo de plantilla contiene información de llamada diferente. (por ejemplo, listas, resúmenes, etc.)	cuerda
filterConditions	Detalles del filtro aplicado al informe	Objeto
sortFields	Matriz de criterios de ordenación aplicados a 1 o más campos.	Matriz (Orden de clasificación)
displayCampos	Matriz de campos que se devuelven para cada fila del informe	Matriz (Campo de visualización)
childDisplayFields	Matriz de campos secundarios que se devuelven para cada fila del informe (si corresponde)	cuerda
metadatos	Otra información sobre el informe devuelto	Objeto

Objeto de orden de clasificación #

Pedir	Descripción	Tipo
fieldName	Nombre de identificación para el campo	cuerda
dirección	Enumeración para el criterio de ordenación aplicado a este campo	Criterio de clasificación

Objeto de campo de visualización #

Pedir	Descripción	Tipo
fieldName	Nombre de identificación para el campo	cuerda
obligatorio	Valor bool que indica si el campo es obligatorio para el informe	Bool

Enumeraciones #

Estado #

Valor	Descripción
Incipiente	Inicialización de la consulta
Contaje	Recuento de filas de datos aplicables
Consulta	Consulta de datos aplicables para la base de datos
Procesado	Tratamiento de los datos del informe.
Ordenación	Clasificación de los datos del informe.
Totalizando	Rellenar campos totales
TotalingPercent	Rellenar los campos % total
Convertir	Conversión del conjunto de datos de retorno
Íntegro	Completado

Filtros de fecha preestablecidos #

Valor	Descripción
Hoy	Datos desde hoy hasta 15 minutos antes de que se ejecute el informe
Ayer	Datos del día anterior.
Esta semana	Datos de la semana actual.
Última semana	Datos de la semana anterior.
Este mes	Datos del mes actual.
Último mes	Datos del mes anterior.
Este trimestre	Datos del trimestre actual

Criterio de clasificación #

Valor	Descripción
Ascendente	1
Descendente	2