Documentazione Experience Platform Guida al catalogo e ai set di dati

Aggiornare un oggetto Catalog

Last update: Wed Dec 06 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Argomenti:
Catalog

Creato per:

Developer

È possibile aggiornare parte di un Catalog includendo il relativo ID nel percorso di una richiesta PATCH. Questo documento descrive i due metodi per eseguire operazioni PATCH sugli oggetti Catalog:

Utilizzo dei campi
Utilizzo della notazione patch JSON

NOTE

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

Aggiorna utilizzando i campi

La chiamata di esempio seguente 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:

batches
dataSets
dataSetFiles

{OBJECT_ID}

Identificatore dell’oggetto specifico da aggiornare.

Richiesta

La richiesta seguente aggiorna il name e description campi di un set di dati 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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
       "name":"Updated Dataset Name",
       "description":"Updated description for Sample Dataset"
      }'

Risposta

In caso di esito positivo, la risposta 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 set di dati ora mostra che solo il name e description sono stati aggiornati, mentre tutti gli altri valori rimangono invariati.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

Aggiorna utilizzando la notazione patch JSON

La chiamata di esempio seguente illustra come aggiornare un oggetto utilizzando Patch JSON, come descritto in RFC-6902.

Per ulteriori informazioni sulla sintassi delle patch JSON, vedi Guida di base sulle API.

Formato API

PATCH /{OBJECT_TYPE}/{OBJECT_ID}

Parametro

Descrizione

{OBJECT_TYPE}

Il tipo di Catalog oggetto da aggiornare. Gli oggetti validi sono:

batches
dataSets
dataSetFiles

{OBJECT_ID}

Identificatore dell’oggetto specifico da aggiornare.

Richiesta

La richiesta seguente aggiorna il name e description campi 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: {ORG_ID}' \
  -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

In caso di esito positivo, la risposta restituisce un array contenente l’ID dell’oggetto aggiornato. Questo ID deve corrispondere a quello inviato nella richiesta PATCH. Quando si esegue una richiesta di GET per questo oggetto, ora viene mostrato che solo name e description sono stati aggiornati, mentre tutti gli altri valori rimangono invariati.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

recommendation-more-help

c5c02be6-79a3-4a2f-b766-136bffe8b676