Show Menu
SUJETS×

Mettre à jour un objet

Vous pouvez mettre à jour une partie d’un objet Catalog en incluant son ID dans le chemin d’une requête PATCH. Ce document couvre les deux méthodes d’exécution des opérations PATCH sur les objets de catalogue :
  • Utilisation des champs
  • Utilisation de la notation de correctif JSON
Les opérations PATCH sur un objet ne peuvent pas modifier ses champs extensibles, qui représentent des objets interconnectés. Les modifications apportées aux objets interconnectés doivent être effectuées directement.

Mise à jour à l’aide de champs

L’exemple d’appel suivant montre comment mettre à jour un objet à l’aide de champs et de valeurs.
Format d’API
PATCH /{OBJECT_TYPE}/{OBJECT_ID}

Paramètre
Description
{OBJECT_TYPE}
Type d’objet Catalog à mettre à jour. Les objets valides sont :
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID}
Identifiant de l’objet spécifique à mettre à jour.
Requête
La requête suivante met à jour les name champs et description champs d’un jeu de données avec les valeurs fournies dans la charge utile. Les champs d’objet qui ne doivent pas être mis à jour peuvent être exclus de la charge utile.
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"
      }'

Réponse
Une réponse réussie renvoie un tableau contenant l'identifiant du jeu de données mis à jour. Cet identifiant doit correspondre à celui envoyé dans la demande PATCH. L’exécution d’une requête GET pour ce jeu de données montre désormais que seules les valeurs name et description ont été mises à jour, tandis que toutes les autres valeurs restent inchangées.
[
    "@/dataSets/5ba9452f7de80400007fc52a"
]

Mise à jour à l’aide de la notation de correctif JSON

L’exemple d’appel suivant montre comment mettre à jour un objet à l’aide du correctif JSON, comme indiqué dans la section RFC-6902 .
Format d’API
PATCH /{OBJECT_TYPE}/{OBJECT_ID}

Paramètre
Description
{OBJECT_TYPE}
Type d’objet Catalog à mettre à jour. Les objets valides sont :
  • accounts
  • batches
  • connections
  • dataSets
  • dataSetFiles
  • dataSetViews
{OBJECT_ID}
Identifiant de l’objet spécifique à mettre à jour.
Requête
La requête suivante met à jour les name champs et description champs d’un jeu de données avec les valeurs fournies dans chaque objet de correctif JSON. Lors de l’utilisation du correctif JSON, vous devez également définir l’en-tête Content-Type sur 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" }
      ]'

Réponse
Une réponse réussie renvoie un tableau contenant l'identifiant de l'objet mis à jour. Cet identifiant doit correspondre à celui envoyé dans la demande PATCH. L’exécution d’une requête GET pour cet objet indique désormais que seules les valeurs name et description ont été mises à jour alors que toutes les autres valeurs restent inchangées.
[
    "@/dataSets/5ba9452f7de80400007fc52a"
]