Puede modificar o actualizar un calificador de colección (anteriormente conocido como "etiqueta") en su contenedor realizando una solicitud de PATCH a Offer Library API.
Para obtener más información sobre el parche JSON, incluidas las operaciones disponibles, consulte el Documentación de parches de JSON.
La siguiente tabla muestra los valores válidos que componen la variable Content-Type y Aceptar 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/tag;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} |
El contenedor donde se encuentran las etiquetas. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{INSTANCE_ID} |
El ID de instancia de la etiqueta que desea actualizar. | d48fd160-13dc-11eb-bc55-c11be7252432 |
Solicitud
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"
}
]'
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 del calificador de recopilación, incluidos su ID de instancia único y el calificador de recopilación @id
.
{
"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}"
}