Différences

Ci-dessous, les différences entre deux révisions de la page.

--- serveurscrutari:json:type_engine [2014/09/24 20:24]
vincent
+++ serveurscrutari:json:type_engine [2017/11/05 14:59] (Version actuelle)
vincent [Objet retourné]
@@ Ligne 1: / Ligne 1: @@
 ====== type = engine ======
-Cette requête JSON donne un certain nombre d'informations sur le moteur. C'est une compilation des requêtes //type=base//, //type=corpus// et //type=thesaurus// avec des informations supplémentaire.
+Cette requête JSON donne un certain nombre d'informations sur le moteur. Certaines de ces informations sont identiques à celles que l'on peut récupérer par les requêtes //type=base//, //type=corpus// et //type=thesaurus// mais organisées sous la forme de tableau associatif (un objet dans le format JSON) plutôt que sous la forme d'un tableau.
 ===== Paramètres =====
@@ Ligne 7: / Ligne 7: @@
 ==== Paramètres communs obligatoires ====
-  * //version// : version à utiliser (Version actuelle : 1)
+  * //version// : version à utiliser (Version actuelle : 3)
 ==== Paramètres communs optionnels ====
-  * //langui// : langue à utiliser de préférence pour les intitulés
+  * //lang// : langue à utiliser de préférence pour les intitulés
 ==== Paramètres spécifiques obligatoires ====
-  * //data// : liste des données à inclure, séparées par une virgule. Les valeurs possibles sont :
+  * //info// : liste des informations à inclure, séparées par une virgule. Les valeurs possibles sont :
-    * //all// : toutes les données disponibles
+    * //all// : toutes les informations disponibles
-    * //base// : données sur les bases
+    * //base// : informations sur les bases
-    * //corpus// : données sur les corpus
+    * //corpus// : informations sur les corpus
-    * //thesaurus// : données sur les thésaurus
+    * //thesaurus// : informations sur les thésaurus
-    * //stats// : statistiques
+    * //stats// : statistiques (conditionne également la présence de la clé « stats » dans les objets //base//, //corpus// et //thesarus//
     * //lang// : table des libellés de langue
+    * //attributes// : attributs disponibles
+    * //metadata// : méta-données du moteur
 ==== Paramètres spécifiques optionnels ====
@@ Ligne 28: / Ligne 30: @@
 ===== Objet retourné =====
+Version 3
 <code javascript>
