Argomento precedente: Modello di Gestione

Argomento successivo: Documentazione dell'API dettagliata


Modello delle operazioni

Le operazioni che non rientrano nel modello di Gestione CRUD (Create Read Update Delete) vengono gestite mediante il modello delle operazioni. Le operazioni vanno dalla modifica dello stato di una risorsa all'esecuzione di un'operazione da parte di una risorsa, come ripristinare le password per l'alimentazione.

Il modello delle operazioni viene implementato mediante un POST a un URL che termina con operations/<operation name> con un payload facoltativo. Nell'esempio seguente, si avvia la griglia denominata govt_sales:

POST grids/govt_sales/operations/start

Nel linguaggio RESTful, il modello delle operazioni crea una nuova risorsa identificata dal nome dell'operazione.

Il modello delle operazioni può e spesso viene abbinato con i modelli di amministrazione e di Gestione. Le operazioni su una raccolta gestita seguono il modello di amministrazione. Comunque, le operazioni su un'istanza gestita seguono il modello di Gestione.

La tabella nella sezione seguente descrive (in modo generico) la struttura dell'URI, l'uso del metodo HTTP, la struttura di payload e di restituzione relativi alla modalità con cui un client di BFC interagisce con le applicazioni dell'API.

Esempio di destinazione

Operazioni come:

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

GET

Richiama l'operazione senza un payload. Le operazioni richiamate in questo modo non devono creare effetti collaterali.

Restituisci: i risultati dell'operazione.

POST

Come GET, ma può avere effetti collaterali.

Payload: variabile, definito dall'operazione.

Restituisci: i risultati dell'operazione.