Affichage d’une liste des formulaires sur une page Web à l’aide d’API

Indique la fonction à appeler. Pour effectuer une recherche dans les formulaires, définissez la valeur de l’attribut func sur searchForms.

Par exemple,
URLParameterBuilder entityBuilder=new URLParameterBuilder ();
entityBuilder.add("func", "searchForms");

Remarque : ce paramètre est obligatoire.

Spécifie le chemin d’application pour la recherche de formulaires. Par défaut, l’attribut appPath recherche toutes les applications disponibles au niveau du nœud racine.

Vous pouvez spécifier plusieurs chemins d’application dans une seule requête de recherche. Plusieurs chemins distincts avec une barre verticale (|).  

Indique les propriétés à récupérer avec les ressources. Vous pouvez utiliser l’astérisque (*) pour récupérer toutes les propriétés simultanément. Utilisez la barre verticale (|) pour indiquer plusieurs propriétés.  

Par exemple, cutPoints=propertyName1|propertyName2|propertyName3

Remarque : 

• Les propriétés telles que l’ID, le chemin et le nom sont toujours récupérées.
• Chaque ressource possède un ensemble de propriétés différent. Les propriétés telles que formUrl, pdfUrl et guideUrl ne dépendent pas de l’attribut cutPoints. Elles dépendent du type de ressource et sont récupérées en conséquence.  

• NO_RELATION : ne pas récupérer les actifs connexes.
• IMMEDIATE : récupérer les ressources liées directement aux résultats de la recherche.
• ALL : récupérer toutes les ressources liées (directement et indirectement).

Indique la liste d’instructions. Les requêtes sont des exécutions sur la liste des instructions spécifiées au format JSON. 

Par exemple :

JSONArray statementArray=new JSONArray() ;
JSONObject statement=new JSONObject() ;
statement.put("name", "title") ;
statement.put("value", "SimpleSurveyAF") ;
statement.put("operator", "EQ") ; statementArray.put(statement) ;

Dans l’exemple ci-dessus, 

• name : indique le nom de la propriété à rechercher.
• value : indique la valeur de la propriété à rechercher.
• operator : indique l’opérateur à appliquer au cours de la recherche. Les opérateurs ci-dessous sont pris en charge :
  • EQ – Est égal à 
  • NEQ – Est différent de 
  • GT – Est supérieur à
  • LT – Est inférieur à
  • GTEQ – Est supérieur ou égal à
  • LTEQ – Est inférieur ou égal à
  • CONTAINS – A contient B si B fait partie de A
  • FULLTEXT – Recherche de texte intégral
  • STARTSWITH – A commence par B si B est le début de A
  • ENDSWITH – A se termine par B si B est la fin de A
  • LIKE – Implémente l’opérateur LIKE
  • AND – Combine plusieurs instructions

  Remarque : les opérateurs GT, LT, GTEQ et LTEQ s’appliquent aux propriétés de type linéaire, telles que LONG, DOUBLE et DATE.

Indique les critères d’ordre relatifs aux résultats de la recherche. Les critères sont définis au format JSON. Vous pouvez classer les résultats de la recherche selon plusieurs champs. Les résultats sont classés selon l’ordre d’apparition des champs dans la requête.

Par exemple :

Pour récupérer les résultats de la requête selon la propriété de titre dans l’ordre croissant, ajoutez le paramètre suivant :  

JSONArray orderingsArray=new JSONArray() ;
JSONObject orderings=new JSONObject() ;
orderings.put("name", "title ») ;
orderings.put("criteria", "ASC ») ;
orderingsArray.put(orderings) ;
entityBuilder.add("orderings", orderingsArray.toString()) ;

• name : indique le nom de la propriété à utiliser pour classer les résultats de la recherche.
• criteria : indique l’ordre des résultats. L’attribut d’ordre accepte les valeurs suivantes :
  • ASC – Utilisez l’attribut ASC pour classer les résultats dans l’ordre croissant.
    
  • DES – Utilisez l’attribut DES pour classer les résultats dans l’ordre décroissant.