Fonctions communes:API - BROWSE - DATA : Différence entre versions

De Logilys
Aller à : navigation, rechercher
(→‎Informations retournées)
 
(67 révisions intermédiaires par le même utilisateur non affichées)
Ligne 1 : Ligne 1 :
 
{{Entete_TOC}}
 
{{Entete_TOC}}
−
== Afficher les données d'une grille ==
+
== Récupérer les données d'une grille ==
 
Sert à afficher les données pour une grille en mentionnant la vue, le filtre et les boutons de filtre rapide utilisés.
 
Sert à afficher les données pour une grille en mentionnant la vue, le filtre et les boutons de filtre rapide utilisés.
 
<br><br>
 
<br><br>
Ligne 8 : Ligne 8 :
 
* GridCode : Code pour identifier la grille. Voir la [[Fonctions_communes:API_-_GridCode|liste des codes de grille]]
 
* GridCode : Code pour identifier la grille. Voir la [[Fonctions_communes:API_-_GridCode|liste des codes de grille]]
 
* NomSession : Même nom de session utilisé lors de l'envoi d'une requête sous forme de JSON.
 
* NomSession : Même nom de session utilisé lors de l'envoi d'une requête sous forme de JSON.
−
* LngUID : Langue d'affichage (0 = Français, 1 = Anglais)
+
* ViewUID : ID de la vue que l'on souhaite afficher. Récupérer le ID grâce au [[Fonctions_communes:API_-_SELECT_-_GRID_CONFIG|SELECT / GRID_CONFIG]]. Doit être à 0 si les vues ne sont pas actives pour cette grille.
−
* ViewUID : ID de la vue que l'on souhaite afficher. Récupérer le ID grâce au [[Fonctions_communes:API_-_SELECT_-_GRID_CONFIG|SELECT / GRID_CONFIG]].
+
* FilterUID : ID du filtre sauvegardé à appliquer. Récupérer le ID grâce au [[Fonctions_communes:API_-_SELECT_-_GRID_CONFIG|SELECT / GRID_CONFIG]]. Doit être à 0 si les filtres ne sont pas actifs pour cette grille ou si aucun filtre n'est appliqué.
−
* FilterUID : ID du filtre sauvegardé à appliquer. Récupérer le ID grâce au [[Fonctions_communes:API_-_SELECT_-_GRID_CONFIG|SELECT / GRID_CONFIG]].
 
 
* PushButtons : Liste des noms de boutons de filtre rapide actif séparés par des virgules. Récupérer les noms grâce au [[Fonctions_communes:API_-_SELECT_-_GRID_CONFIG|SELECT / GRID_CONFIG]].
 
* PushButtons : Liste des noms de boutons de filtre rapide actif séparés par des virgules. Récupérer les noms grâce au [[Fonctions_communes:API_-_SELECT_-_GRID_CONFIG|SELECT / GRID_CONFIG]].
−
* SearchValue : Filtre de la barre de recherche.
+
* SearchValue : Filtre de la barre de recherche. Pour chercher le texte « abc » sur toutes les colonnes, il faut inscrire ceci <Search Field="" Value="abc">. Pour chercher sur une colonne en particulier, il faut documenter l'attribut Field avec le nom du champ sur lequel on souhaite chercher. Il est aussi possible de chercher sur plusieurs champs à la fois en ajoutant plusieurs node <Search>. Il n'est pas possible de combiner la recherche sur toutes les colonnes et sur des colonnes en particulier.
−
* SpecialWhere : Filtre forcé et non modifiable par l'utilisateur.
+
* RangeStart : Indique la plage d'élément à sélectionner. Par exemple, pour retourner uniquement les 25 premières lignes, saisir 1. <ref name="range0" />
−
* RangeStart : Indique la plage d'élément à sélectionner. Par exemple, pour retourner uniquement les 25 premières lignes, saisir 1.
+
* RangeEnd : Indique la plage d'élément à sélectionner. Par exemple, pour retourner uniquement les 25 premières lignes, saisir 25. <ref name="range0" />
−
* RangeEnd : Indique la plage d'élément à sélectionner. Par exemple, pour retourner uniquement les 25 premières lignes, saisir 25.
+
* Params : XML contenant une liste de paramètres nécessaire pour l'exécution de la requête. (Ex: <Param Name="CliNo" Value="123" />)
−
{{BasPage}}
+
 
 +
== Informations retournées  ==
 +
