Puede modificar o actualizar una colección realizando una solicitud de PATCH al Offer Library API
Para obtener más información sobre JSON Patch, incluidas las operaciones disponibles, consulte la Documentación de parches JSON.
La tabla siguiente muestra los valores válidos que comprenden el Content-Type y Accept campos en el encabezado de la solicitud:
Nombre del encabezado | Valor |
---|---|
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" |
Formato de API
PATCH /{ENDPOINT_PATH}/{CONTAINER_ID}/instances/{INSTANCE_ID}
Parámetro | Descripción | Ejemplo |
---|---|---|
{ENDPOINT_PATH} |
Ruta de extremo para las API del repositorio. | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
Contenedor donde se encuentran las colecciones. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{INSTANCE_ID} |
ID de instancia de la colección que desea actualizar. | 0bf31c20-13f1-11eb-a752-e58fd7dc4cb3 |
Solicitud
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"]
}
]'
Parámetro | Descripción |
---|---|
op |
La llamada de operación utilizada para definir la acción necesaria para actualizar la conexión. Las operaciones incluyen: add , replace y remove . |
path |
Ruta del parámetro que se va a actualizar. |
value |
El nuevo valor con el que desea actualizar el parámetro. |
Respuesta
Una respuesta correcta devuelve los detalles actualizados de la colección, incluido su ID de instancia único y su colección @id
.
{
"instanceId": "0bf31c20-13f1-11eb-a752-e58fd7dc4cb3",
"@id": "xcore:offer-filter:124e3594ce8b4930",
"repo:etag": 1,
"repo:createdDate": "2020-10-21T22:59:17.345797Z",
"repo:lastModifiedDate": "2020-10-21T22:59:17.345797Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}