Extremo de caducidad del conjunto de datos

Utilice el extremo /ttl en la API de higiene de datos para programar cuándo se deben eliminar los conjuntos de datos en Adobe Experience Platform.

Una caducidad del conjunto de datos es una operación de eliminación retrasada. El conjunto de datos no está protegido mientras tanto y puede eliminarse por otros medios antes de su caducidad programada.

Antes de que comience la eliminación, puede cancelar la caducidad o cambiar su hora programada. Para volver a abrir una caducidad cancelada, establezca una nueva caducidad.

Una vez iniciada la eliminación, el trabajo de caducidad se marca como executing y ya no se puede modificar. El conjunto de datos puede recuperarse durante un máximo de siete días, pero solo a través de una solicitud de servicio manual de Adobe. Durante la eliminación, el lago de datos, el servicio de identidad y el perfil del cliente en tiempo real quitan cada uno el contenido del conjunto de datos por separado. Una vez completada la eliminación, la caducidad se marca como completed.

La administración avanzada del ciclo de vida de datos admite eliminaciones de conjuntos de datos mediante el extremo de caducidad del conjunto de datos y eliminaciones de ID (datos de nivel de fila) mediante identidades principales a través del extremo de orden de trabajo. También puede administrar caducidades de conjuntos de datos y eliminaciones de registros a través de la interfaz de usuario de Experience Platform. Consulte la documentación vinculada para obtener más información.

Introducción

El extremo utilizado en esta guía forma parte de la API de higiene de datos. Antes de continuar, revise 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.

Enumerar caducidades del conjunto de datos list

Puede enumerar todas las caducidades de los conjuntos de datos configurados para su organización realizando una petición GET al extremo /ttl.

Filtre los resultados con parámetros de consulta para devolver solo las caducidades que cumplan los criterios. Cada resultado incluye detalles de estado y configuración para cada caducidad del conjunto de datos.

Formato de API

GET /ttl?{QUERY_PARAMETERS}

Solicitud

La siguiente solicitud recupera todas las caducidades del conjunto de datos actualizadas antes del 1 de agosto de 2021 y actualizadas por última vez por un usuario cuyo nombre coincida con "Jane Doe".

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.

{
  "results": [
    {
      "ttlId": "SD-c9f113f2-d751-44bc-bc20-9d5ca0b6ae15",
      "datasetId": "3e9f815ae1194c65b2a4c5ea",
      "datasetName": "Acme_Profile_Engagements",
      "sandboxName": "acme-beta",
      "displayName": "Engagement Data Retention Policy",
      "description": "Scheduled expiry for Acme marketing data",
      "imsOrg": "C9D8E7F6A5B41234567890AB@AcmeOrg",
      "status": "pending",
      "expiry": "2027-01-12T17:15:31.000Z",
      "updatedAt": "2026-12-15T12:40:20.000Z",
      "updatedBy": "t.lannister@acme.com <t.lannister@acme.com> 3E9F815AE1194C65B2A4C5EA@acme.com"
    }
  ],
  "current_page": 0,
  "total_pages": 1,
  "total_count": 1
}

Búsqueda de una caducidad del conjunto de datos lookup

Recupere los detalles de una configuración de caducidad específica del conjunto de datos realizando una petición GET con el ID de caducidad del conjunto de datos o el ID del conjunto de datos como parámetro de ruta.

Formato de API

GET /ttl/{ID}
GET /ttl/{ID}?include=history

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",
    "displayName": "Delete Acme Data before 2025",
    "description": "The Acme information in this dataset is licensed for our use through the end of 2024.",
    "imsOrg": "885737B25DC460C50A49411B@AdobeOrg",
    "status": "pending",
    "expiry": "2035-09-25T00:00:00Z",
    "updatedAt": "2025-05-01T19:00:55.000Z",
    "updatedBy": "Jane Doe <jdoe@adobe.com> 77A51F696282E48C0A494 012@64d18d6361fae88d49412d.e",
}

Etiquetas de caducidad del catálogo

Al usar la API de catálogo para buscar detalles del conjunto de datos, si este tiene una caducidad activa, se enumerará en tags.adobe/hygiene/ttl.

El siguiente JSON muestra una respuesta de API de catálogo truncada para un conjunto de datos con un valor de caducidad de 32503680000000. La etiqueta codifica la caducidad como el número de milisegundos desde la época de 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

Cree una nueva configuración de caducidad del conjunto de datos para definir cuándo caducará un conjunto de datos y cuándo podrá eliminarse.
Proporcione el ID del conjunto de datos, la fecha de caducidad o la fecha-hora (en formato ISO 8601), un nombre para mostrar y (opcionalmente) una descripción.

Para crear una caducidad del conjunto de datos, envíe una petición POST como se muestra a continuación.

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 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
        "datasetId": "3e9f815ae1194c65b2a4c5ea",
        "expiry": "2030-12-31",
        "displayName": "Expiry rule for Acme customers",
        "description": "Set expiration for Acme customer dataset"
      }'

Respuesta

Una respuesta correcta devuelve un estado HTTP 201 (Creado) y la nueva configuración de caducidad del conjunto de datos.

