Extremo de caducidad del conjunto de datos
El /ttl
Este extremo de la API de higiene de datos le permite programar fechas de caducidad para conjuntos de datos en Adobe Experience Platform.
La caducidad de un conjunto de datos es solo una operación de eliminación con retraso programado. El conjunto de datos no está protegido mientras tanto, por lo que puede eliminarse por otros medios antes de que caduque.
En cualquier momento antes de que se inicie realmente la eliminación del conjunto de datos, puede cancelar la caducidad o modificar su hora de déclencheur. Después de cancelar la caducidad de un conjunto de datos, puede volver a abrirlo estableciendo una nueva caducidad.
Una vez iniciada la eliminación del conjunto de datos, su trabajo de caducidad se marcará como executing
, y no puede modificarse más. El propio conjunto de datos puede recuperarse durante un máximo de siete días, pero solo a través de un proceso manual iniciado a través de una solicitud de servicio de Adobe. A medida que se ejecuta la solicitud, el lago de datos, el servicio de identidad y el perfil del cliente en tiempo real comienzan procesos independientes para eliminar el contenido del conjunto de datos de sus respectivos servicios. Una vez eliminados los datos de los tres servicios, la caducidad se marca como completed
.
Introducción
El extremo utilizado en esta guía forma parte de la API de higiene de datos. Antes de continuar, consulte la Guía de API para obtener información sobre los encabezados necesarios para operaciones de CRUD, mensajes de error, colecciones de Postman y cómo leer llamadas de API de ejemplo.
x-sandbox-name: {SANDBOX_NAME}
encabezado.Enumerar caducidades del conjunto de datos list
Puede enumerar todas las caducidades de los conjuntos de datos de su organización realizando una solicitud de GET. Los parámetros de consulta se pueden utilizar para filtrar la respuesta y obtener los resultados adecuados.
Formato de API
GET /ttl?{QUERY_PARAMETERS}
{QUERY_PARAMETERS}
&
caracteres. Los parámetros comunes incluyen limit
y page
para fines de paginación. Para obtener una lista completa de los parámetros de consulta admitidos, consulte la sección del apéndice.Solicitud
curl -X GET \
https://platform.adobe.io/data/core/hygiene/ttl?updatedToDate=2021-08-01&author=LIKE%20%25Jane%20Doe%25 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Respuesta
Una respuesta correcta enumera las caducidades resultantes del conjunto de datos. El siguiente ejemplo se ha truncado para el espacio.
ttlId
en la respuesta también se denomina la {DATASET_EXPIRATION_ID}
. Ambos hacen referencia al identificador único para la caducidad del conjunto de datos.{
"results": [
{
"ttlId": "SD-b16c8b48-a15a-45c8-9215-587ea89369bf",
"datasetId": "629bd9125b31471b2da7645c",
"datasetName": "Sample Acme dataset",
"sandboxName": "hygiene-beta",
"imsOrg": "A2A5*EF06164773A8A49418C@AdobeOrg",
"status": "pending",
"expiry": "2050-01-01T00:00:00Z",
"updatedAt": "2023-06-09T16:52:44.136028Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e"
}
],
"current_page": 0,
"total_pages": 1,
"total_count": 1
}
total_count
results
Búsqueda de una caducidad del conjunto de datos lookup
Para buscar la caducidad de un conjunto de datos, realice una solicitud de GET con el {DATASET_ID}
o el {DATASET_EXPIRATION_ID}
.
{DATASET_EXPIRATION_ID}
se denomina la variable ttlId
en la respuesta. Ambos hacen referencia al identificador único para la caducidad del conjunto de datos.Formato de API
GET /ttl/{DATASET_ID}?include=history
GET /ttl/{DATASET_EXPIRATION_ID}
{DATASET_ID}
{DATASET_EXPIRATION_ID}
Solicitud
La siguiente solicitud busca los detalles de caducidad del conjunto de datos 62759f2ede9e601b63a2ee14
:
curl -X GET \
https://platform.adobe.io/data/core/hygiene/ttl/62759f2ede9e601b63a2ee14 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Respuesta
Una respuesta correcta devuelve los detalles de la caducidad del conjunto de datos.
{
"ttlId": "SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f",
"datasetId": "62759f2ede9e601b63a2ee14",
"datasetName": "XtVRwq9-38734",
"sandboxName": "prod",
"imsOrg": "A2A5*EF06164773A8A49418C@AdobeOrg",
"status": "pending",
"expiry": "2024-12-31T23:59:59Z",
"updatedAt": "2024-05-11T15:12:40.393115Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e",
"displayName": "Delete Acme Data before 2025",
"description": "The Acme information in this dataset is licensed for our use through the end of 2024."
}
ttlId
datasetId
datasetName
sandboxName
imsOrg
status
expiry
updatedAt
updatedBy
displayName
description
Etiquetas de caducidad del catálogo
Al usar el API de catálogo para buscar los detalles del conjunto de datos, si este tiene una caducidad activa, se enumerará en tags.adobe/hygiene/ttl
.
El siguiente JSON representa una respuesta truncada para los detalles de un conjunto de datos del catálogo, que tiene un valor de caducidad de 32503680000000
. El valor de la etiqueta codifica la caducidad como un número entero de milisegundos desde el comienzo de la época Unix.
{
"63212313c308d51b997858ba": {
"name": "Test Dataset",
"description": "A piecrust promise, made to be broken",
"imsOrg": "0FCC747E56F59C747F000101@AdobeOrg",
"sandboxId": "8dc51b90-d0f9-11e9-b164-ed6a398c8b35",
"tags": {
"adobe/hygiene/ttl": [ "32503680000000" ],
...
},
...
}
}
Crear una caducidad del conjunto de datos create
Para garantizar que los datos se eliminen del sistema después de un periodo especificado, programe una caducidad para un conjunto de datos específico proporcionando el ID del conjunto de datos y la fecha y hora de caducidad en formato ISO 8601.
Para crear una caducidad del conjunto de datos, realice una solicitud de POST como se muestra a continuación y proporcione los valores mencionados a continuación dentro de la carga útil.
Formato de API
POST /ttl
Solicitud
curl -X POST \
https://platform.adobe.io/data/core/hygiene/ttl \
-H `Authorization: Bearer {ACCESS_TOKEN}`
-H `x-gw-ims-org-id: {ORG_ID}`
-H `x-api-key: {API_KEY}`
-H `Accept: application/json`
-d {
"datasetId": "5b020a27e7040801dedbf46e",
"expiry": "2030-12-31T23:59:59Z"
"displayName": "Delete Acme Data before 2025",
"description": "The Acme information in this dataset is licensed for our use through the end of 2024."
}
datasetId
expiry
Requerido Una fecha y hora en formato ISO 8601. Si la cadena no tiene un desplazamiento explícito de zona horaria, se asume que la zona horaria es UTC. La duración de los datos dentro del sistema se establece según el valor de caducidad proporcionado.
Nota:
- La solicitud fallará si ya existe una caducidad del conjunto de datos para él.
- Esta fecha y hora deben ser al menos 24 horas en el futuro.
displayName
description
Respuesta
Una respuesta correcta devuelve el estado HTTP 201 (Creado) y el nuevo estado de caducidad del conjunto de datos.
{
"ttlId": "SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f",
"datasetId": "5b020a27e7040801dedbf46e",
"datasetName": "Acme licensed data",
"sandboxName": "prod",
"imsOrg": "{ORG_ID}",
"status": "pending",
"expiry": "2030-12-31T23:59:59Z",
"updatedAt": "2021-08-19T11:14:16Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e",
"displayName": "Delete Acme Data before 2031",
"description": "The Acme information in this dataset is licensed for our use through the end of 2030."
}
ttlId
datasetId
datasetName
sandboxName
imsOrg
status
expiry
updatedAt
updatedBy
displayName
description
Se produce un estado HTTP 400 (Solicitud incorrecta) si ya existe una caducidad del conjunto de datos para el conjunto de datos. Una respuesta incorrecta devolverá un estado HTTP 404 (no encontrado) si no existe dicha caducidad del conjunto de datos (o si no tiene acceso al conjunto de datos).
Actualizar la caducidad de un conjunto de datos update
Para actualizar una fecha de caducidad para un conjunto de datos, utilice una solicitud del PUT y la variable ttlId
. Puede actualizar el displayName
, description
, y/o expiry
información.
Formato de API
PUT /ttl/{DATASET_EXPIRATION_ID}
{DATASET_EXPIRATION_ID}
ttlId
en la respuesta.Solicitud
La siguiente solicitud vuelve a programar la caducidad de un conjunto de datos SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f
a finales de 2024 (hora del meridiano de Greenwich). Si se encuentra la caducidad del conjunto de datos existente, esa caducidad se actualiza con el nuevo expiry
valor.
curl -X PUT \
https://platform.adobe.io/data/core/hygiene/ttl/SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"expiry": "2024-12-31T23:59:59Z",
"displayName": "Delete Acme Data before 2025",
"description": "The Acme information in this dataset is licensed for our use through the end of 2024."
}'
expiry
displayName
description
Respuesta
Una respuesta correcta devuelve el nuevo estado de caducidad del conjunto de datos y un estado HTTP 200 (OK) si se actualizó una caducidad preexistente.
{
"ttlId": "SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f",
"datasetId": "5b020a27e7040801dedbf46e",
"imsOrg": "A2A5*EF06164773A8A49418C@AdobeOrg",
"status": "pending",
"expiry": "2024-12-31T23:59:59Z",
"updatedAt": "2022-05-09T22:38:40.393115Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e",
"displayName": "Delete Acme Data before 2025",
"description": "The Acme information in this dataset is licensed for our use through the end of 2024."
}
ttlId
datasetId
imsOrg
status
expiry
updatedAt
updatedBy
Una respuesta incorrecta devolverá un estado HTTP 404 (no encontrado) si no existe dicha caducidad del conjunto de datos.
Cancelar una caducidad del conjunto de datos delete
Puede cancelar la caducidad de un conjunto de datos realizando una solicitud al DELETE.
pending
se puede cancelar. Si se intenta cancelar una caducidad que se ha ejecutado o que ya se ha cancelado, se devuelve un error HTTP 404.Formato de API
DELETE /ttl/{EXPIRATION_ID}
{EXPIRATION_ID}
ttlId
de la caducidad del conjunto de datos que desea cancelar.Solicitud
La siguiente solicitud cancela una caducidad del conjunto de datos con ID SD-b16c8b48-a15a-45c8-9215-587ea89369bf
:
curl -X DELETE \
https://platform.adobe.io/data/core/hygiene/ttl/SD-b16c8b48-a15a-45c8-9215-587ea89369bf \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Respuesta
Una respuesta correcta devuelve el estado HTTP 204 (sin contenido) y el de la caducidad status
el atributo se establece en cancelled
.
Recuperar el historial de estado de caducidad de un conjunto de datos retrieve-expiration-history
Para buscar el historial de estado de caducidad de un conjunto de datos específico, utilice el {DATASET_ID}
y include=history
parámetro de consulta en una solicitud de búsqueda. El resultado incluye información sobre la creación de la caducidad del conjunto de datos, cualquier actualización que se haya aplicado y su cancelación o ejecución (si corresponde). También puede utilizar la variable {DATASET_EXPIRATION_ID}
para recuperar el historial de estado de caducidad del conjunto de datos.
Formato de API
GET /ttl/{DATASET_ID}?include=history
GET /ttl/{DATASET_EXPIRATION_ID}?include=history
{DATASET_ID}
{DATASET_EXPIRATION_ID}
ttlId
en la respuesta.Solicitud
curl -X GET \
https://platform.adobe.io/data/core/hygiene/ttl/62759f2ede9e601b63a2ee14?include=history \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Respuesta
Una respuesta correcta devuelve los detalles de la caducidad del conjunto de datos, con un history
matriz que proporciona los detalles de su status
, expiry
, updatedAt
, y updatedBy
atributos para cada una de sus actualizaciones registradas.
{
"ttlId": "SD-b16c8b48-a15a-45c8-9215-587ea89369bf",
"datasetId": "62759f2ede9e601b63a2ee14",
"datasetName": "Example Dataset",
"sandboxName": "prod",
"displayName": "Expiration Request 123",
"description": "Expiration Request 123 Description",
"imsOrg": "0FCC747E56F59C747F000101@AdobeOrg",
"status": "cancelled",
"expiry": "2022-05-09T23:47:30.071186Z",
"updatedAt": "2022-05-09T23:47:30.071186Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e",
"history": [
{
"status": "created",
"expiry": "2032-12-31T23:59:59Z",
"updatedAt": "2022-05-09T22:38:40.393115Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e"
},
{
"status": "updated",
"expiry": "2032-12-31T23:59:59Z",
"updatedAt": "2022-05-09T22:41:46.731002Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e"
},
{
"status": "cancelled",
"expiry": "2022-05-09T23:47:30.071186Z",
"updatedAt": "2022-05-09T23:47:30.071186Z",
"updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e"
}
]
}
ttlId
datasetId
datasetName
sandboxName
displayName
description
imsOrg
history
status
, expiry
, updatedAt
, y updatedBy
atributos para la caducidad en el momento de la actualización.Apéndice
Parámetros de consulta aceptados query-params
En la tabla siguiente se describen los parámetros de consulta disponibles cuando enumerar caducidades del conjunto de datos:
description
, displayName
, y datasetName
todos los parámetros contienen la capacidad de buscar por valores LIKE. Esto significa que puede encontrar caducidades de conjuntos de datos programados llamados: "Name123", "Name183", "DisplayName1234" buscando la cadena "Name1".author
created_by
coincide con la cadena de búsqueda. Si la cadena de búsqueda empieza por LIKE
o NOT LIKE
, el resto se trata como un patrón de búsqueda SQL. De lo contrario, toda la cadena de búsqueda se trata como una cadena literal que debe coincidir exactamente con todo el contenido de un created_by
field.author=LIKE %john%
, author=John Q. Public
cancelledDate
/ cancelledToDate
/ cancelledFromDate
updatedDate=2022-01-01
completedDate
/ completedToDate
/ completedFromDate
completedToDate=2021-11-11-06:00
createdDate
Tenga en cuenta que las fechas sin una hora (como
2021-12-07
) representan la fecha y hora al principio de ese día. Por lo tanto, createdDate=2021-12-07
hace referencia a cualquier caducidad creada el 7 de diciembre de 2021, desde 00:00:00
mediante 23:59:59.999999999
(UTC).createdDate=2021-12-07
createdFromDate
createdFromDate=2021-12-07T00:00:00Z
createdToDate
createdToDate=2021-12-07T23:59:59.999999999Z
datasetId
datasetId=62b3925ff20f8e1b990a7434
datasetName
datasetName=Acme
description
description=Handle expiration of Acme information through the end of 2024.
displayName
displayName=License Expiry
executedDate
/ executedFromDate
/ executedToDate
executedDate=2023-02-05T19:34:40.383615Z
expiryDate
/ expiryToDate
/ expiryFromDate
expiryFromDate=2099-01-01&expiryToDate=2100-01-01
limit
limit=50
orderBy
orderBy
parámetro de consulta especifica el orden de clasificación de los resultados devueltos por la API. Utilícelo para organizar los datos en función de uno o varios campos, ya sea en orden ascendente (ASC) o descendente (DESC). Utilice el prefijo + o - para indicar ASC y DESC, respectivamente. Se aceptan los siguientes valores: displayName
, description
, datasetName
, id
, updatedBy
, updatedAt
, expiry
, status
.-datasetName
orgId
x-gw-ims-org-id
y se omite a menos que la solicitud proporcione un token de servicio.orgId=885737B25DC460C50A49411B@AdobeOrg
page
page=3
sandboxName
x-sandbox-name
encabezado. Uso sandboxName=*
para incluir las caducidades del conjunto de datos de todas las zonas protegidas.sandboxName=dev1
search
Coincide con caducidades en las que la cadena especificada coincide exactamente con el ID de caducidad o contenido en cualquiera de estos campos:
- autor
- nombre para mostrar
- descripción
- nombre para mostrar
- nombre del conjunto de datos
search=TESTING
status
status=pending,cancelled
ttlId
ttlID=SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f
updatedDate
/ updatedToDate
/ updatedFromDate
createdDate
/ createdFromDate
/ createdToDate
, pero coincide con la hora de actualización de una caducidad del conjunto de datos en lugar de la hora de creación.Una caducidad se considera actualizada en cada edición, incluso cuando se crea, cancela o ejecuta.
updatedDate=2022-01-01