Mettre à jour un qualificateur de collection

Dernière mise à jour : 2024-01-22
  • Créé pour :
  • Experienced
    Developer

Vous pouvez modifier ou mettre à jour un qualificateur de collection (auparavant appelé « balise ») dans votre conteneur en exécutant une requête PATCH sur l’API Offer Library.

Pour plus d'informations sur JSON Patch, notamment les opérations disponibles, consultez la documentation JSON Patch officielle.

En-têtes Accept et Content-Type

Le tableau suivant montre les valeurs valides qui comprennent les champs Content-Type et Accept dans l'en-tête de la requête :

Nom de l'en-tête Valeur
Accept application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1
Content-Type application/vnd.adobe.platform.xcore.patch.hal+json; version=1; schema="https://ns.adobe.com/experience/offer-management/tag;version=0.1"

Format d'API

PATCH /{ENDPOINT_PATH}/{CONTAINER_ID}/instances/{INSTANCE_ID}

Paramètre   Description   Exemple
{ENDPOINT_PATH}   Chemin d’accès du point d’entrée des API du référentiel. | https://platform.adobe.io/data/core/xcore/ |
| {CONTAINER_ID} | Conteneur où se trouvent les balises. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
| {INSTANCE_ID} | ID d’instance de la balise que vous souhaitez mettre à jour. | d48fd160-13dc-11eb-bc55-c11be7252432 |

Requête

curl -X PATCH \
  'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/d48fd160-13dc-11eb-bc55-c11be7252432' \
  -H 'Accept: application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1' \
  -H 'Content-Type: application/vnd.adobe.platform.xcore.patch.hal+json; version=1; schema="https://ns.adobe.com/experience/offer-management/tag;version=0.1"' \
  -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}'\
  -d '[
        {
          "op": "replace",
          "path": "/_instance/xdm:name",
          "value": "Sales and promotions for the holidays"
        }
    ]'
Paramètre Description
op Appel d’opération utilisé pour définir l’action nécessaire pour mettre à jour la connexion. Les opérations comprennent : add, replace, remove, copy et test.
path Chemin d’accès du paramètre à mettre à jour.
value Nouvelle valeur avec laquelle vous souhaitez mettre à jour votre paramètre.

Réponse

Une réponse réussie renvoie les détails mis à jour du qualificateur de collection, y compris son identifiant d’instance unique et son @id de qualificateur de collection.

{
    "instanceId": "d48fd160-13dc-11eb-bc55-c11be7252432",
    "@id": "xcore:tag:124e147572cd7866",
    "repo:etag": 2,
    "repo:createdDate": "2020-10-21T20:34:34.486296Z",
    "repo:lastModifiedDate": "2020-10-21T20:36:31.782607Z",
    "repo:createdBy": "{CREATED_BY}",
    "repo:lastModifiedBy": "{MODIFIED_BY}",
    "repo:createdByClientId": "{CREATED_CLIENT_ID}",
    "repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}

Sur cette page