Endpunkt der Datensatzgültigkeit

Verwenden Sie den /ttl-Endpunkt in der Data Hygiene API, um zu planen, wann Datensätze in Adobe Experience Platform gelöscht werden sollen.

Eine Datensatzgültigkeit ist ein verzögerter Löschvorgang. Der Datensatz ist in der Zwischenzeit nicht geschützt und kann vor seiner geplanten Gültigkeit auf andere Weise gelöscht werden.

Bevor der Löschvorgang beginnt, können Sie den Ablauf abbrechen oder den geplanten Zeitpunkt ändern. Um eine abgebrochene Gültigkeit erneut zu öffnen, legen Sie ein neues Ablaufdatum fest.

Sobald der Löschvorgang beginnt, wird der Gültigkeitsvorgang als executing markiert und kann nicht mehr geändert werden. Der Datensatz kann bis zu sieben Tage lang wiederhergestellt werden, jedoch nur über eine manuelle Adobe-Service-Anfrage. Während des Löschens entfernen der Data Lake, der Identity Service und das Echtzeit-Kundenprofil jeweils separat die Inhalte des Datensatzes. Nach Abschluss des Löschvorgangs wird der Ablauf als completed markiert.

Advanced Data Lifecycle Management unterstützt das Löschen von Datensätzen über den Datensatzgültigkeits-Endpunkt und ID-Löschungen (Daten auf Zeilenebene) mithilfe primärer Identitäten über den Arbeitsauftrags-Endpunkt. Sie können das Löschen von Datensatzgültigkeiten und Datensätzen auch über die Experience Platform-Benutzeroberfläche verwalten. Weitere Informationen finden Sie in der verknüpften Dokumentation .

Erste Schritte

Der in diesem Handbuch verwendete Endpunkt ist Teil der Data Hygiene API. Bevor Sie fortfahren, lesen Sie API-Handbuch um Informationen zu den erforderlichen Kopfzeilen für CRUD-Vorgänge, Fehlermeldungen, Postman-Sammlungen und zum Lesen von Beispiel-API-Aufrufen zu erhalten.

Auflisten der Datensatzgültigkeiten list

Sie können alle für Ihr Unternehmen konfigurierten Datensatzgültigkeiten auflisten, indem Sie eine GET-Anfrage an den /ttl-Endpunkt stellen.

Filtern Sie Ergebnisse mithilfe von Abfrageparametern, um nur die Gültigkeiten zurückzugeben, die Ihren Kriterien entsprechen. Jedes Ergebnis enthält Status- und Konfigurationsdetails für jede Datensatzgültigkeit.

API-Format

GET /ttl?{QUERY_PARAMETERS}

Anfrage

Die folgende Anfrage ruft alle Datensatzgültigkeiten ab, die vor dem 1. August 2021 aktualisiert wurden und zuletzt von einem Benutzer aktualisiert wurden, dessen Name mit „Jane Doe“ übereinstimmt.

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}'

Antwort

Eine erfolgreiche Antwort listet die resultierenden Datensatzgültigkeiten auf. Das folgende Beispiel wurde aus Platzgründen gekürzt.

{
  "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
}

Nachschlagen einer Datensatzgültigkeit lookup

Rufen Sie die Details für eine bestimmte Datensatzgültigkeitskonfiguration ab, indem Sie eine GET-Anfrage mit entweder der Datensatzgültigkeits-ID oder der Datensatz-ID als Pfadparameter stellen.

API-Format

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

Anfrage

Die folgende Anfrage sucht für den Datensatz 62759f2ede9e601b63a2ee14 nach den Details der Gültigkeit:

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}'

Antwort

Eine erfolgreiche Antwort gibt die Details der Datensatzgültigkeit zurück.

{
    "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",
}

Gültigkeits-Tags des Katalogs

Wenn Sie die Katalog-API verwenden, um Details zu einem Datensatz nachzuschlagen, wird dieser unter tags.adobe/hygiene/ttl aufgeführt, wenn er ein aktives Gültigkeitsdatum hat.

Die folgende JSON-Datei enthält die gekürzte Katalog-API-Antwort für einen Datensatz mit einem Gültigkeitswert von 32503680000000. Das Tag kodiert den Ablauf als die Anzahl der Millisekunden seit der Unix-Epoche.

{
  "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" ],
      ...
    },
    ...
  }
}

Erstellen einer Datensatzgültigkeit create

Erstellen Sie eine neue Konfiguration für die Datensatzgültigkeit, um festzulegen, wann ein Datensatz abläuft und gelöscht werden kann.
Geben Sie die Datensatz-ID, das Ablaufdatum oder die Datums-/Uhrzeitangabe (im ISO 8601-Format), einen Anzeigenamen und (optional) eine Beschreibung an.

Um eine Datensatzgültigkeit zu erstellen, senden Sie eine POST-Anfrage, wie unten dargestellt.

API-Format

POST /ttl

Anfrage

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"
      }'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 201 (Erstellt) und die neue Konfiguration der Datensatzgültigkeit zurück.

{
  "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"
}

Ein 400-HTTP-Status (Bad Request) tritt auf, wenn für den Datensatz bereits eine Datensatzgültigkeit vorhanden ist. Ein 404-HTTP-Status (Nicht gefunden) tritt auf, wenn kein solcher Datensatz vorhanden ist oder Sie keinen Zugriff auf den Datensatz haben.

Aktualisieren einer Datensatzgültigkeitskonfiguration update

Um eine vorhandene Datensatzgültigkeitskonfiguration zu aktualisieren, stellen Sie eine PUT-Anfrage an /ttl/DATASET_EXPIRATION_ID. Sie können nur die Felder displayName, description und expiry der Konfiguration aktualisieren. Aktualisierungen sind nur zulässig, wenn der Ablaufstatus pending ist.

API-Format

PUT /ttl/{DATASET_EXPIRATION_ID}

Anfrage

Die folgende Anfrage aktualisiert die Gültigkeit, den Anzeigenamen und die Beschreibung für 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"
      }'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 (OK) und die aktualisierte Konfiguration der Datensatzgültigkeit zurück.

{
  "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"
}

Eine nicht erfolgreiche Antwort gibt den HTTP-Status 404 (Nicht gefunden) zurück, wenn keine solche Datensatzgültigkeit vorhanden ist.

Abbrechen der Datensatzgültigkeit delete

Brechen Sie eine ausstehende Konfiguration für die Datensatzgültigkeit ab, indem Sie eine DELETE-Anfrage an /ttl/{ID} stellen.

API-Format

DELETE /ttl/{ID}

Anfrage

Mit der folgenden Anfrage wird die Gültigkeit eines Datensatzes mit der ID SD-d4a7d918-283b-41fd-bfe1-4e730a613d21 abgebrochen:

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}'

Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Status 200 (OK) sowie die Konfiguration der abgebrochenen Datensatzgültigkeit zurückgegeben. Beachten Sie, dass das status der Gültigkeit auf cancelled festgelegt ist.

{
  "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"
}

Beispiel-400-Antwort (Bad Request)

Beim Versuch, einen Datensatz mit einer executing-, completed- oder cancelled-Ablaufkonfiguration abzubrechen, tritt ein 400-Fehler auf.

{
  "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
    }
  ]
}

Anhang

Akzeptierte Abfrageparameter query-params

In der folgenden Tabelle sind die verfügbaren Abfrageparameter beim Auflisten von Datensatzgültigkeiten aufgeführt: