Aperçu des rapports
#
La ressource Rapports offre la capacité d'interroger et d'exécuter des rapports configurés dans l'espace de travail référencé.
/{VERSION}/workspaces/{WORKSPACE_ID}/rapports
Interfaces disponibles
#
Schémas
#
Rapports
#
| Légende |
Désignation des marchandises |
Type |
| id |
Identifiant unique pour référencer ce rapport |
GUID |
| nom |
Nom convivial pour l'instance de rapport |
chaîne |
État du rapport
#
| Données |
Désignation des marchandises |
Type |
| dateCréation |
Horodatage de la date de création de la demande |
DateTimeTime |
| tenantId |
ID locataire client de la demande |
GUID |
| requestId |
Identifiant unique pour la demande. |
GUID |
| Rapport |
Identifiant unique pour l'instance du rapport. |
GUID |
| Statut |
Enum des demandes de rapport statut |
chaîne |
| statusMessage |
Message élargi pour le statut |
chaîne |
| rapportNomModèle. |
Nom du modèle pour le reportId. Chaque type de modèle contient des informations d'appel différentes. (par exemple, listes, résumés, etc.) |
chaîne |
| rowLimitExceeded |
La valeur de bool indique si la sortie du rapport est tronquée selon la limite de ligne configurée. |
bool |
Résultats du rapport
#
| Demande |
Désignation des marchandises |
Type |
| requestId |
Identifiant unique pour la demande. |
GUID |
| tenantId |
ID locataire client de la demande |
GUID |
| Demande |
L'objet demande contient des détails sur le rapport, y compris des informations sur les champs retournés, le tri et les filtres appliqués. |
Objet de requête |
| queryDuration |
Temps nécessaire pour extraire les données de la requête en millisecondes. |
int |
| totalDurée |
Le temps nécessaire pour exécuter la requête en millisecondes. |
chaîne |
| queryCount |
Nombre de dossiers traités pour le rapport |
int |
| totalCount |
Nombre de documents indiqués dans le rapport |
chaîne |
| rowLimitExceeded |
Valeur de bool indiquant si la sortie du rapport est tronquée selon la limite de lignes configurée |
chaîne |
| Données |
Un tableau de lignes de données contenant le résultat du rapport. Utilisez les informations displayFields dans l'objet Request pour identifier les détails des données retournées. Note : Si un champ particulier est référencé dans ' displayFields' n'existe pas dans la ligne de données, elle est vide (chaîne) ou fausse (bool). |
Réseau |
| Résumé |
Le cas échéant, cela contient des données résumées de ligne pour chaque ligne du tableau de données. |
Réseau |
Objet de requête
#
| Demande |
Désignation des marchandises |
Type |
| requestId |
Identifiant unique pour la demande. |
GUID |
| dateCréation |
Horodatage de la date de création de la demande |
DateTimeTime |
| tenantId |
ID locataire client de la demande |
GUID |
| Rapport |
Identifiant unique pour l'instance du rapport. |
GUID |
| rapportNomModèle. |
Nom du modèle pour le reportId. Chaque type de modèle contient des informations d'appel différentes. (par exemple, listes, résumés, etc.) |
chaîne |
| filtreConditions |
Détails du filtre appliqué au rapport |
Objet |
| sortFields |
Tableau des ordres de tri appliqués à 1 ou plusieurs champs. |
Array (Ordre de tri) |
| displayFields |
Tableau de champs retournés pour chaque ligne du rapport |
Array (Display Field) |
| childDisplayFields |
Tableau de champs enfants retournés pour chaque ligne du rapport (si applicable) |
chaîne |
| métadonnées |
Autres informations concernant le rapport retourné |
Objet |
Sort Order Object
#
| Demande |
Désignation des marchandises |
Type |
| champName |
Nom d'identité pour le champ |
chaîne |
| Direction |
Enum pour l'ordre de tri appliqué à ce corps |
Ordre de tri |
Affichage de l'objet champ
#
| Demande |
Désignation des marchandises |
Type |
| champName |
Nom d'identité pour le champ |
chaîne |
| obligatoire |
Valeur de bool indiquant si le champ est obligatoire pour le rapport |
bool |
Enums
#
État d'avancement
#
| Valeur |
Désignation des marchandises |
| Départ |
Initialisation de la requête |
| Comptage |
Comptage des lignes de données applicables |
| Requêtes |
Interroger les données applicables à la base de données |
| Traité |
Traitement des données du rapport. |
| Tri |
Trier les données du rapport. |
| Totalisation |
Peuplement des champs totaux |
| TotalingPercent |
Peuplement% des champs totaux |
| Conversion |
Convertig return dataset |
| Complet |
Terminé |
Filtres de date prédéfinis
#
| Valeur |
Désignation des marchandises |
| Aujourd’hui |
Données d'aujourd'hui jusqu'à 15 minutes avant la publication du rapport |
| Hier |
Données de la veille. |
| ThisWeek |
Données de la semaine en cours. |
| La semaine dernière |
Données de la semaine précédente. |
| CeMois-ci |
Données du mois en cours. |
| Le mois dernier |
Données du mois précédent. |
| ThisQuarter |
Données du trimestre en cours |
Ordre de tri
#
| Valeur |
Désignation des marchandises |
| Ascension |
1 |
| Descente |
2 |