Vous pouvez modifier ou mettre à jour un emplacement dans votre conteneur 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.
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-placement;version=0.4" |
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 emplacements. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{INSTANCE_ID} |
ID d’instance de l’emplacement que vous souhaitez mettre à jour. | 9aa58fd0-13d7-11eb-928b-576735ea4db8 |
Requête
curl -X PATCH \
'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/9aa58fd0-13d7-11eb-928b-576735ea4db8' \
-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-placement;version=0.4"' \
-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 Placement"
},
{
"op": "replace",
"path": "/_instance/xdm:description",
"value": "A test placement to contain offers of sales and discounts"
}
]'
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 l’emplacement, y compris son identifiant d’instance unique et l’@id
d’emplacement.
{
"instanceId": "9aa58fd0-13d7-11eb-928b-576735ea4db8",
"@id": "xcore:offer-placement:124e0be5699743d3",
"repo:etag": 2,
"repo:createdDate": "2020-10-21T19:57:09.837456Z",
"repo:lastModifiedDate": "2020-10-21T19:59:10.700149Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}