Auflisten von Formularen auf einer Webseite mithilfe von APIs listing-forms-on-a-web-page-using-apis

func

Gibt die Funktion zum Aufrufen an.  Legen Sie zur Suche nach Formularen den Wert des func -Attributs auf searchForms fest.

Beispiel:

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

Hinweis: Dieser Parameter ist obligatorisch.

appPath

Gibt den Anwendungspfad für die Suche nach Formularen an.  Standardmäßig durchsucht das appPath-Attribut alle Anwendungen, die auf der Ebene des Stammknotens verfügbar sind.

Sie können bei einer einzelnen Suchabfrage mehrere Anwendungspfade angeben.  Trennen Sie mehrere Pfade durch einen senkrechten Strich (|).

cutPoints

Gibt die Eigenschaften an, die mit den Elementen abgerufen werden sollen.  Sie können Sternchen (*) verwenden, um alle Eigenschaften gleichzeitig abzurufen.  Verwenden Sie den senkrechten Strich (|), um mehrere Eigenschaften anzugeben.

Beispiel: cutPoints=propertyName1|propertyName2|propertyName3

Hinweis:

• Eigenschaften wie ID, Pfad und Name werden immer abgerufen.
• Jedes Asset verfügt über einen anderen Satz an Eigenschaften. Eigenschaften wie formUrl, pdfUrl und guideUrl hängen nicht vom cutpoints-Attribut ab. Diese Eigenschaften sind vom Asset-Typ abhängig und werden entsprechend abgerufen.

relation

Gibt die zugehörigen Assets an, die neben den Suchergebnissen abgerufen werden.  Sie können eine der folgenden Optionen auswählen, um zugehörige Assets abzurufen:

• NO_RELATION: Zugehörige Assets nicht abrufen.
• IMMEDIATE: Assets abrufen, die direkt mit den Suchergebnissen zusammenhängen.
• ALL: Direkt und indirekt zugehörige Assets abrufen.

maxSize

Gibt die maximale Anzahl an Formularen zum Abrufen an.

offset

Gibt die Anzahl an Formularen an, die ab dem Start übersprungen werden sollen.

returnCount

Gibt an, ob die Suchergebnisse zurückgegeben werden, die den angegebenen Kriterien entsprechen oder nicht.

statements

Gibt die Liste der Anweisungen an.  Die Abfragen werden in der Liste der Anweisungen ausgeführt, die im JSON-Format angegeben sind.

Beispiel:

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

Im oben genannten Beispiel gilt Folgendes:

• name: gibt den Namen der Eigenschaft an, nach der gesucht werden soll.

• value: gibt den Wert der Eigenschaft an, nach der gesucht werden soll.

• operator: Gibt den Operator an, der bei der Suche angewendet werden soll. Die folgende Operatoren werden unterstützt:

  • EQ (equal to – gleich)
  • NEQ (not equal to – ungleich)
  • GT (greater than – größer als)
  • LT (less than – kleiner als)
  • GTEQ (greater than or equal to – größer oder gleich)
  • LTEQ (less than or equal to – kleiner oder gleich)
  • CONTAINS (ENTHÄLT – A enthält B, wenn B Teil von A ist)
  • FULLTEXT (Volltextsuche)
  • STARTSWITH (BEGINNT MIT – A beginnt mit B, wenn B der Anfangsteil von A ist)
  • ENDSWITH (ENDET MIT – A endet mit B, wenn B der Endteil von A ist)
  • LIKE (WIE – implementiert den LIKE-Operator)
  • AND (UND – kombiniert mehrere Anweisungen)

  Hinweis: Die Operatoren GT, LT, GTEQ und LTEQ gelten für Eigenschaften vom linearen Typ wie LONG, DOUBLE und DATE.

orderings

Gibt die Kriterien für die Reihenfolge der Suchergebnisse an. Die Kriterien sind im JSON-Format definiert. Sie können die Suchergebnisse nach mehr als einem Feld sortieren. Die Ergebnisse werden in der Reihenfolge sortiert, in der die Felder in der Abfrage angezeigt werden.

Beispiel:

Um die Abfrageergebnisse nach Titeleigenschaft in aufsteigender Reihenfolge abzurufen, fügen Sie den folgenden Parameter hinzu:

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: Gibt den Namen der Eigenschaft an, die zum Sortieren der Suchergebnisse verwendet werden soll.

• criteria: Gibt die Reihenfolge der Ergebnisse an. Das Sortierattribut akzeptiert die folgenden Werte:

  • ASC: Verwenden Sie ASC, um die Ergebnisse in aufsteigender Reihenfolge anzuordnen.
  • DES: Verwenden Sie DES, um die Ergebnisse in absteigender Reihenfolge anzuordnen.

includeXdp

Gibt an, ob der binäre Inhalt abgerufen werden soll oder nicht. Das Attribut includeXdp gilt für Assets vom Typ FORM, PDFFORM und PRINTFORM.

assetType

Gibt die Asset-Typen an, die von allen veröffentlichten Assets abgerufen werden sollen. Verwenden Sie den senkrechten Strich (|), um mehrere Asset-Typen anzugeben. Die folgenden Asset-Typen sind gültig: FORM, PDFFORM, PRINTFORM, RESOURCE und GUIDE.