Uppdatera ett katalogobjekt

Du kan uppdatera en del av en Catalog genom att inkludera dess ID i sökvägen för en PATCH-begäran. Det här dokumentet innehåller två metoder för att utföra PATCH-åtgärder på katalogobjekt:

  • Använda fält
  • Använda JSON Patch-notation
OBSERVERA

PATCH-åtgärder för ett objekt kan inte ändra dess utökningsbara fält, som representerar relaterade objekt. Ändringar av sammanhörande objekt måste göras direkt.

Uppdatera med fält

I följande exempelanrop visas hur du uppdaterar ett objekt med hjälp av fält och värden.

API-format

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
Parameter Beskrivning
{OBJECT_TYPE} Typ av Catalog objekt som ska uppdateras. Giltiga objekt är:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID} Identifieraren för det specifika objekt som du vill uppdatera.

Begäran

Följande begäran uppdaterar name och description fält i en datauppsättning till de värden som anges i nyttolasten. Objektfält som inte ska uppdateras kan uteslutas från nyttolasten.

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"
      }'

Svar

Ett lyckat svar returnerar en array som innehåller ID:t för den uppdaterade datauppsättningen. Detta ID ska matcha det som skickades i PATCH-begäran. När en GET-förfrågan utförs för den här datauppsättningen visas nu att endast name och description har uppdaterats medan alla andra värden förblir oförändrade.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

Uppdatera med JSON Patch-notation

Följande exempelanrop visar hur du uppdaterar ett objekt med JSON Patch, enligt instruktionerna i RFC-6902.

API-format

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
Parameter Beskrivning
{OBJECT_TYPE} Typ av Catalog objekt som ska uppdateras. Giltiga objekt är:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID} Identifieraren för det specifika objekt som du vill uppdatera.

Begäran

Följande begäran uppdaterar name och description fält i en datauppsättning med de värden som anges i varje JSON-lagningsobjekt. När du använder JSON Patch måste du även ange Content-Type-rubriken till 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" }
      ]'

Svar

Ett lyckat svar returnerar en array som innehåller ID:t för det uppdaterade objektet. Detta ID ska matcha det som skickades i PATCH-begäran. En GET-förfrågan för det här objektet visar nu att endast name och description har uppdaterats medan alla andra värden förblir oförändrade.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

På denna sida