Afficher une liste des formulaires sur une page Web à l’aide d’API listing-forms-on-a-web-page-using-apis

func

Spécifie 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.

appPath

Spécifie le chemin d’accès à l’application pour rechercher des 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. Plusieurs chemins distincts avec une barre verticale (|).

cutPoints

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.

relation

Indique les ressources connexes à récupérer avec les résultats de la recherche. Vous pouvez sélectionner l’une des options suivantes pour récupérer les ressources connexes :

• NO_RELATION  : ne pas récupérer les ressources 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).

maxSize

Indique le nombre maximal de formulaires à récupérer.

offset

Indique le nombre de formulaires à ignorer depuis le début.

returnCount

Indique s’il faut renvoyer ou non les résultats de recherche correspondant aux critères spécifiés.

statements

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  : spécifie le nom de la propriété à rechercher.

• value  : spécifie la valeur de la propriété à rechercher.

• operator  : spécifie l’opérateur à appliquer lors de la recherche. Les opérateurs ci-dessous sont pris en charge :

  • EQ - Est égal à
  • NEQ – Est différent de
  • GT – Supérieur à
  • LT – Inférieur à
  • GTEQ – Supérieur ou égal à
  • LTEQ – 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 la partie initiale 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.

orderings

Indique les critères d’ordre relatifs aux résultats de la recherche. Les critères sont définis au format JSON. Vous pouvez trier les résultats de la recherche sur plusieurs champs. Les résultats sont triés dans l’ordre selon l’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());

• Nom  : spécifie le nom de la propriété à utiliser pour classer les résultats de la recherche.

• Critères  : spécifie 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.

includeXdp

Indique si le contenu binaire doit être récupéré ou non. L’attribut includeXdp s’applique aux ressources de type FORM, PDFFORM et PRINTFORM.

assetType

Indique les types de ressources à récupérer de toutes les ressources publiées. Utilisez la barre verticale (|) pour indiquer plusieurs types de ressources. Les types de ressources valides sont FORM, PDFFORM, PRINTFORM, RESOURCE et GUIDE.