<pre>
 +
{ 
 +
  "Column":[ 
 +
    { 
 +
      "FieldName":"CliNo",
 +
      "FieldDataType":"INT",
 +
      "FieldVarcharSize":"0",
 +
      "FieldDisplayFormat":"000 000",
 +
      "FieldDisplayLabel":"No client",
 +
      "FieldIsImageIndex":"0",
 +
      "FieldIsImageIndexLegend":"<Image><No>1</No><FileName>CliNo_1</FileName><Label>Libellé de l'image 1</Label></Image>
 +
                                <Image><No>2</No><FileName>CliNo_2</FileName><Label>Libellé de l'image 2</Label></Image>",
 +
      "FieldIsCheckBox":"0",
 +
      "FieldRequired":"0",
 +
      "FieldIsPrimaryKey":"0",
 +
      "ColumnHidden":"0",
 +
      "ColumnWebPC":"1",
 +
      "ColumnWebTablet":"1",
 +
      "ColumnWebSmartphone":"1",
 +
      "ApplyCarFormat":"0",
 +
      "CarNbDecimal":"",
 +
      "CarSepDecimal":"",
 +
      "CarSepMillier":"",
 +
      "CarSymbole":"",
 +
      "CarPlaceSymbole":"",
 +
      "CarSeparateurDate":"",
 +
      "CarDateFormat":"",
 +
      "CommTypeMaitre":"3",
 +
      "SearchBarError":"1"
 +
    }
 +
  ],
 +
  "Data":[ 
 +
    { 
 +
      "CliNo":"1",
 +
      "CliCie":"0",
 +
      "zClient":"No\u00EBl, Sapin",
 +
      "CliAcronyme":"",
 +
      "AdrStd":"41, rue des Sapins",
 +
      "AdrVille":"P\u00F4le Nord",
 +
      "AdrProvince":"Qu\u00E9bec",
 +
      "AdrCodeP":"H0H 0H0"
 +
    }
 +
  ],
 +
  "Footer":[ 
 +
    { 
 +
      "RecordCount":"2821",
 +
      "CliNo_Value":"18253",
 +
      "CliNo_Aggregate":"COUNT",
 +
      "ListOfUID":"1,2,3,4,5,6,7,8,9,10,etc."
 +
    }
 +
  ]
 +
}
 +
</pre>
 +
'''Column''' : Liste des colonnes de la grille.
 +
* FieldName : Nom du champ
 +
* FieldDataType : Indique le type du champ
 +
* FieldVarcharSize : Indique le nombre de caractères permis pour un champ texte. (0 = pas un champ texte, -1 = aucune limite/texte long)
 +
* FieldDisplayFormat : Format d'affichage pour les nombres et les dates/heures
 +
* FieldDisplayLabel : Entête de colonne
 +
* FieldIsImageIndex : Pour les colonnes affichant une image, indique le ID de l'image.
 +
* FieldIsImageIndexLegend : Pour les colonnes affichant une image, retourne la liste des valeurs possibles dans cette colonne (No) ainsi que le libellé associé à cette valeur (Label). Retourne aussi le nom du fichier image (FileName).
 +
* FieldIsCheckBox : Indique si la colonne doit être affichée sous forme de case à cocher.
 +
* FieldRequired : Indique si la colonne doit toujours être retournée même si elle n'apparaît pas dans la vue.
 +
* FieldIsPrimaryKey : Retourne 1 si le champ contient un ID différent sur chaque ligne de la grille.
 +
* ColumnHidden : À 0, la colonne ne doit pas être affichée dans la grille
 +
* ColumnWebPC : Pour les sites web s'ajustant à la dimension de l'écran (responsive). Si 1, la colonne doit être affichée si l'écran correspond à celui d'un moniteur d'ordinateur.
 +
* ColumnWebTablet : Pour les sites web s'ajustant à la dimension de l'écran (responsive). Si 1, la colonne doit être affichée si l'écran correspond à celui d'une tablette.
 +
* ColumnWebSmartphone : Pour les sites web s'ajustant à la dimension de l'écran (responsive). Si 1, la colonne doit être affichée si l'écran correspond à celui d'un téléphone intelligent.
 +
* ApplyCarFormat : Si 1, il faut ignorer FieldDisplayFormat et utiliser les options de formatage de la caractéristique.
 +
* CarNbDecimal : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au nombre de décimales.
 +
* CarSepDecimal : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au séparateur de décimales.
 +
* CarSepMillier : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au séparateur de milliers.
 +
* CarSymbole : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au symbole monétaire.
 +
* CarPlaceSymbole : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, indique si le symbole monétaire doit être placé avant ou après le nombre. (0 = Après, 1 = Avant)
 +
* CarSeparateurDate : Si ApplyCarFormat est à 1 et que FieldDataType = DATETIME, correspond au séparateur de date.
 +
* CarDateFormat : Si ApplyCarFormat est à 1 et que FieldDataType = DATETIME, correspond au format d'affichage de la date.
 +
