Formulieren met API's op een webpagina weergeven listing-forms-on-a-web-page-using-apis

func

Geeft de aan te roepen functie op. Als u formulieren wilt zoeken, stelt u de waarde van het kenmerk func in op searchForms .

Bijvoorbeeld:

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

Nota: Deze parameter is verplicht.

appPath

Hier geeft u het toepassingspad op dat u wilt gebruiken om formulieren te zoeken. Door gebrek, zoekt het appPath attribuut alle toepassingen beschikbaar op het niveau van de wortelknoop.

U kunt meerdere toepassingspaden opgeven in één zoekquery. Scheid meerdere paden met verticale streep (|).

cutPoints

Geeft de eigenschappen aan die met de elementen moeten worden opgehaald. U kunt sterretje (*) gebruiken om alle eigenschappen tegelijk op te halen. Gebruik de verticale operator (|) om meerdere eigenschappen op te geven.

Bijvoorbeeld: cutPoints=propertyName1|propertyName2|propertyName3

Nota :

• Eigenschappen zoals id, path en name worden altijd opgehaald.
• Elk element heeft een andere set eigenschappen. Eigenschappen zoals formUrl, pdfUrl en guideUrl zijn niet afhankelijk van het kenmerk cutpoints. Deze eigenschappen zijn afhankelijk van het type element en worden dienovereenkomstig opgehaald.

relation

Hiermee geeft u de verwante elementen op die samen met de zoekresultaten moeten worden opgehaald. U kunt een van de volgende opties kiezen om gerelateerde elementen op te halen:

• NO_RELATION : Haal geen verwante activa.
• ONMIDDELLIJK : Vetst activa die direct met onderzoeksresultaten verwant zijn.
• ALLES : Vets direct en onrechtstreeks verwante activa.

maxSize

Hiermee geeft u het maximum aantal formulieren op dat moet worden opgehaald.

offset

Hier geeft u het aantal formulieren op dat u vanaf het begin wilt overslaan.

returnCount

Geeft aan of de zoekresultaten die aan de opgegeven criteria voldoen, moeten worden geretourneerd.

instructies

Hier geeft u de lijst met instructies op. De query's worden uitgevoerd in de lijst met instructies die in de JSON-indeling zijn opgegeven.

Bijvoorbeeld:

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

In het bovenstaande voorbeeld:

• naam : specificeert de naam van het bezit aan onderzoek naar.

• waarde : specificeert de waarde van het bezit aan onderzoek naar.

• exploitant : specificeert de exploitant toe te passen terwijl het zoeken. De volgende operatoren worden ondersteund:

  • EQ - Gelijk aan
  • NEQ - niet gelijk aan
  • GT - Groter dan
  • LT - Minder dan
  • GTEQ - Groter dan of gelijk aan
  • LTEQ - kleiner dan of gelijk aan
  • BEVAT - A bevat B als B deel uitmaakt van A
  • FULLTEXT - Volledige tekstzoekopdracht
  • STARTSWITH - A begint met B als B het eerste deel van A is
  • ENDSWITH - A eindigt met B als B het einddeel van A is
  • LIKE - Implementeert de operator LIKE
  • AND - Meerdere instructies combineren

  Nota: GT, LT, GTEQ, en de exploitanten LTEQ zijn van toepassing op eigenschappen van lineair type zoals LONG, DUBBEL, en DATUM.

orders

Hiermee geeft u de volgordecriteria voor de zoekresultaten op. De criteria worden gedefinieerd in de JSON-indeling. U kunt zoekresultaten sorteren op meerdere velden. De resultaten worden gesorteerd in de volgorde waarin de velden in de query worden weergegeven.

Bijvoorbeeld:

Voeg de volgende parameter toe om queryresultaten op te halen die zijn geordend door eigenschap title in oplopende volgorde:

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

• naam : Specificeert de naam van het bezit te gebruiken om tot de onderzoeksresultaten opdracht te geven.

• criteria : Specificeert de orde van de resultaten. Het kenmerk order accepteert de volgende waarden:

  • ASC - Gebruik ASC om resultaten in oplopende volgorde te rangschikken.
  • DES - Gebruik DES om resultaten in dalende orde te rangschikken.

includeXdp

Geeft aan of de binaire inhoud moet worden opgehaald. Het attribuut includeXdp is van toepassing op elementen van het type FORM , PDFFORM en PRINTFORM .

assetType

Geeft de elementtypen aan die moeten worden opgehaald van alle gepubliceerde elementen. Gebruik de verticale operator (|) om meerdere elementtypen op te geven. Geldige elementtypen zijn FORM, PDFFORM, PRINTFORM, RESOURCE en GUIDE.