Visualizations¶
L’API de visualisation est conçue pour aider les clients à interagir avec les graphiques et les tableaux croisés dynamiques/rapports. Les points de terminaison (ou endpoint) de cette API sont utilisés par l’application Data Visualization qui permet la création, la configuration et la gestion de graphiques et de tableaux croisés dynamiques basés sur les définitions du client. L’idée principale est de permettre aux clients et aux utilisateurs de disposer d’une API unique et centralisée fournissant tous les types de graphiques et de tableaux croisés dynamiques ainsi que des paramètres et une configuration spécifiques pour chaque type de visualisation.
status |
Time |
Size |
200 OK |
4.01 s |
3.69 KB |
{
"visualizations": [
{
"id": "xxxxxxxxxxx",
"displayName": " "
},
{
"id": "xxxxxxxxxxx",
"displayName": "08_06_2021_PEV_FARAFANGANA"
},
{
"id": "xxxxxxxxxxx",
"displayName": "101 REVUE TCE 2022"
},
{
"id": "xxxxxxxxxxx",
"displayName": "10/2020PALU "
}
]
}
status |
Time |
Size |
200 OK |
2.59 s |
3.89 KB |
{
"lastUpdated": "2022-06-24T10:22:53.144",
"href": "https://ministere-sante.mg/api/visualizations/xxxxxxxxxxx",
"id": "xxxxxxxxxxx",
"created": "2022-06-21T14:41:00.033",
"name": "101 REVUE TCE 2022",
"publicAccess": "rw------",
"userOrganisationUnitChildren": false,
"legendDisplayStyle": "FILL",
"type": "PIVOT_TABLE",
"hideEmptyColumns": false,
"subscribed": false,
"userOrganisationUnit": false,
"rowSubTotals": false,
"displayDescription": "",
"cumulativeValues": false,
"showDimensionLabels": true,
"sortOrder": 0,
"fontSize": "NORMAL",
"favorite": false,
"topLimit": 0,
"userOrganisationUnitGrandChildren": false,
"displayName": "101 REVUE TCE 2022",
"percentStackedValues": false,
"noSpaceBetweenColumns": false,
"showHierarchy": false,
"hideTitle": false,
"skipRounding": false,
"showData": false,
"numberType": "VALUE",
"hideEmptyRows": false,
"parentGraphMap": {
"xxxxxxxxxxx": "xxxxxxxxxxx/xxxxxxxxxxx"
},
"displayDensity": "NORMAL",
"regressionType": "NONE",
"completedOnly": false,
"colTotals": false,
"displayFormName": "101 REVUE TCE 2022",
"hideEmptyRowItems": "NONE",
"aggregationType": "DEFAULT",
"hideSubtitle": false,
"description": "",
"hideLegend": false,
"externalAccess": false,
"legendDisplayStrategy": "FIXED",
"colSubTotals": false,
"rowTotals": false,
"digitGroupSeparator": "SPACE",
"regression": false,
"access": {
"read": true,
"update": false,
"externalize": false,
"delete": true,
"write": false,
"manage": false
},
"reportingParams": {
"parentOrganisationUnit": false,
"reportingPeriod": false,
"organisationUnit": false,
"grandParentOrganisationUnit": false
},
"lastUpdatedBy": {
"displayName": "xxxxxxxxxxx",
"id": "xxxxxxxxxxx",
"username": "xxxxxxxxxxx"
},
"relativePeriods": {
"thisYear": false,
"quartersLastYear": false,
"last30Days": false,
"last52Weeks": false,
"thisWeek": false,
"last90Days": false,
"last60Days": false,
"lastMonth": false,
"last14Days": false,
"biMonthsThisYear": false,
"monthsThisYear": false,
"last2SixMonths": false,
"yesterday": false,
"thisQuarter": false,
"last12Months": false,
"last5FinancialYears": false,
"thisSixMonth": false,
"lastQuarter": false,
"thisFinancialYear": false,
"last4Weeks": false,
"last3Months": false,
"thisDay": false,
"thisMonth": false,
"last5Years": false,
"last6BiMonths": false,
"last4BiWeeks": false,
"lastFinancialYear": false,
"lastBiWeek": false,
"weeksThisYear": false,
"last6Months": false,
"last3Days": false,
"quartersThisYear": false,
"monthsLastYear": false,
"lastWeek": false,
"last7Days": false,
"last180Days": false,
"thisBimonth": false,
"lastBimonth": false,
"lastSixMonth": false,
"thisBiWeek": false,
"lastYear": false,
"last12Weeks": false,
"last4Quarters": false
},
"user": {
"displayName": "xxxxxxxxxxx",
"id": "xxxxxxxxxxx",
"username": "xxxxxxxxxxx"
},
"dataElementGroupSetDimensions": [],
"attributeDimensions": [],
"translations": [],
"yearlySeries": [],
"filterDimensions": [
"ou"
],
"interpretations": [],
"userGroupAccesses": [],
"subscribers": [],
"optionalAxes": [],
"columns": [
{
"id": "dx"
}
],
"dataElementDimensions": [],
"periods": [
{
"id": "202201"
},
{
"id": "202202"
},
{
"id": "202203"
},
{
"id": "202204"
},
{
"id": "202205"
},
{
"id": "202206"
},
{
"id": "202207"
},
{
"id": "202208"
},
{
"id": "202209"
},
{
"id": "202210"
},
{
"id": "202211"
},
{
"id": "202212"
}
],
"categoryDimensions": [],
"rowDimensions": [
"pe"
],
"series": [],
"itemOrganisationUnitGroups": [],
"programIndicatorDimensions": [],
"attributeValues": [],
"columnDimensions": [
"dx"
],
"userAccesses": [],
"favorites": [],
"dataDimensionItems": [
{
"dataDimensionItemType": "INDICATOR",
"indicator": {
"id": "xxxxxxxxxxx"
}
}
],
"categoryOptionGroupSetDimensions": [],
"organisationUnitGroupSetDimensions": [],
"organisationUnitLevels": [
3
],
"organisationUnits": [
{
"id": "xxxxxxxxxxx"
}
],
"filters": [
{
"id": "ou"
}
],
"rows": [
{
"id": "pe"
}
]
}
Un objet de visualisation est composé de nombreux attributs (certains d’entre eux liés aux graphiques et d’autres liés aux tableaux croisés dynamiques), mais les plus importants chargés de refléter les informations de base de l’objet sont : « id », « name », « type », « dataDimensionItems », « columns », « rows » and « filters ».
Le point de terminaison racine de l’API est /api/visualizations, et la liste des attributs et éléments actuels est décrite dans le tableau ci-dessous.
Attributs de visualisation
Champ |
Description |
|---|---|
id |
identifiant unique. |
code |
Un code personnalisé pour identifier la visualisation. |
name |
Le nom de la visualisation |
type |
Le type de visualisation. Les types valides sont: COLUMN, STACKED_COLUMN, BAR, STACKED_BAR, LINE, AREA, PIE, RADAR, GAUGE, YEAR_OVER_YEAR_LINE, YEAR_OVER_YEAR_COLUMN, SINGLE_VALUE, PIVOT_TABLE. |
title |
Un titre personnalisé. |
subtitle |
Un sous-titre personnalisé. |
description |
Définit une description personnalisée pour la visualisation. |
created |
La date/l’heure de création de la visualisation. |
startDate |
Date de début utilisée lors du filtrage. |
endDate |
La date de fin utilisée pendant le filtrage. |
sortOrder |
L’ordre de tri de cette Visualisation. Valeur entier. |
user |
Un objet représentant le créateur de la visualisation. |
publicAccess |
Définit les autorisations d’accès public. |
displayDensity |
La densité d’affichage du texte. |
fontSize |
La taille de la police du texte. |
fontStyle |
Styles de police personnalisés pour: visualizationTitle, visualizationSubtitle, horizontalAxisTitle, verticalAxisTitle, targetLineLabel, baseLineLabel, seriesAxisLabel, categoryAxisLabel, legend. |
relativePeriods |
Objet représentant les périodes relatives utilisées dans la requête analytique. |
legendSet |
Objet représentant les définitions de la légende. |
legendDisplayStyle |
Le style d’affichage de la légende. Il peut être : FILL ou TEXT. |
legendDisplayStrategy |
Le style d’affichage de la légende. Il peut être : FIXED ou BY_DATA_ITEM. |
aggregationType |
Détermine comment les valeurs du tableau croisé dynamique sont agrégées. Options valides: SUM, AVERAGE, AVERAGE_SUM_ORG_UNIT, LAST, LAST_AVERAGE_ORG_UNIT, FIRST, FIRST_AVERAGE_ORG_UNIT, COUNT, STDDEV, VARIANCE, MIN, MAX, NONE, CUSTOM or DEFAULT. |
regressionType |
Un type de régression valide : NONE, LINEAR, POLYNOMIAL ou LOESS. |
targetLineValue |
La ligne cible du graphique. Accepte un type double. |
targetLineLabel |
L’étiquette de la ligne cible du graphique. |
rangeAxisLabel |
T’étiquette/titre de l’axe vertical du graphique (y). |
domainAxisLabel |
L’axe horizontal du graphique (x) étiquette/titre. |
rangeAxisMaxValue |
La valeur maximale de l’axe du graphique. Les valeurs en dehors de la plage ne seront pas affichées. |
rangeAxisMinValue |
La valeur minimale de l’axe du graphique. Les valeurs en dehors de la plage ne seront pas affichées. |
rangeAxisSteps |
Le nombre de pas d’axe entre les valeurs minimum et maximum. |
rangeAxisDecimals |
Le nombre de décimales pour les valeurs des axes. |
baseLineValue |
Une valeur de référence graphique. |
baseLineLabel |
Une étiquette de référence de diagramme. |
digitGroupSeparator |
Le séparateur de groupe de chiffres. Valeurs valides: COMMA, SPACE or NONE. |
topLimit |
Limite supérieure définie pour la table pivotante. |
measureCriteria |
Décrit les critères appliqués à cette mesure. |
percentStackedValues |
Utilise des valeurs empilées ou non. Plus susceptible d’être appliqué pour les graphiques. Valeur booléenne. |
noSpaceBetweenColumns |
Afficher/masquer l’espace entre les colonnes. Valeur booléenne. |
regression |
Indique si la visualisation contient des colonnes de régression. Plus susceptible d’être applicable à Pivot/Report. Valeur booléenne. |
externalAccess |
Indique si la visualisation est disponible en lecture seule externe. Valeur booléenne. |
userOrganisationUnit |
Indique si l’utilisateur possède une unité d’organisation.Valeur booléenne. |
userOrganisationUnitChildren |
Indique si l’utilisateur a une unité d’organisation des enfants. Valeur booléenne. |
userOrganisationUnitGrandChildren |
Indique si l’utilisateur a une unité d’organisation de petits enfants. Valeur booléenne. |
reportingParams |
Objet utilisé pour définir les attributs booléens liés aux rapports. |
rowTotals |
Affiche (ou non) les totaux de ligne. Valeur booléenne. |
colTotals |
Affiche (ou non) les totaux des colonnes. Valeur booléenne. |
rowSubTotals |
Affiche (ou non) les sous-totaux de ligne. Valeur booléenne. |
colSubTotals |
Affiche (ou non) les sous-totaux des colonnes. Valeur booléenne. |
cumulativeValues |
Indique si la visualisation utilise des valeurs cumulatives. Valeur booléenne. |
hideEmptyColumns |
Indique s’il faut masquer des colonnes sans valeurs de données. Valeur booléenne. |
hideEmptyRows |
Indique s’il faut masquer des lignes sans valeurs de données. Valeur booléenne. |
completedOnly |
Indique s’il faut masquer des colonnes sans valeurs de données. Valeur booléenne. |
skipRounding |
Appliquer ou ne pas arrondir. Valeur booléenne. |
showDimensionLabels |
Affiche ou non les étiquettes de dimension. Valeur booléenne. |
hideTitle |
Masque ou non le titre. Valeur booléenne. |
hideSubtitle |
Cache le sous-titre ou non. Valeur booléenne. |
hideLegend |
Afficher/masquer la légende. Très susceptible d’être utilisé par les graphiques. Valeur booléenne. |
showHierarchy |
Affiche (ou non) les noms de la hiérarchie des unités de l’organisation. Valeur booléenne. |
showData |
Utilisé par les graphiques pour masquer ou non les données/valeurs dans le modèle rendu. Valeur booléenne. |
lastUpdatedBy |
Objet représentant l’utilisateur qui a appliqué les dernières modifications à la visualisation. |
lastUpdated |
Date/heure de la dernière modification de la visualisation. |
favorites |
Liste des identifiants utilisateur qui ont marqué cet objet comme favori. |
subscribers |
Liste des identifiants d’utilisateur qui se sont inscrits à cette visualisation. |
translations |
Ensemble de traduction d’objet disponible, normalement filtré par locale. |
Une réponse plus adaptée peut être obtenue en précisant, dans l’URL, les champs que vous souhaitez extraire. C’est à dire:
status |
Time |
Size |
200 OK |
858 ms |
476 B |
{
"interpretations": []
}
Important
