Visa formulär på en webbsida med API:er listing-forms-on-a-web-page-using-apis

func

Anger den funktion som ska anropas. Om du vill söka efter formulär anger du värdet för func attribut till searchForms.

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

Obs! Den här parametern är obligatorisk.

appPath

Anger den programsökväg som ska användas för att söka efter formulär. Som standard söker attributet appPath igenom alla program som finns på rotnodnivån.

Du kan ange flera programsökvägar i en enda sökfråga. Avgränsa flera banor med vertikalstreck (|).

cutPoints

Anger vilka egenskaper som ska hämtas med resurserna. Du kan använda asterisk (*) för att hämta alla egenskaper samtidigt. Använd vertikalstrecksoperatorn (|) om du vill ange flera egenskaper.

Till exempel, cutPoints=propertyName1|propertyName2|propertyName3

Anteckning:

• Egenskaper som id, sökväg och namn hämtas alltid.
• Alla resurser har olika egenskapsuppsättningar. Egenskaper som formUrl, pdfUrl och guideUrl är inte beroende av attributet cutpoints. Dessa egenskaper beror på resurstypen och hämtas därefter.

relation

Anger de relaterade resurser som ska hämtas tillsammans med sökresultaten. Du kan välja något av följande alternativ för att hämta relaterade resurser:

• NO_RELATION: Hämta inte relaterade resurser.
• OMEDELBART: Hämtar resurser som är direkt relaterade till sökresultat.
• ALLA: Hämta direkt och indirekt relaterade tillgångar.

maxSize

Anger maximalt antal formulär som ska hämtas.

offset

Anger antalet formulär som ska hoppas över från början.

returnCount

Anger om sökresultaten som matchar det angivna villkoret ska returneras eller inte.

programsatser

Anger listan med programsatser. Frågorna körs i listan med programsatser som anges i JSON-format.

Till exempel,

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

I exemplet ovan

• name: Anger namnet på egenskapen som ska sökas efter.

• value: anger värdet på den egenskap som du vill söka efter.

• operator: anger vilken operator som ska användas vid sökning. Följande operatorer stöds:

  • EQ - lika med
  • NEQ - Inte lika med
  • GT - större än
  • LT - Mindre än
  • GTEQ - större än eller lika med
  • LTEQ - mindre än eller lika med
  • CONTAINS - A innehåller B om B är en del av A
  • FULLTEXT - Fullständig textsökning
  • STARTSWITH - A börjar med B om B är den första delen av A
  • ENDSWITH - A slutar med B om B är slutdelen av A
  • LIKE - Implementerar operatorn LIKE
  • AND - Kombinera flera programsatser

  Obs! GT-, LT-, GTEQ- och LTEQ-operatorer kan användas för egenskaper av linjär typ som LONG, DUBLE och DATE.

orderfunktioner

Anger sökresultatens ordningsvillkor. Kriterierna definieras i JSON-formatet. Du kan sortera sökresultat i mer än ett fält. Resultatet sorteras i den ordning som fälten visas i frågan.

Till exempel,

Om du vill hämta frågeresultat ordnade efter title-egenskap i stigande ordning lägger du till följande parameter:

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: Anger namnet på den egenskap som ska användas för att ordna sökresultaten.

• kriterier: Anger resultatordningen. Attributet order accepterar följande värden:

  • ASC - Använd ASC för att ordna resultatet i stigande ordning.
  • DES - Använd DES för att ordna resultatet i fallande ordning.

includeXdp

Anger om det binära innehållet ska hämtas eller inte. The includeXdp attribut kan användas för tillgångar av typen FORM, PDFFORMoch PRINTFORM.

assetType

Anger de resurstyper som ska hämtas från alla publicerade resurser. Använd vertikalstrecksoperatorn (|) för att ange flera resurstyper. Giltiga resurstyper är FORM, PDFFORM, PRINTFORM, RESOURCE och GUIDE.