GetPlugConfigurationAdministrationCatalog

<< Fare clic per visualizzazione il sommario >>

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

GetPlugConfigurationAdministrationCatalog

Restituisce il catalogo amministrativo di tutte le risorse di tipo configurazione di plug.

 

Metodo

JamioService/GetPlugConfigurationAdministrationCatalog

 

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 di cui si vuole ottenere il catalogo amministrativo delle configurazioni.

String

Y

searchParameters

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 delle configurazioni. Esse corrispondono alle proprietà della configurazione:

oName

oDescription

oPlugName

oServiceName

oNickname

oIcon

 

Scarica il modello Jamio del dato strutturato restituito.

Dataset

 

 

Commenti

La lettura di un catalogo con il metodo GetPlugConfigurationAdministrationCatalog restituisce sempre i primi 50 elementi del catalogo, se non è valorizzato il parametro searchParameters. E' possibile eseguire GetPlugConfigurationAdministrationCatalog richiedendo nei searchParameters massimo 500 elementi. Per ottenere il contenuto di un catalogo che riporta più di 500 elementi è necessario ripetere più volte la GetPlugConfigurationAdministrationCatalog 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 browseRepository sul repository di Service. Il permesso è assegnato di default a tutti gli utenti dell'area, tale impostazione non è modificabile.