<< Fare clic per visualizzazione il sommario >> Percorso: API di piattaforma > Servizi Core > Jamio Catalog > GetCatalog |
Restituisce il contenuto del catalogo specificato a partire dal suo collegamento. E' possibile opzionalmente applicare dei parametri di ricerca all'apertura del catalogo.
Metodo
JamioCatalog/GetCatalog
Input |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
serverAddress |
Indirizzo del server per domini esterni (o ' ' per il dominio corrente). |
String |
Y |
token |
Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto). |
String |
Y |
reference |
Collegamento del catalogo che si vuole ottenere. Sono supportati i cataloghi di risorse dei seguenti tipi: •Data |
Reference |
|
parameters |
Parametri di ricerca da applicare all'apertura del catalogo. Il valore di default di parameters prevede i valori pagesize 50 e pagenumber 1. |
Y |
|
Output |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
returnValue |
Dato strutturato che contiene i seguenti campi: •Name: di tipo stringa, riporta il nome del catalogo •TotalCount: di tipo intero, riporta il numero totale di righe del catalogo •ItemList: di tipo lista di CatalogItem.
|
Dataset |
|
Commenti
Ogni CatalogItem contiene le informazioni relative al Collegamento alla risorsa ed i campi aggiuntivi (Fields) corrispondenti alle colonne contenute nel catalogo. Il tipo CatalogItem può essere assegnato a variabili di processo di tipo Collegamento esteso. In particolare ha le seguenti proprietà:
•Name: nome della risorsa di cui è proiezione il catalogo;
•Type: type della risorsa di cui è proiezione il catalogo;
•URL: indirizzo della risorsa di cui è proiezione il catalogo;
•Fields: contiene le colonne del catalogo valorizzate con le informazioni della risorsa.
La lettura di un catalogo con il metodo GetCatalog restituisce sempre i primi 50 elementi del catalogo, se non è valorizzato il parametro parameters. E' possibile eseguire GetCatalog richiedendo nei parameters massimo 500 elementi.
Per ottenere il contenuto di un catalogo che riporta più di 500 elementi è necessario ripetere più volte la GetCatalog con un'attività multistanziata ciclando per numero totale di pagine o numero totale di record.
Autorizzazioni
Per eseguire il metodo è necessario possedere il permesso di Lettura sul catalogo.