Atualizar um objeto de catálogo

Você pode atualizar parte de um objeto Catalog ao incluir sua ID no caminho de uma solicitação PATCH. Este documento aborda os dois métodos para executar operações de PATCH em objetos do catálogo:

  • Uso de campos
  • Uso da notação de patch JSON
OBSERVAÇÃO

As operações de PATCH em um objeto não podem modificar seus campos expansíveis, que representam objetos inter-relacionados. As modificações em objetos interrelacionados devem ser feitas diretamente.

Atualizar usando campos

A chamada de exemplo a seguir demonstra como atualizar um objeto usando campos e valores.

Formato da API

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
Parâmetro Descrição
{OBJECT_TYPE} O tipo de objeto Catalog a ser atualizado. Os objetos válidos são:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{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 no payload. Os campos de objeto que não devem ser atualizados podem ser excluídos da carga útil.

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

Resposta

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

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

Atualizar usando a notação de patch JSON

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

Formato da API

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
Parâmetro Descrição
{OBJECT_TYPE} O tipo de objeto Catalog a ser atualizado. Os objetos válidos são:
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{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 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: {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" }
      ]'

Resposta

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

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

Nesta página