Atualizar usando a notação JSON Patch

O exemplo de chamada a seguir demonstra como atualizar um objeto usando o JSON Patch, conforme descrito em RFC-6902.

Para obter mais informações sobre a sintaxe do patch de JSON, consulte o guia de fundamentos de API.

Formato da API

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
ParâmetroDescrição
{OBJECT_TYPE}

O tipo de objeto Catalog a ser atualizado. Os objetos válidos são:

  • batches
  • dataSets
  • dataSetFiles
{OBJECT_ID}O identificador do objeto específico que você deseja atualizar.

Solicitação

A solicitação a seguir atualiza os campos name e description de um conjunto de dados para os valores fornecidos em cada objeto de patch JSON. Ao usar o patch de JSON, você também deve definir o cabeçalho Content-Type como 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" }
      ]'

Resposta

Uma resposta bem-sucedida retorna uma matriz que contém a ID do objeto atualizado. Essa ID deve corresponder à enviada na solicitação PATCH. A execução de uma solicitação GET para este objeto agora mostra que apenas name e description foram atualizados, enquanto todos os outros valores permanecem inalterados.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]
recommendation-more-help