Présentation des rapports
#
La ressource Rapports permet 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
#
| Clé |
Description |
Type |
| id |
Identificateur unique pour faire référence à ce rapport |
GUID |
| nom |
Nom convivial de l'instance de rapport |
corde |
État du rapport
#
| Données |
Description |
Type |
| dateCréation |
Horodatage de la date de création de la demande |
DateHeure |
| tenantId |
ID de locataire du client de la demande |
GUID |
| requestId |
Identifiant unique de la demande. |
GUID |
| Rapport |
ID unique de l'instance de rapport. |
GUID |
| statut |
Énumération de l'< de la demande de rapport c0> état</c0> |
corde |
| statusMessage |
Message étendu pour l'état |
corde |
| reportTemplateName |
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.) |
corde |
| rowLimitExceeded |
Valeur Bool indiquant si la sortie du rapport est tronquée en fonction de la limite de lignes configurée. |
Bool |
Résultats du rapport
#
| Demander |
Description |
Type |
| requestId |
Identifiant unique de la demande. |
GUID |
| tenantId |
ID de locataire du client de la demande |
GUID |
| demander |
L'objet Request contient des détails sur le rapport, y compris des informations sur les champs renvoyés, le tri et les filtres appliqués. |
Objet de la requête |
| queryDuration |
Temps nécessaire pour extraire les données de la demande en millisecondes. |
Int |
| totalDuration |
Temps nécessaire à l'exécution de la demande en millisecondes. |
corde |
| queryCount |
Nombre d'enregistrements traités pour le rapport |
Int |
| totalCount |
Nombre d'enregistrements retournés dans le rapport |
corde |
| rowLimitExceeded |
Valeur Bool indiquant si la sortie du rapport est tronquée en fonction de la limite de lignes configurée |
corde |
| données |
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 renvoyées. Remarque : Si un champ particulier est référencé dans ' displayFields' n'existe pas dans la ligne de données, il est vide (chaîne) ou faux (booléen). |
Tableau |
| résumé |
Le cas échéant, il contient des données de ligne récapitulatives pour chaque ligne du tableau de données. |
Tableau |
Objet de la requête
#
| Demander |
Description |
Type |
| requestId |
Identifiant unique de la demande. |
GUID |
| dateCréation |
Horodatage de la date de création de la demande |
DateHeure |
| tenantId |
ID de locataire du client de la demande |
GUID |
| Rapport |
ID unique de l'instance de rapport. |
GUID |
| reportTemplateName |
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.) |
corde |
| filtreConditions |
Détails du filtre appliqué au rapport |
Objet |
| sortFields |
Tableau d'ordres de tri appliqué à 1 ou plusieurs champs. |
Réseau (Ordre de tri) |
| displayFields |
Tableau de champs renvoyés pour chaque ligne du rapport |
Réseau (Champ d'affichage) |
| childDisplayFields |
Tableau de champs enfants renvoyés pour chaque ligne du rapport (le cas échéant) |
corde |
| métadonnées |
Autres informations concernant le rapport retourné |
Objet |
Objet d'ordre de tri
#
| Demander |
Description |
Type |
| fieldName |
Nom de l'identifiant du champ |
corde |
| direction |
Énumération de l'ordre de tri appliqué à ce champ |
Ordre de tri |
Afficher l'objet Champ
#
| Demander |
Description |
Type |
| fieldName |
Nom de l'identifiant du champ |
corde |
| obligatoire |
Valeur Bool indiquant si le champ est obligatoire pour le rapport |
Bool |
Enums
#
Statut
#
| Valeur |
Description |
| Démarrage |
Initialisation de la requête |
| Calcul |
Comptage des lignes de données applicables |
| Interrogation |
Interroger les données applicables à la base de données |
| Traitées |
Traitement des données du rapport. |
| Classement |
Tri des données du rapport. |
| Totalisant |
Remplissage des champs de total |
| TotalingPercent |
Remplissage des champs en % du total |
| Conversion |
Convertig return dataset |
| Complet |
Terminé |
Filtres de date prédéfinis
#
| Valeur |
Description |
| Aujourd’hui |
Données d'aujourd'hui jusqu'à 15 minutes avant l'exécution du rapport |
| Hier |
Données de la veille. |
| Cette semaine |
Données de la semaine en cours. |
| Semaine dernière |
Données de la semaine précédente. |
| Ce mois-ci |
Données du mois en cours. |
| DernierMois |
Données du mois précédent. |
| Ce trimestre |
Données du trimestre en cours |
Ordre de tri
#
| Valeur |
Description |
| Ascendant |
1 |
| Descendant |
2 |