Guide di integrazione › Guida di riferimento dell'API di Backbone Fabric Controller (BFC) › Costruzione dell'URL › Modello di amministrazione

Modello di amministrazione

I tipi all'interno dell'API di BFC possono avere un'interfaccia di amministrazione facoltativa per impostare i dati di configurazione. Il modello dell'URL è admin/<resource_type>s (ad esempio, admin/grids).

Questo modello dell'URL viene utilizzato quando la configurazione si applica a tutte le istanze del tipo specificato. È possibile applicare anche il modello di amministrazione a un'istanza di risorsa laddove sia necessaria una configurazione più dettagliata, ad esempio una griglia specifica. L'ambito viene realizzato aggiungendo l'ID della risorsa designata all'URL:

admin/<resource_type>/<resource_id>

Ad esempio:

admin/grids/mygrid

È possibile utilizzare un GET per restituire un record quando l'insieme dei dati di configurazione è fisso.

Quando una destinazione di amministrazione ha molti valori di configurazione, viene supportato un elenco dinamico di valori di configurazione mediante la stringa di query. In questo modo il client dispone di una flessibilità estrema nel decidere quali pezzi di dati ricavare dal server. Quanto segue è un esempio di URL:

admin/grids?keys=backboneid,licensekey 

Per impostare i valori di configurazione, si utilizza un PUT.

Inoltre, le interfacce di amministrazione consentono di impostare valori di configurazione specifici utilizzando PUT per l'URL con la chiave inclusa (ad esempio, admin/grids/backboneControllerId o /admin/discovery) e un payload per il valore o i valori aggiornati.

Per cancellare un valore di configurazione, utilizzare un PUT e il valore null nel record corrispondente. Facoltativamente, è possibile utilizzare un DELETE con la chiave nell'URL (ad esempio, admin/grids/licensekey o admin/backboneId).

Destinazione di esempio 1

BFC/admin/<resource_type>s,
BFC/admin/<resource_type>/<resource_id>

GET

Recuperare la configurazione pertinente a resource_type o alla risorsa.

Restituisci: record di configurazione.

PUT

Sostituire la configurazione.

Payload: record sparse che contiene i campi da impostare.

Restituisci: ok.

Risultato: i valori nel record sparse sono aggiornati.

Destinazione di esempio 2

BFC/admin/<resource_type>s/<parameter>,
BFC/admin/<resource_type>/<resource_id>/<parameter> 

GET

Recuperare il valore di configurazione per il parametro denominato.

Strina di query: N/D.

Restituisci: valore di configurazione.

PUT

Sostituire il valore di configurazione.

Payload: nuovo valore di configurazione.

Restituisci: ok.

Risultato: il valore per il parametro di configurazione specificato è aggiornato.

DELETE

Elimina: il valore per il parametro di configurazione specificato.

Payload: N/D.

Restituisci: ok.

Risultato: il valore per il parametro di configurazione specificato non è impostato.