RemoveFieldsById

<< Fare clic per visualizzazione il sommario >>

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

RemoveFieldsById

Elimina campi da un indice, individuando il dataset da aggiornare nell'indice del plug ElasticStorage tramite il campo identificativo o i campi utilizzati per calcolare l'identificativo.

 

Metodo

PlugElasticStorage/RemoveFieldsById

 

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

 

fieldsToRemove

Lista dei nomi dei campi da eliminare nel Dataset di un indice della configurazione del Plug Elastic Storage.

Se il parametro contiene campi non presenti nel Dataset, questi vengono ignorati.

List of string

 

idFields

Dato strutturato riportante i nomi dei campi con cui calcolare l'identificativo del Dataset, in cui eliminare uno o più campi, e il loro valore.

Può contenere anche solo il campo denominato "_id" o "Id", se presente, e il suo rispettivo valore.

DataSet

 

 

Commenti

Se il parametro fieldsToRemove viene valorizzato con un collegamento, il metodo ne elimina l'intera struttura, mentre non è possibile eliminarne le singole proprietà (Name, Type e Url).

 

Il metodo si comporta come segue:

 

Restituisce

Condizione

Errore

Se fieldsToRemove contiene un campo che si chiama "_id" o un campo che si chiama "Id"

Errore

Se i campi di idFields sono diversi da testo breve e numerico intero.

Errore

Se il Dataset da aggiornare non è presente nell'indice.

Errore

Se il campo indice generato con la concatenazione dei campi della lista di idFields supera il limite di 150 caratteri.

 

Le eccezioni restituiscono un errore nella forma Code e Message, il Codice è Plug_{Code}.

 

Il Dataset viene sostituito con un Dataset senza i campi specificati in input: i campi esistenti e non selezionati col parametro FieldsToRemove non vengono alterati.

 

Autorizzazioni

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