* CommTypeMaitre :
 +
** 1 = Téléphone
 +
** 2 = Courriel
 +
** 3 = Site web
 +
* SearchBarError : Retourne 1 si la valeur inscrite dans la barre de recherche est invalide.
 +
'''Data''' : Données
 +
* Voir la [[Fonctions_communes:API_-_GridCode|liste des codes de grille]]
 +
'''Footer''' : Informations au bas de la grille
 +
* RecordCount : Nombre de lignes dans la grille.
 +
* CliNo_Value : Valeur du sommaire en bas de grille. Composé du FieldName suivi de "_Value".
 +
* CliNo_Aggregate : Type de sommaire en bas de grille. Composé du FieldName suivi de "_Aggregate".
 +
** SUM = Somme
 +
** AVG = Moyennne
 +
** COUNT = Nombre de valeurs
 +
** DISTINCT = Nombre de valeurs distinctes
 +
** MIN = Minimum
 +
** MAX = Maximum
 +
* ListOfUID : Retourne la liste de UID de cette grille. Retourne un nombre de UID correspondant au Range. Ex: Si le range est de 1 à 25, on retourne 25 UID maximum.
 +
 
 +
== Notes ==
 +
<references>
 +
<ref name="range0">Si RangeStart et RangeEnd sont tous les deux à 0, tous les enregistrements seront retournés.</ref>
 +
</references>
 +
<br>
 +
{{BasPage_Fonctions_communes}}

Version actuelle datée du 6 mars 2019 à 11:12

API - BROWSE - DATA

Récupérer les données d'une grille

Sert à afficher les données pour une grille en mentionnant la vue, le filtre et les boutons de filtre rapide utilisés.

DemAction : BROWSE
DemCat : DATA
DemOptions :

  • GridCode : Code pour identifier la grille. Voir la liste des codes de grille
  • NomSession : Même nom de session utilisé lors de l'envoi d'une requête sous forme de JSON.
  • ViewUID : ID de la vue que l'on souhaite afficher. Récupérer le ID grâce au SELECT / GRID_CONFIG. Doit être à 0 si les vues ne sont pas actives pour cette grille.
  • FilterUID : ID du filtre sauvegardé à appliquer. Récupérer le ID grâce au SELECT / GRID_CONFIG. Doit être à 0 si les filtres ne sont pas actifs pour cette grille ou si aucun filtre n'est appliqué.
  • PushButtons : Liste des noms de boutons de filtre rapide actif séparés par des virgules. Récupérer les noms grâce au SELECT / GRID_CONFIG.
  • SearchValue : Filtre de la barre de recherche. Pour chercher le texte « abc » sur toutes les colonnes, il faut inscrire ceci <Search Field="" Value="abc">. Pour chercher sur une colonne en particulier, il faut documenter l'attribut Field avec le nom du champ sur lequel on souhaite chercher. Il est aussi possible de chercher sur plusieurs champs à la fois en ajoutant plusieurs node <Search>. Il n'est pas possible de combiner la recherche sur toutes les colonnes et sur des colonnes en particulier.
  • RangeStart : Indique la plage d'élément à sélectionner. Par exemple, pour retourner uniquement les 25 premières lignes, saisir 1. [1]
  • RangeEnd : Indique la plage d'élément à sélectionner. Par exemple, pour retourner uniquement les 25 premières lignes, saisir 25. [1]
  • Params : XML contenant une liste de paramètres nécessaire pour l'exécution de la requête. (Ex: <Param Name="CliNo" Value="123" />)

Informations retournées

{  
  "Column":[  
    {  
      "FieldName":"CliNo",
      "FieldDataType":"INT",
      "FieldVarcharSize":"0",
      "FieldDisplayFormat":"000 000",
      "FieldDisplayLabel":"No client",
      "FieldIsImageIndex":"0",
      "FieldIsImageIndexLegend":"<Image><No>1</No><FileName>CliNo_1</FileName><Label>Libellé de l'image 1</Label></Image>
                                 <Image><No>2</No><FileName>CliNo_2</FileName><Label>Libellé de l'image 2</Label></Image>",
      "FieldIsCheckBox":"0",
      "FieldRequired":"0",
      "FieldIsPrimaryKey":"0",
      "ColumnHidden":"0",
      "ColumnWebPC":"1",
      "ColumnWebTablet":"1",
      "ColumnWebSmartphone":"1",
      "ApplyCarFormat":"0",
      "CarNbDecimal":"",
      "CarSepDecimal":"",
      "CarSepMillier":"",
      "CarSymbole":"",
      "CarPlaceSymbole":"",
      "CarSeparateurDate":"",
      "CarDateFormat":"",
      "CommTypeMaitre":"3",
      "SearchBarError":"1"
    }
  ],
  "Data":[  
    {  
      "CliNo":"1",
      "CliCie":"0",
      "zClient":"No\u00EBl, Sapin",
      "CliAcronyme":"",
      "AdrStd":"41, rue des Sapins",
      "AdrVille":"P\u00F4le Nord",
      "AdrProvince":"Qu\u00E9bec",
      "AdrCodeP":"H0H 0H0"
    }
  ],
  "Footer":[  
    {  
      "RecordCount":"2821",
      "CliNo_Value":"18253",
      "CliNo_Aggregate":"COUNT",
      "ListOfUID":"1,2,3,4,5,6,7,8,9,10,etc."
    }
  ]
}

