Vai al contenuto

Espansione degli oggetti correlati

Molte entità dell'Amica Cloud API fanno riferimento ad altre entità: un articolo, per esempio, può riferirsi alla sua categoria merceologica, al fornitore e così via. Per impostazione predefinita questi oggetti correlati vengono restituiti come riferimenti (in genere un identificativo), non con il loro contenuto completo.

Il parametro Expand

Gli endpoint singoli e lista supportano il parametro Expand. Quando lo fornisci, gli oggetti correlati indicati vengono inclusi inline nella risposta anziché restituiti come semplici riferimenti. Puoi così ricostruire un'entità completa senza chiamate aggiuntive.

Puoi specificare più espansioni separandole con una virgola:

GET /api/v3/1/articolo/1?Expand=CategoriaMerceologica,Produttore

In questo esempio la risposta include, all'interno dell'articolo, gli oggetti completi categoriaMerceologica e produttore invece dei soli riferimenti.

Tip

Espandi solo gli oggetti che ti servono davvero: ogni espansione aumenta la dimensione della risposta. La API Reference indica, per ciascun endpoint, quali espansioni sono disponibili.