Composizione dei filtri per le Query

Abstract

Il documento riassume gli operatori e le opzioni per i filtri delle query disponibili per i metodi API. I metodi Get Items e Get Attachments List impiegano questi operatori.

Il documento Composizione Filtri Query elenca e spiega ciascun operatore e opzione di filtraggio disponibile quando si compone il body di un richiesta per i metodi API Get Items e Get Attachments List

Operatori di Comparazione ODATA Supportati¶

L'API Get Items API supporta la seguente lista di operatori di comparazione ODATA:

Operatore	Operazione	Esempio
`eq`	Uguale	`$filter=userEmail eq 'j.doe@vesenda.com'`
`ne`	Non uguale a	`$filter=SaleOrderCategoryNumber ne 11`
`gt`	Maggiore di	`$filter=budget gt 300`
`lt`	Meno di	`$filter=budget lt 300`
`ge`	Maggiore o uguale a	`$filter=budget ge 300`
`le`	Minore o uguale a	`$filter=budget le 300`

Note

Scrivere i valori di tipo stringa (String) per gli operatori di comparazione ODATA fra apostrofi (''). Inserire i caratteri speciali nei valori di tipo stringa (String) nella query tramite il formato URL Encode. (E.g. D'Alessandro D%27Alessandro.)

Puoi usare i valori null per le comparazioni di valori. E.g. ?$filter=Name eq null. La query cerca i valori di Name che sono null.

Funzioni ODATA Supportate¶

L'API Get Items API supporta la seguente lista di funzioni ODATA:

Funzione	Significato	Esempio
`substringof`	Cerca i caratteri alfanumerici specificati all'interno di un testo (cioè un valore di tipo String). Accetta due valori in ordine: il nome del campo come primo parametro e il valore della stringa da cercare come secondo parametro.	`$filter=substringof(Code, '77aQ')`
`startswith`	Restituisce tutti i valori di tipo String che iniziano con l'insieme di caratteri alfanumerici specificato. Accetta due valori in ordine: il nome del campo come primo parametro e un valore di stringa da cercare come secondo parametro.	`$filter=startswith(Code, 'AA27')`
`endswith`	Restituisce tutti i valori di tipo String che terminano con l'insieme di caratteri alfanumerici specificato. Accetta due valori in ordine: il nome del campo come primo parametro e un valore di stringa da cercare come secondo parametro.	`$filter=endswith(Code, 'RM005')`
`multi`	Restituisce tutte le voci che hanno determinati valori memorizzati in un campo Multiselection. Accetta almeno tre parametri e si possono specificare tutti i valori desiderati dopo i parametri richiesti. La funzione richiede i seguenti parametri: il nome del campo come primo parametro; 0 (la Multiselezione della voce contiene ALMENO UNO dei valori) o 1 (la Multiselezione della voce deve contenere TUTTI i valori specificati); l'Id dell'opzione da cercare nel campo Multiselezione (e si possono aggiungere altri divisi da una virgola).	`$filter=multi(tags, 0, 11, 12, 13)`

Filtri Combinatori ODATA Supportati¶

L'API Get Items API supporta la seguente lista di filtri combinatori ODATA:

Operatore Logico	Esempio
`and`	`$filter=Name eq 'Joe' and Surname eq 'Doe'`
`or`	`$filter=Name eq 'Joe' or Surname eq 'Doe'`
`not`	`$filter=Surname not 'Black'`

ODATA Operatori Paginazione e Ordinamento¶

Utilizza i seguenti operatori per fornire criteri per organizzare l'elenco dei risultati:

Opzione	Significato	Esempio
`$top`	La query restituisce solo il primo n numero di voci (ad esempio, le prime 200).	`$top=200`
`$skip`	La query ignora il primo n numero di voci risultanti dalla ricerca. (Ad esempio, la query ignora le prime 50 voci, poi inizia a restituire il resto dei risultati.)	`$skip=50`
`$orderby`	La query ordina l'elenco dei risultati in base al campo specificato e all'opzione di ordinamento specificata: Ascendente (`asc`) o Discendente (`desc`). Dividere ciascun attributo tramite una virgola.	`$orderby=Name desc, Age asc`