Column : Liste des colonnes de la grille.

  • FieldName : Nom du champ
  • FieldDataType : Indique le type du champ
  • FieldVarcharSize : Indique le nombre de caractères permis pour un champ texte. (0 = pas un champ texte, -1 = aucune limite/texte long)
  • FieldDisplayFormat : Format d'affichage pour les nombres et les dates/heures
  • FieldDisplayLabel : Entête de colonne
  • FieldIsImageIndex : Pour les colonnes affichant une image, indique le ID de l'image.
  • FieldIsImageIndexLegend : Pour les colonnes affichant une image, retourne la liste des valeurs possibles dans cette colonne (No) ainsi que le libellé associé à cette valeur (Label). Retourne aussi le nom du fichier image (FileName).
  • FieldIsCheckBox : Indique si la colonne doit être affichée sous forme de case à cocher.
  • FieldRequired : Indique si la colonne doit toujours être retournée même si elle n'apparaît pas dans la vue.
  • FieldIsPrimaryKey : Retourne 1 si le champ contient un ID différent sur chaque ligne de la grille.
  • ColumnHidden : À 0, la colonne ne doit pas être affichée dans la grille
  • ColumnWebPC : Pour les sites web s'ajustant à la dimension de l'écran (responsive). Si 1, la colonne doit être affichée si l'écran correspond à celui d'un moniteur d'ordinateur.
  • ColumnWebTablet : Pour les sites web s'ajustant à la dimension de l'écran (responsive). Si 1, la colonne doit être affichée si l'écran correspond à celui d'une tablette.
  • ColumnWebSmartphone : Pour les sites web s'ajustant à la dimension de l'écran (responsive). Si 1, la colonne doit être affichée si l'écran correspond à celui d'un téléphone intelligent.
  • ApplyCarFormat : Si 1, il faut ignorer FieldDisplayFormat et utiliser les options de formatage de la caractéristique.
  • CarNbDecimal : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au nombre de décimales.
  • CarSepDecimal : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au séparateur de décimales.
  • CarSepMillier : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au séparateur de milliers.
  • CarSymbole : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, correspond au symbole monétaire.
  • CarPlaceSymbole : Si ApplyCarFormat est à 1 et que FieldDataType = FLOAT, indique si le symbole monétaire doit être placé avant ou après le nombre. (0 = Après, 1 = Avant)
  • CarSeparateurDate : Si ApplyCarFormat est à 1 et que FieldDataType = DATETIME, correspond au séparateur de date.
  • CarDateFormat : Si ApplyCarFormat est à 1 et que FieldDataType = DATETIME, correspond au format d'affichage de la date.
  • CommTypeMaitre :
    • 1 = Téléphone
    • 2 = Courriel
    • 3 = Site web
  • SearchBarError : Retourne 1 si la valeur inscrite dans la barre de recherche est invalide.

Data : Données

Footer : Informations au bas de la grille

  • RecordCount : Nombre de lignes dans la grille.
  • CliNo_Value : Valeur du sommaire en bas de grille. Composé du FieldName suivi de "_Value".
  • CliNo_Aggregate : Type de sommaire en bas de grille. Composé du FieldName suivi de "_Aggregate".
    • SUM = Somme
    • AVG = Moyennne
    • COUNT = Nombre de valeurs
    • DISTINCT = Nombre de valeurs distinctes
    • MIN = Minimum
    • MAX = Maximum
  • ListOfUID : Retourne la liste de UID de cette grille. Retourne un nombre de UID correspondant au Range. Ex: Si le range est de 1 à 25, on retourne 25 UID maximum.

Notes

  1. ↑ 1,0 et 1,1 Si RangeStart et RangeEnd sont tous les deux à 0, tous les enregistrements seront retournés.


Nom du document : Fonctions communes:API - BROWSE - DATA

Récupérée de « http://wikifr.logilys.com/index.php?title=Fonctions_communes:API_-_BROWSE_-_DATA&oldid=20284 »