Elencare moduli su una pagina web utilizzando le API listing-forms-on-a-web-page-using-apis

func

Specifica la funzione da chiamare. Per cercare i moduli, impostare il valore dell'attributo func su searchForms.

Ad esempio:

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

Nota: Questo parametro è obbligatorio.

appPath

Specifica il percorso dell'applicazione per la ricerca dei moduli. Per impostazione predefinita, l'attributo appPath cerca tutte le applicazioni disponibili a livello di nodo principale.

È possibile specificare più percorsi di applicazione in una singola query di ricerca. Separare più percorsi con il carattere barra verticale (|).

cutPoints

Specifica le proprietà da recuperare con le risorse. Puoi usare l’asterisco (*) per recuperare tutte le proprietà contemporaneamente. Utilizzare l'operatore pipe (|) per specificare più proprietà.

Ad esempio: cutPoints=propertyName1|propertyName2|propertyName3

Nota:

• Le proprietà come ID, percorso e nome vengono sempre recuperate.
• Ogni risorsa ha un set diverso di proprietà. Proprietà come formUrl, pdfUrl e guideUrl non dipendono dall’attributo cutpoints. Queste proprietà dipendono dal tipo di risorsa e vengono recuperate di conseguenza.

relazione

Specifica le risorse correlate da recuperare insieme ai risultati della ricerca. Per recuperare le risorse correlate, puoi scegliere una delle seguenti opzioni:

• NO_RELATION: non recuperare le risorse correlate.
• IMMEDIATO: recupera le risorse direttamente correlate ai risultati della ricerca.
• ALL: recupera le risorse direttamente e indirettamente correlate.

maxSize

Specifica il numero massimo di moduli da recuperare.

offset

Specifica il numero di moduli da saltare dall'inizio.

returnCount

Specifica se restituire o meno i risultati della ricerca che corrispondono ai criteri specificati.

istruzioni

Specifica l'elenco di istruzioni. Le query vengono eseguite nell’elenco delle istruzioni specificate nel formato JSON.

Ad esempio:

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

Nell’esempio precedente,

• name: specifica il nome della proprietà da cercare.

• value: specifica il valore della proprietà da cercare.

• operator: specifica l'operatore da applicare durante la ricerca. Sono supportati i seguenti operatori:

  • EQ - Uguale a
  • NEQ - Non uguale a
  • GT - Maggiore di
  • LT - Minore di
  • GTEQ - Maggiore o uguale a
  • LTEQ - Minore o uguale a
  • CONTAINS - A contiene B se B fa parte di A
  • FULL-TEXT - Ricerca full-text
  • STARTSWITH - A inizia con B se B è la parte iniziale di A
  • ENDSWITH: A termina con B se B è la parte finale di A
  • LIKE - Implementa l’operatore LIKE
  • AND - Combinare più istruzioni

  Nota: Gli operatori GT, LT, GTEQ e LTEQ sono applicabili a proprietà di tipo lineare come LONG, DOUBLE e DATE.

ordini

Specifica i criteri di ordine per i risultati della ricerca. I criteri sono definiti in formato JSON. È possibile ordinare i risultati di ricerca in più campi. I risultati vengono ordinati in base all'ordine di visualizzazione dei campi nella query.

Ad esempio:

Per recuperare i risultati della query ordinati per proprietà titolo in ordine crescente, aggiungi il seguente parametro:

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: specifica il nome della proprietà da utilizzare per ordinare i risultati della ricerca.

• criteri: specifica l'ordine dei risultati. L'attributo order accetta i seguenti valori:

  • ASC: utilizzare ASC per disporre i risultati in ordine crescente.
  • DES: utilizza DES per disporre i risultati in ordine decrescente.

includeXdp

Specifica se recuperare il contenuto binario. L'attributo includeXdp è applicabile per le risorse di tipo FORM, PDFFORM e PRINTFORM.

assetType

Specifica i tipi di risorse da recuperare da tutte le risorse pubblicate. Utilizza l’operatore pipe (|) per specificare più tipi di risorse. I tipi di risorse validi sono FORM, PDFFORM, PRINTFORM, RESOURCE e GUIDE.