@@ Ligne 34: / Ligne 38: @@
     baseMap: { // tableau associatif des bases
        code_(+ code): {//les bases sont identifiées par des clés avec la concaténation de la chaine "code_" et du code
-            //objet identique à celui  compris dans baseArray de la requête type=base
+            //objet identique à celui  compris dans baseArray de la requête type=base (version 3)
        }
-     }
+    },
-     corpusMap: { // tableau associatif des corpus
+    corpusMap: { // tableau associatif des corpus
-       code_(+ code): {//les corpus sont identifiées par des clés avec la concaténation de la chaine "code_" et du code
+      code_(+ code): {//les corpus sont identifiées par des clés avec la concaténation de la chaine "code_" et du code
-            //objet identique à celui compris dans corpusArray de la requête type=corpus
+           //objet identique à celui compris dans corpusArray de la requête type=corpus (version 3)
-       }
+      }
-     }
+    },
-     baseMap: { // tableau associatif des thésaurus
+    thesaurusMap: { // tableau associatif des thésaurus
+      code_(+ code): {//les bases sont identifiées par des clés avec la concaténation de la chaine "code_" et du code
+           //objet identique à celui compris dans thesaurusArray de la requête type=thesaurus (version 3)
+      }
+    },
+    categoryMap: {//tableau associatif des catégories, absent s'il n'y a aucune catégorie
+      (nom de la catégorie): {//les clés sont les noms de la catégorie
+        //objet identique aux catégories de categorieArray dans type=category (version 3)
+      }
+    },
+    attributes: {//Objet décrivant les attributs
+      primary; [//tableau des attributs du premier groupe (peut être vide)
+         {
+           name:  … ,//nom complet de l'attribut
+           ns:  … ,//espace de nom de l'attribut
+           key: … ,//clé locale de l'attribut
+           type:  … ,//type de l'attribut (valeur : inline, list ou block)
+           title:  …, //titre de l'attribut dans la langue d'interface
+           phraseMap: { // tableau associatif des intitulés associés à la catégorie
+              (nom): … , // nom de l'intitulé auquel correspond sa valeur (chaine)
+           },
+           attrMap: { // tableau associatif des attributs associés à la base
+              (clé): [ // la clé est celle de l'attribut, la valeur est le tableau des valeurs de l'attribut
+           ]
+        }
+         }
+      ],
+      secondary [//tableau des attributs du second groupe (peut être vide)
+         {
+         //objet identique à ceux du tableau du premier groupe
+         }
+      ],
+      technical [//tableau des attributs techniques (peut être vide)
+         {
+         //objet identique à ceux du tableau du premier groupe
+         }
+      ]
+    },
+    metadata: {//Objet contenant les méta-données
+      title: … ,//titre du moteur
+      phraseMap: { // tableau associatif des intitulés associés à la catégorie
+          (nom): … , // nom de l'intitulé auquel correspond sa valeur (chaine)
+      },
+      icon: … ,//icone du moteur
+      website: … ,//site de référence du moteur
+      attrMap: { // tableau associatif des attributs
+        (clé): [ // la clé est celle de l'attribut
+          … //valeurs de l'attribut
+         ]
+      }
+    },
+    langMap: {//tableau similaire à celui de type=lang comprenant toutes les langues se trouvant dans les fiches
+      {code de la langue}: {initulé de langue} , //tableau associatif entre le code et l'intitulé),
+    },
+     stats: {//statistiques sur le moteur
+      base: … , // nombre de bases du moteur
+      corpus: … , // nombre de corpus du moteur
+      thesaurus: … , //nombre de thésauru du moteur
+      fiche: … , //nombre de fiche du moteur
+      motcle: … , //nombre de mots-clé du moteur
+      indexation: … , //nombre d'indexations du moteur
+      langArray: [//statistiques des fiches par langue
+          {
+             lang:  … , // code de la langue
+             fiche: …  //nombre de fiches
+          }
+      ]
+    }
+  }
+}
+</code>
+Version 2 et inférieures :
+<code javascript>
+{
+  engineInfo: {
+    baseMap: { // tableau associatif des bases
        code_(+ code): {//les bases sont identifiées par des clés avec la concaténation de la chaine "code_" et du code
-            //objet identique à celui compris dans thesaurusArray de la requête type=thesaurus
+            //objet identique à celui  compris dans baseArray de la requête type=base
        }
-     }
+    },
-     stats: {//statistiques sur le moteur
+    corpusMap: { // tableau associatif des corpus
-       base: … , // nombre de bases du moteur
+      code_(+ code): {//les corpus sont identifiées par des clés avec la concaténation de la chaine "code_" et du code
-       corpus: … , // nombre de corpus du moteur
+           //objet identique à celui compris dans corpusArray de la requête type=corpus
-       thesaurus: … , //nombre de thésauru du moteur
+      }
-       fiche: … , //nombre de fiche du moteur
+    },
-       motcle: … , //nombre de mots-clé du moteur
+    thesaurusMap: { // tableau associatif des thésaurus
-       indexation: … , //nombre d'indexations du moteur
+      code_(+ code): {//les bases sont identifiées par des clés avec la concaténation de la chaine "code_" et du code
-       langArray: [//statistiques des fiches par langue
+           //objet identique à celui compris dans thesaurusArray de la requête type=thesaurus
-           {
+      }
-              lang:  … , // code de la langue
+    },
-              fiche: …  //nombre de fiches
+    stats: {//statistiques sur le moteur
-           }
+      base: … , // nombre de bases du moteur
-       ]
+      corpus: … , // nombre de corpus du moteur
-     }
+      thesaurus: … , //nombre de thésauru du moteur
-     langMap: {//tableau similaire ) celui de type=lang comprenant toutes les langues se trouvant dans les fiches
+      fiche: … , //nombre de fiche du moteur
-       {code de la langue}: {initulé de langue} , //tableau associatif entre le code et l'intitulé),
+      motcle: … , //nombre de mots-clé du moteur
-     }
+      indexation: … , //nombre d'indexations du moteur
+      langArray: [//statistiques des fiches par langue
+          {
+             lang:  … , // code de la langue
+             fiche: …  //nombre de fiches
+          }
+      ]
+    },
+    categoryMap: {//tableau associatif des catégories, absent s'il n'y a aucune catégorie
+      (nom de la catégorie): {//les clés sont les noms de la catégorie
+        //objet identique aux catégories de categorieArray dans type=category
+      }
+    },
+    langMap: {//tableau similaire à celui de type=lang comprenant toutes les langues se trouvant dans les fiches
+      {code de la langue}: {initulé de langue} , //tableau associatif entre le code et l'intitulé),
+    },
+    attributes: {//Objet décrivant les attributs
+      primary; [//tableau des attributs du premier groupe (peut être vide)
+         {
+           name:  … ,//nom complet de l'attribut
+           ns:  … ,//espace de nom de l'attribut
+           key: … ,//clé locale de l'attribut
+           type:  … ,//type de l'attribut (valeur : inline, list ou block)
+           title:  … //titre de l'attribut dans la langue d'interface
+         }
+      ],
+      secondary [//tableau des attributs du second groupe (peut être vide)
+         {
+         //objet identique à ceux du tableau du premier groupe
+         }
+      ]
+    },
+    metadata: {//Objet contenant les méta-données
+      title: … ,//titre du moteur
+      description: … ,//description courte du moteur
+      icon: … ,//icone du moteur
+      website: … ,//site de référence du moteur
+      attrMap: { // tableau associatif des attributs
+        (clé): [ // la clé est celle de l'attribut
+          … //valeurs de l'attribut
+         ]
+      }
     }
   }