| Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente |
| serveurscrutari:json:type_fiche [2013/04/16 19:04] – filtres vincent | serveurscrutari:json:type_fiche [2022/07/06 16:39] (Version actuelle) – vincent |
|---|
| |
| ===== Paramètres ===== | ===== Paramètres ===== |
| | |
| | ==== Paramètres communs obligatoires ==== |
| | * //version// : version à utiliser (Version actuelle : 3) |
| |
| |
| |
| |
| * //langui// : langue à utiliser de préférence pour les intitulés | * //lang// : langue à utiliser de préférence pour les intitulés |
| | * //langlist// : limitation des fiches à certaines langues (ignoré si //fichelist// est défini) |
| | * //baselist// : limitation des fiches à certaines bases (ignoré si //fichelist// est défini) |
| * //corpuslist// : limitation des fiches à certains corpus (ignoré si //fichelist// est défini) | * //corpuslist// : limitation des fiches à certains corpus (ignoré si //fichelist// est défini) |
| * //fichefields// : détermine les champs à transmettre (voir [[serveurscrutari:json:fiche_fields|Champs des fiches]]) | * //categorylist// : limitation des fiches aux corpus appartenant aux catégories indiquées (ignoré si //fichelist// est défini) |
| | * //fichefields// : détermine les champs à transmettre (voir [[serveurscrutari:json:fiche_fields|Champs des fiches]]), si le paramètre contient //codemotclearray//, les mots-clés indexant la fiche sont également transmis |
| | * //fieldvariant// : variante de champs à utiliser (voir le fichier [[serveurscrutari:config:fields|fields.xml]] et [[serveurscrutari:json:fiche_fields|Champs des fiches]]) (ignoré si //fichefields// est défini) |
| |
| ==== Paramètres spécifiques optionnels ==== | ==== Paramètres spécifiques optionnels ==== |
| |
| * //fichelist// : liste de codes de fiches, s'il est présent les autres paramètres sont ignorés | * //fichelist// : liste de codes de fiches, s'il est présent les autres paramètres sont ignorés |
| * //flt// (//flt-indexation//, //flt-date//, //flt-qid//) : filtres établissant la sélection de fiches (voir [[serveurscrutari:json:filtersyntax|Syntaxe des filtres]]) | * //flt// (//flt-*//) : filtres établissant la sélection de fiches (voir [[serveurscrutari:json:filtersyntax|Syntaxe des filtres]]) |
| | * //ignore// : la valeur //alternate// indique que les fiches qui sont des traductions d'autres fiches également sélectionnées (et dans la langue principales) sont ignorées |
| | * //insert// : la valeur //motclearray// indique qu'il faut ajouter le tableau des mots-clés dont les codes seront dans //codemotcleArray// d'une fiche, l'argument n'est pas pris en compte si //codemotcleArray// ne fait pas partie des champs d'une fiche |
| | * //random// : vaut - 1 ou un entier strictement positif, indique le nombre de fiches qu'il faut conserver après les filtres, ces fiches sont sélectionnées aléatoirement ; si la valeur est -1, toutes les fiches sont retournées classées de façon aléatoire |
| |
| |
| ===== Objet retourné ===== | ===== Objet retourné ===== |
| | |
| | Version 3 et 2 : |
| | |
| | <code javascript> |
| | { |
| | ficheArray: [ // tableau des fiches |
| | { // chaque fiche est un objet |
| | __fiche-fields__ // série de propriétés définies par le paramètre fichefields |
| | } |
| | ], |
| | motcleArray : [ // tableau des mots-clés si insert=motcleArray |
| | { // chaque mot-clé est un objet |
| | ... // construit de manière identique à motcleArray de type=motcle |
| | } |
| | } |
| | |
| | </code> |
| | |
| | Version 1 (//ficheArray// était encapsulé dans un objet //ficheData//) : |
| |
| <code javascript> | <code javascript> |
| ficheArray: [ // tableau des fiches | ficheArray: [ // tableau des fiches |
| { // chaque fiche est un objet | { // chaque fiche est un objet |
| __fiche-fields__ // série de propriétés définies par le paramètre fichefields | __fiche-fields__ // série de propriétés définies par le paramètre fichefields, |
| | codemotcleArray: [...] // tableau des codes des mots-clés indexant la fiche (tableau d'entiers > 0), si codemotclearray est indiqué dans fichefields ou dans la variante précisée par fieldvariant |
| } | } |
| ] | ] |
