PUT

Modifica integrale Risorsa

PUT: webapi_base_url/v1/production/{modulo}/{risorsa}/{id}

Parametri

• id: codice identificativo da leggere.
• body: l'oggetto di tipo {risorsa}DTO da aggiornare.
• force: il codice (o i codici separati da ,) di errore da ignorare durante l'esecuzione dell'operazione.

Codici risposta

• 200: l'oggetto è stato aggiornato correttamente.
• 400: l'oggetto non è stato aggiornato; il contenuto della response contiene i messaggi di validazione prodotti.
• 404: l'oggetto non è stato trovato.
• 409: l'oggetto non è stato aggiornato a causa di logiche di business non rispettate; il contenuto della response contiene i messaggi di validazione prodotti.

PATCH

Modifica parziale Risorsa

PATCH: webapi_base_url/v1/production/{modulo}/{risorsa}/{id}

Parametri

• id: codice identificativo della risorsa da leggere.
• force: il codice (o i codici separati da ,) di errore da ignorare nell'esecuzione dell'operazione.
• body: specifica un set di modifiche da applicare alla risorsa. Può essere più efficiente rispetto all'uso della PUT, perchè il client invia solo le modifiche e non l'intera rappresentazione della risorsa.

Body di esempio

{
  "title": "pippo",
  "accounts": [
    {
      "id": 1,
      "description": "account1"
    },
    {
      "id": 2,
      "patchInternalOp": "delete"
    },
    {
      "patchInternalOp": "add",
      "description": "account3"
    }
  ]
}

In questo esempio di body viene fatto uso dell'attributo patchInternalOp utilizzato per eliminare, (attraverso la chiave id) o aggiungere sottoelementi ad una risorsa. Ogni sottoelemento senza patchInternalOp viene ricercato all'interno della risorsa (attraverso sempre la chiave id). Se viene trovato, viene considerato da modificare, altrimenti da aggiungere.

Codici risposta

• 200: l'oggetto è stato aggiornato correttamente.
• 400: l'oggetto non è stato aggiornato; il contenuto della response contiene i messaggi di validazione prodotti.
• 404: l'oggetto non è stato trovato.
• 409: l'oggetto non è stato aggiornato a causa di logiche di business non rispettate; il contenuto della response contiene i messaggi di validazione prodotti.