Aggiornare un oggetto Catalog

È possibile aggiornare parte di un oggetto Catalog includendo il relativo ID nel percorso di una richiesta PATCH. In questo documento vengono descritti i due metodi utilizzati per eseguire operazioni PATCH sugli oggetti Catalog:

  • Uso dei campi
  • Utilizzo della notazione patch JSON
NOTA

Le operazioni di PATCH su un oggetto non possono modificare i campi espandibili che rappresentano oggetti correlati. Le modifiche apportate agli oggetti correlati devono essere effettuate direttamente.

Aggiornamento utilizzando i campi

L'esempio di chiamata seguente illustra come aggiornare un oggetto utilizzando campi e valori.

Formato API

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
Parametro Descrizione
{OBJECT_TYPE} Il tipo di oggetto Catalog da aggiornare. Gli oggetti validi sono:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID} Identificatore dell'oggetto specifico che si desidera aggiornare.

Richiesta

La richiesta seguente aggiorna i campi name e description di un set di dati ai valori forniti nel payload. I campi oggetto da non aggiornare 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 di PATCH. L’esecuzione di una richiesta di GET per questo set di dati ora mostra che solo i valori name e description sono stati aggiornati, mentre tutti gli altri valori rimangono invariati.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

Aggiornamento tramite la notazione patch JSON

L'esempio di chiamata seguente 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 oggetto Catalog da aggiornare. Gli oggetti validi sono:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID} Identificatore dell'oggetto specifico che si desidera aggiornare.

Richiesta

La richiesta seguente aggiorna i campi name e description di un set di dati ai valori forniti in ciascun oggetto Patch JSON. Quando utilizzi la patch JSON, devi 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 di PATCH. L'esecuzione di una richiesta di GET per questo oggetto ora mostra che solo i valori name e description sono stati aggiornati, mentre tutti gli altri valori rimangono invariati.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

In questa pagina

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now