API Elenco chiamate

API degli elenchi di accesso con richieste HTTP GET. Le API di elenco restituiscono un elenco di record che corrispondono ai criteri specificati nei parametri della richiesta.

Le richieste REST List utilizzano le API getNameList , dove Nome è il tipo di risorsa specificato nella richiesta. Per visualizzare l'elenco completo di risorse e API, visualizzare i file Javadoc REST.

Formato richiesta

Utilizzare il seguente formato di richiesta HTTP per chiamare le API dell'elenco:

GET https://host:port/contextRoot/restapi/Name?parameters

Il seguente esempio mostra una chiamata REST a getOrganizationList:

GET https://host:port/contextRoot/restapi/organization?IsNode=Y&OrganizationName=~like~DEMO

Filtro query

In una chiamata API REST List, puoi filtrare i risultati in base a parametri attributo / valore specificati nella query. Nell'esempio getOrganizationList , IsNode=Y e OrganizationName=~like~DEMO sono parametri attributo / valore. I parametri attributo/valore sono separati da ampere (&) nell' URL della richiesta.

È possibile specificare la relazione tra attributi e relativi valori con le seguenti opzioni di formattazione:

Formato	Descrizione
`attribute=value`	`attributo` uguale a `valore`.
`attribute=~neq~value`	`attributo` non è uguale a `valore`.
`attribute=~gt~value`	`attributo` è maggiore di `valore`.
`attribute=~gteq~value`	`attributo` è maggiore o uguale a `valore`.
`attribute=~lt~value`	`attributo` è minore di `valore`.
`attribute=~lteq~value`	`attributo` è minore o uguale a `valore`.
`attribute=~ew~value`	`attributo` termina con `valore`.
`attribute=~sw~value`	`attributo` inizia con `valore`.
`attribute=~like~value`	`attributo` è come `valore`.

ordinamento dei risultati

Per organizzare i dati della risposta in sequenza in base a specifici attributi, passare il parametro sort e gli attributi che si desidera ordinare nell' URL della richiesta:

sort({+ or -}attribute1,{+ or -}attribute2)

+ Ordina in ordine crescente
- Ordina in ordine decrescente

Il seguente esempio mostra una chiamata REST a getOrganizationList con la funzione di ordinamento passata come parametro:

GET /restapi/organization?sort(+OrganizationName,-Createts)

In alternativa, è possibile passare il parametro _sort nell' URL della richiesta se si desidera che i parametri della richiesta abbiano il formato attribute=value. Il seguente esempio mostra il formato di una richiesta di sequenza identica che utilizza il parametro _sort .

GET /restapi/organization?_sort=+OrganizationName,-Createts

Paginazione

La paginazione è controllata dall'intestazione HTTP Range. Ad esempio, specificando un'intestazione Range con il valore items=20-39 si ottengono gli elementi dalla ventesima alla trentanovesima voce della query.

In alternativa, è possibile passare il parametro _range nell' URL della richiesta. Utilizzare questa opzione se si verificano dei problemi con l'intestazione Range :

GET /restapi/organization?_range=20-39