Actualizar un objeto Catalog

Última actualización: 2023-12-06
  • Temas:
  • Catalog
    Ver más sobre este tema
  • Creado para:
  • Developer
    User
    Admin
    Leader

Puede actualizar parte de un Catalog incluyendo su ID en la ruta de una petición de PATCH. Este documento describe los dos métodos para realizar operaciones de PATCH en objetos Catalog:

  • Uso de campos
  • Uso de la notación de parches JSON
NOTA

Las operaciones del PATCH en un objeto no pueden modificar sus campos expandibles, que representan objetos interrelacionados. Las modificaciones en objetos interrelacionados deben realizarse directamente.

Actualizar mediante campos

La siguiente llamada de ejemplo muestra cómo actualizar un objeto mediante campos y valores.

Formato de API

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
Parámetro Descripción
{OBJECT_TYPE} El tipo de Catalog objeto que se va a actualizar. Los objetos válidos son:
  • batches
  • dataSets
  • dataSetFiles
{OBJECT_ID} El identificador del objeto específico que desea actualizar.

Solicitud

La siguiente solicitud actualiza el name y description de un conjunto de datos a los valores proporcionados en la carga útil. Los campos de objeto que no se vayan a actualizar se pueden excluir de la 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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
       "name":"Updated Dataset Name",
       "description":"Updated description for Sample Dataset"
      }'

Respuesta

Una respuesta correcta devuelve una matriz que contiene el ID del conjunto de datos actualizado. Este ID debe coincidir con el enviado en la solicitud del PATCH. Al realizar una solicitud de GET para este conjunto de datos, ahora se muestra que solo la variable name y description se han actualizado mientras que el resto de valores permanecen sin cambios.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

Actualización mediante la notación de parches de JSON

La siguiente llamada de ejemplo muestra cómo actualizar un objeto mediante el parche JSON, como se describe en RFC-6902.

Para obtener más información sobre la sintaxis de parches de JSON, consulte la Guía de aspectos básicos de API.

Formato de API

PATCH /{OBJECT_TYPE}/{OBJECT_ID}
Parámetro Descripción
{OBJECT_TYPE} El tipo de Catalog objeto que se va a actualizar. Los objetos válidos son:
  • batches
  • dataSets
  • dataSetFiles
{OBJECT_ID} El identificador del objeto específico que desea actualizar.

Solicitud

La siguiente solicitud actualiza el name y description de un conjunto de datos a los valores proporcionados en cada objeto de parche JSON. Al utilizar el parche JSON, también debe establecer el encabezado Content-Type en 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" }
      ]'

Respuesta

Una respuesta correcta devuelve una matriz que contiene el ID del objeto actualizado. Este ID debe coincidir con el enviado en la solicitud del PATCH. Al realizar una solicitud de GET para este objeto, ahora se muestra que solo la variable name y description se han actualizado mientras que el resto de valores permanecen sin cambios.

[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

En esta página