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 #

L'interface	Désignation des marchandises
Obtenez tout	Retourne une collection de rapports configurés.
Après la demande	Publie une demande pour publier le rapport.
Obtenir le statut	Interroge le statut de la demande fournie.
Obtenez des résultats	Interroge les données de résultat de la requête fournie.

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	Conversion des jeux de données de retour
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

Filtres supplémentaires #

Opérateurs #

Valeur	Désignation des marchandises	S'applique à
=	Égal	Tous les types de données
!=	Ça ne veut pas dire	Tous les types de données
>	Plus grand que	Double, Rendez-vous
>=	Supérieur ou égal	Double, Rendez-vous
<	Moins que	Double, Rendez-vous
<=	Inférieur ou égal	Double, Rendez-vous
SW	Ça commence par.	Chaîne
NSW	Ça ne commence pas par.	Chaîne
CT	Contient.	Chaîne
NCT	Ne contient pas	Chaîne
Beurk	Se termine par	Chaîne
Nouveau	Ça ne s'arrête pas à	Chaîne

Exemples #

Exemple - Direction d'appel = Entrée #

{
    « reportId » : « 00000000-0000-0000-0000-000000000001 »,
    « dateFilter » : {
        « PresetName » : « ThisQuarter »
    },
    « ConditionsAdditionnelles » : \[{
        « fieldName » : « callDir »,
        « operator » : « = »,
        « valeurs » : [« 2 »][ "2" ]
    }]

}

Exemple - Composition directe vers l'intérieur = '(123) 456 7890' #

{
    « reportId » : « 00000000-0000-0000-0000-000000000001 »,
    « dateFilter » : {
        « PresetName » : « ThisQuarter »
    },
    « ConditionsAdditionnelles » : \[{
        « fieldName » : « ddi »,
        « operator » : « = »,
        « valeurs » : [« +11234567890 »][ "+11234567890" ]
    }]

}

Exemple : la composition directe à l'intérieur commence par « 123 » #

{
    « reportId » : « 00000000-0000-0000-0000-000000000001 »,
    « dateFilter » : {
        « PresetName » : « ThisQuarter »
    },
    « ConditionsAdditionnelles » : \[{
        « fieldName » : « ddi »,
        « operator » : « = »,
        « valeurs » : [« +1123 »][ "+1123" ]
    }]

}

Exemple - Numéros d'utilisateur 1002 et 1002 #

{
    « reportId » : « 00000000-0000-0000-0000-000000000001 »,
    « dateFilter » : {
        « PresetName » : « ThisQuarter »
    },
    « ConditionsAdditionnelles » : \[{
        « fieldName » : « userNum »,
        « operator » : « = »,
        « valeurs » : [« 1001 », « 1002 »][ "1001", "1002" ]
    }]

}