GetDatasetCatalog

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug Elastic Storage >

GetDatasetCatalog

Restituisce una lista di Dataset selezionati in un indice del Plug Elastic Storage, secondo i parametri di ricerca forniti.

 

Metodo

PlugElasticStorage/GetDatasetCatalog

 

Input

Nome

Descrizione

Tipo

Opzionale

token

Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

configurationReference

Collegamento alla risorsa di tipo configurazione del Plug Elastic Storage da utilizzare.

E' possibile specificare un collegamento con valorizzata solo la proprietà Name pari al Nickname di una configurazione esistente.

Reference

 

parameters

Parametri di ricerca da applicare sui dati dell'indice del Plug Elastic Storage. Se non specificato viene restituito tutto il contenuto.

SearchParameters

Y

includeFields

Lista dei nomi dei campi dell'indice da includere nel risultato:

se non indicato, vengono inseriti tutti quelli presenti nell'indice tranne il campo dell'identificativo;

se viene indicata una lista, nei Dataset sono inseriti esattamente i campi indicati, anche se non presenti nel Dataset dell'indice (in questo caso assumono valore Null);

se si include un campo di nome "_id", questo viene valorizzato con l'identificativo del Dataset.

List of String

 

Output

Nome

Descrizione

Tipo

Opzionale

returnValue

Dato strutturato che contiene i seguenti campi:

Name: campo di tipo stringa che riporta il nome della configurazione

TotalCount: campo di tipo intero che riporta il numero totale di elementi secondo i parametri passati

ItemList: campo di tipo lista di CatalogItem, che riporta per ogni riga i Dataset ottenuti dalla ricerca.

 

Scarica il modello Jamio del dato strutturato restituito.

Dataset

 

 

Commenti

Il metodo restituisce per ogni elemento dell'ItemList tutti i campi previsti dalla struttura dell'indice, riportando valore null per quelli non presenti o quelli di default per i tipi booleano e numerico (rispettivamente false e 0)

Ad esempio, qualora un dataset dell'indice non contenga il "Campo1" presente nella struttura, verrà restituito un CatalogItem contenente "Campo1" con valore null.

 

La lettura di una lista di Dataset con il metodo GetDatasetCatalog restituisce sempre i primi 50 elementi, se non è valorizzato il parametro parameters. E' possibile eseguire GetDatasetCatalog richiedendo nei parameters massimo 500 elementi.

Per ottenere una lista di Dataset che riporta più di 500 elementi è necessario ripetere più volte la GetDatasetCatalog con un'attività multistanziata ciclando per numero totale di pagine o numero totale di record.

 

Il metodo si comporta come segue:

 

Restituisce

Condizione

Errore

Se includeFields riporta il nome di un campo non presente nell'indice.

Errore

Se includeFields riporta il nome di un campo dell'indice non al primo livello.

 

 

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di Utilizzo sull'indice del Plug Elastic Storage.