Documentation Journey Optimizer Guide de Journey Optimizer

Mettre à jour une collection

Dernière mise à jour : 5 avril 2024

Créé pour :

Expérimenté
Développeur

Vous pouvez modifier ou mettre à jour une collection en adressant une requête PATCH à 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/offer-filter;version=0.1"`

Format d'API

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

Paramètre	Description	Exemple
`{ENDPOINT_PATH}`	Chemin d’accès de point d’entrée pour les API de référentiel.	`https://platform.adobe.io/data/core/xcore/`
`{CONTAINER_ID}`	Conteneur où se trouvent les collections.	`e0bd8463-0913-4ca1-bd84-6309134ca1f6`
`{INSTANCE_ID}`	ID d’instance de la collection que vous souhaitez mettre à jour.	`0bf31c20-13f1-11eb-a752-e58fd7dc4cb3`

Requête

curl -X PATCH \
  'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/0bf31c20-13f1-11eb-a752-e58fd7dc4cb3' \
  -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/offer-filter;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": "add",
            "path": "/_instance/xdm:filterType",
            "value": "anyTags"
    },
    {
            "op": "add",
            "path": "/_instance/xdm:ids",
            "value": ["xcore:tag:124e147572cd7866"]
    }
]'

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` et `remove`.
`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 de la collection, y compris son identifiant d’instance unique et l’@id d’activité.

{
    "instanceId": "0bf31c20-13f1-11eb-a752-e58fd7dc4cb3",
    "@id": "xcore:offer-filter:124e3594ce8b4930",
    "repo:etag": 1,
    "repo:createdDate": "2023-10-21T22:59:17.345797Z",
    "repo:lastModifiedDate": "2023-10-21T22:59:17.345797Z",
    "repo:createdBy": "{CREATED_BY}",
    "repo:lastModifiedBy": "{MODIFIED_BY}",
    "repo:createdByClientId": "{CREATED_CLIENT_ID}",
    "repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}

recommendation-more-help