GetCatalogByModel

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Servizi Core > Jamio Catalog >

GetCatalogByModel

Restituisce il contenuto del catalogo specificato a partire dal collegamento al suo modello. E' possibile opzionalmente applicare dei parametri di ricerca all'apertura del catalogo.

 

Metodo

JamioCatalog/GetCatalogByModel

 

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

tenantId

Identificativo dell'area Jamio openwork (o ' ' per l'area della sessione corrente).

String

Y

resourceType

Il tipo di risorsa di cui il catalogo è proiezione.

Types

 

modelReference

Collegamento al modello catalogo che si vuole ottenere. Sono supportati i cataloghi di risorse dei seguenti tipi:

Data

Identity

AccountCriteria

PasswordCriteria

Document

Aggregation

Organization

OrganizationalPosition

OrganizationalUnit

OrganizationalBlock

OrganizationalAssignment

HumanTask

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.

SearchParameters

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, riporta per ogni riga del catalogo il collegamento alla risorsa ed i campi aggiuntivi (Fields) corrispondenti alle colonne contenute nel catalogo.

 

Scarica il modello Jamio del dato strutturato restituito.

Dataset

 

 

Commenti

La lettura di un catalogo con il metodo GetCatalogByModel restituisce sempre i primi 50 elementi del catalogo, se non è valorizzato il parametro parameters. E' possibile eseguire GetCatalogByModel richiedendo nei parameters massimo 500 elementi.

Per ottenere il contenuto di un catalogo che riporta più di 500 elementi è necessario ripetere più volte la GetCatalogByModel 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.