DeleteById

<< Fare clic per visualizzazione il sommario >>

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

DeleteById

Elimina un Dataset di un indice del plug Elastic Storage individuato tramite il suo identificativo o i campi utilizzati per calcolarlo.

 

Metodo

PlugElasticStorage/DeleteById

 

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

 

idFields

Dato strutturato contenente i nomi dei campi che servono a costruire l’identificativo del Dataset dell'indice da individuare, con il loro valore.

I nomi devono riferirsi a campi di primo livello, non annidati.

La composizione dell'identificativo segue l'ordine con cui sono stati definiti i campi del dato strutturato.

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

Dataset

 

Output

Nome

Descrizione

Tipo

Opzionale

returnValue

Valore booleano che assume il valore true se il Dataset esiste ed è stato cancellato, false se il Dataset da eliminare non viene trovato.

Boolean

 

 

Commenti

Il metodo si comporta come segue:

Restituisce

Condizione

Errore

Se i campi di idFields sono diversi da testo breve e numerico intero, o si riferiscono a campi non di primo livello.

Errore

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

 

Autorizzazioni

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