{
  "ttlId": "SD-2aaf113e-3f17-4321-bf29-a2c51152b042",
  "datasetId": "3e9f815ae1194c65b2a4c5ea",
  "datasetName": "Acme_Customer_Data",
  "sandboxName": "acme-prod",
  "displayName": "Expiry rule for Acme customers",
  "description": "Set expiration for Acme customer dataset",
  "imsOrg": "{ORG_ID}",
  "status": "pending",
  "expiry": "2030-12-31T00:00:00Z",
  "updatedAt": "2025-01-02T10:35:45.000Z",
  "updatedBy": "s.stark@acme.com <s.stark@acme.com> 3E9F815AE1194C65B2A4C5EA@acme.com"
}

Se produce un estado HTTP 400 (Solicitud incorrecta) si ya existe una caducidad del conjunto de datos para el conjunto de datos. Se produce un estado HTTP 404 (no encontrado) si no existe el conjunto de datos o si no tiene acceso a él.

Actualizar una configuración de caducidad del conjunto de datos update

Para actualizar una configuración de caducidad de conjunto de datos existente, realice una petición PUT a /ttl/DATASET_EXPIRATION_ID. Solo puede actualizar los campos displayName, description y expiry de la configuración. Las actualizaciones solo se permiten cuando el estado de caducidad es pending.

Formato de API

PUT /ttl/{DATASET_EXPIRATION_ID}

Solicitud

La siguiente solicitud actualiza la caducidad, el nombre para mostrar y la descripción de la caducidad del conjunto de datos SD-c1f902aa-57cb-412e-bb2b-c70b8e1a5f45:

curl -X PUT \
  https://platform.adobe.io/data/core/hygiene/ttl/SD-c1f902aa-57cb-412e-bb2b-c70b8e1a5f45 \
  -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 '{
        "displayName": "Customer Dataset Expiry Rule",
        "description": "Updated description for Acme customer dataset",
        "expiry": "2031-06-15"
      }'

Respuesta

Una respuesta correcta devuelve el estado HTTP 200 (OK) y la configuración de caducidad del conjunto de datos actualizada.

{
  "ttlId": "SD-c1f902aa-57cb-412e-bb2b-c70b8e1a5f45",
  "datasetId": "3e9f815ae1194c65b2a4c5ea",
  "datasetName": "Acme_Customer_Data",
  "sandboxName": "acme-prod",
  "displayName": "Customer Dataset Expiry Rule",
  "description": "Updated description for Acme customer dataset",
  "imsOrg": "C9D8E7F6A5B41234567890AB@AcmeOrg",
  "status": "pending",
  "expiry": "2031-06-15T00:00:00Z",
  "updatedAt": "2031-05-01T14:11:12.000Z",
  "updatedBy": "b.tarth@acme.com <b.tarth@acme.com> 3E9F815AE1194C65B2A4C5EA@acme.com"
}

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

Cancele una configuración de caducidad del conjunto de datos pendiente realizando una petición DELETE a /ttl/{ID}.

Formato de API

DELETE /ttl/{ID}

Solicitud

La siguiente solicitud cancela la caducidad de un conjunto de datos con el ID SD-d4a7d918-283b-41fd-bfe1-4e730a613d21:

curl -X DELETE \
  https://platform.adobe.io/data/core/hygiene/ttl/SD-d4a7d918-283b-41fd-bfe1-4e730a613d21 \
  -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 200 (OK) y la configuración de caducidad del conjunto de datos cancelada. Observe que el atributo status de la caducidad está establecido en cancelled.

{
  "ttlId": "SD-d4a7d918-283b-41fd-bfe1-4e730a613d21",
  "datasetId": "5a9e2c68d3b24f03b55a91ce",
  "datasetName": "Acme_Customer_Data",
  "sandboxName": "acme-prod",
  "displayName": "Customer Dataset Expiry Rule",
  "description": "Cancelled expiry configuration for Acme customer dataset",
  "imsOrg": "C9D8E7F6A5B41234567890AB@AcmeOrg",
  "status": "cancelled",
  "expiry": "2032-02-28T00:00:00Z",
  "updatedAt": "2032-01-15T08:27:31.000Z",
  "updatedBy": "s.clegane@acme.com <s.clegane@acme.com> 5A9E2C68D3B24F03B55A91CE@acme.com"
}

Ejemplo 400 (Solicitud incorrecta) respuesta

Se produce un error 400 al intentar cancelar un conjunto de datos que tiene una configuración de caducidad de executing, completed o cancelled.

{
  "type": "http://ns.adobe.com/aep/errors/HYGN-3102-400",
  "title": "The requested dataset already has an existing expiration. Additional detail: A TTL already exists for datasetId=686e9ca25ef7462aefe72c93",
  "status": 400,
  "report": {
    "tenantInfo": {
      "sandboxName": "prod",
      "sandboxId": "not-applicable",
      "imsOrgId": "{IMS_ORG_ID}"
    },
    "additionalContext": {
      "Invoking Client ID": "acp_privacy_hygiene"
    }
  },
  "error-chain": [
    {
      "serviceId": "HYGN",
      "errorCode": "HYGN-3102-400",
      "invokingServiceId": "acp_privacy_hygiene",
      "unixTimeStampMs": 1754408150394
    }
  ]
}

Apéndice

Parámetros de consulta aceptados query-params

En la tabla siguiente se describen los parámetros de consulta disponibles al enumerar caducidades del conjunto de datos: