Show Menu
ARGOMENTI×

Aggiornare un oggetto

È possibile aggiornare parte di un Catalog oggetto inserendone l'ID nel percorso di una richiesta di PATCH. Questo documento descrive i due metodi per eseguire le operazioni PATCH sugli oggetti Catalog:
  • Uso dei campi
  • Utilizzo della notazione patch JSON
Le operazioni PATCH su un oggetto non possono modificare i campi espandibili che rappresentano oggetti correlati. Le modifiche agli oggetti correlati devono essere apportate direttamente.

Aggiornamento utilizzando i campi

La seguente chiamata di esempio illustra come aggiornare un oggetto utilizzando campi e valori.
Formato API
PATCH /{OBJECT_TYPE}/{OBJECT_ID}

Parametro
Descrizione
{OBJECT_TYPE}
Il tipo di Catalog oggetto da aggiornare. Gli oggetti validi sono:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID}
Identificatore dell'oggetto specifico da aggiornare.
Richiesta
La seguente richiesta aggiorna i campi name e description i campi di un dataset ai valori forniti nel payload. I campi oggetto che non devono essere aggiornati possono essere esclusi dal payload.
curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
       "name":"Updated Dataset Name",
       "description":"Updated description for Sample Dataset"
      }'

Risposta
Una risposta corretta restituisce un array contenente l'ID del set di dati aggiornato. Questo ID deve corrispondere a quello inviato nella richiesta PATCH. L'esecuzione di una richiesta di GET per questo dataset ora mostra che solo l'oggetto name e description sono stati aggiornati, mentre tutti gli altri valori rimangono invariati.
[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

Aggiornamento tramite la notazione patch JSON

La seguente chiamata di esempio illustra come aggiornare un oggetto utilizzando la patch JSON, come descritto in RFC-6902 .
Formato API
PATCH /{OBJECT_TYPE}/{OBJECT_ID}

Parametro
Descrizione
{OBJECT_TYPE}
Il tipo di Catalog oggetto da aggiornare. Gli oggetti validi sono:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID}
Identificatore dell'oggetto specifico da aggiornare.
Richiesta
La seguente richiesta aggiorna i campi name e description di un dataset ai valori forniti in ciascun oggetto Patch JSON. Quando utilizzate la patch JSON, dovete anche impostare l'intestazione Content-Type su application/json-patch+json .
curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5ba9452f7de80400007fc52a \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
        { "op": "add", "path": "/name", "value": "New Dataset Name" },
        { "op": "add", "path": "/description", "value": "New description for dataset" }
      ]'

Risposta
Una risposta corretta restituisce un array contenente l'ID dell'oggetto aggiornato. Questo ID deve corrispondere a quello inviato nella richiesta PATCH. L'esecuzione di una richiesta di GET per questo oggetto ora mostra che solo l'oggetto name e description sono stati aggiornati, mentre tutti gli altri valori rimangono invariati.
[
    "@/dataSets/5ba9452f7de80400007fc52a"
]