Slutpunkt för förfallodatum för datauppsättning

Använd /ttl-slutpunkten i Data Hygiene API för att schemalägga när datauppsättningar i Adobe Experience Platform ska tas bort.

En datamängds förfallodatum är en fördröjd borttagningsåtgärd. Datauppsättningen är inte skyddad i mellantiden och kan tas bort på annat sätt innan dess planerade förfallodatum.

Innan borttagningen börjar kan du avbryta förfallodatumet eller ändra den schemalagda tiden. Ange ett nytt förfallodatum om du vill öppna ett annullerat förfallodatum.

När borttagningen påbörjas markeras förfallojobbet som executing och kan inte längre ändras. Datauppsättningen kan återvinnas i upp till sju dagar, men endast genom en manuell begäran från Adobe. Under borttagningen tar datasjön, identitetstjänsten och kundprofilen i realtid bort datauppsättningsinnehållet separat. När borttagningen är klar markeras förfallotiden som completed.

Avancerad livscykelhantering för data stöder borttagning av datauppsättningar via datauppsättningens slutpunkt och ID-borttagningar (data på radnivå) med hjälp av primära identiteter via arbetsorderslutpunkten. Du kan också hantera förfallodatum för datauppsättningar och borttagningar av poster via Experience Platform-gränssnittet. Mer information finns i den länkade dokumentationen.

Komma igång

Slutpunkten som används i den här guiden är en del av API:t för datahygien. Innan du fortsätter bör du läsa API-handboken för att få information om vilka huvuden som krävs för CRUD-åtgärder, felmeddelanden, Postman-samlingar och hur du läser exempel-API-anrop.

Visa förfallodatum för datamängd list

Du kan visa alla datauppsättningsförfallotider som har konfigurerats för din organisation genom att göra en GET-begäran till slutpunkten /ttl.

Filtrera resultat med frågeparametrar för att returnera endast förfallotider som uppfyller dina villkor. Varje resultat innehåller status- och konfigurationsinformation för varje datamängds förfallodatum.

API-format

GET /ttl?{QUERY_PARAMETERS}

Begäran

Följande begäran hämtar alla datauppsättningsförfallodatum som har uppdaterats före 1 augusti 2021 och senast uppdaterats av en användare vars namn matchar "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}'

Svar

Ett lyckat svar listar de resulterande datauppsättningens förfallotider. Följande exempel har trunkerats för utrymme.

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

Söka efter en förfallotid för en datauppsättning lookup

Hämta information om en viss förfallokonfiguration för datauppsättning genom att göra en GET-begäran med antingen datauppsättningens förfallodatum-ID eller datauppsättnings-ID som sökvägsparameter.

API-format

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

Begäran

Följande begäran letar upp förfalloinformationen för datauppsättningen 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}'

Svar

Ett lyckat svar returnerar information om datauppsättningens förfallodatum.

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

Förfallotaggar för katalog

När du använder katalog-API:t för att söka efter datauppsättningsinformation, kommer den att listas under tags.adobe/hygiene/ttl om datauppsättningen har en aktiv förfallotid.

Följande JSON visar ett trunkerat Catalog API-svar för en datauppsättning med ett förfallovärde på 32503680000000. Taggen kodar förfallodatumet som antalet millisekunder sedan Unix-epoken.

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

Skapa en förfallotid för datauppsättning create

Skapa en ny utgångskonfiguration för datauppsättningar som definierar när en datauppsättning upphör att gälla och kan tas bort.
Ange datauppsättnings-ID, utgångsdatum eller datum-tid (i ISO 8601-format), ett visningsnamn och (eventuellt) en beskrivning.

Om du vill skapa en förfallotid för en datauppsättning skickar du en POST-begäran enligt nedan.

API-format

POST /ttl

Begäran

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

Svar

Ett lyckat svar returnerar en HTTP 201-status (skapad) och den nya konfigurationen för förfallodatum.

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

HTTP-statusen 400 (Ogiltig begäran) inträffar om det redan finns en förfallotid för datauppsättningen. HTTP-statusen 404 (Hittades inte) inträffar om det inte finns någon sådan datauppsättning eller om du inte har tillgång till datauppsättningen.

Uppdatera en förfallokonfiguration för datauppsättning update

Om du vill uppdatera en befintlig förfallokonfiguration för datauppsättning gör du en PUT-begäran till /ttl/DATASET_EXPIRATION_ID. Du kan bara uppdatera fälten displayName, description och expiry för konfigurationen. Uppdateringar tillåts bara när förfallostatusen är pending.

API-format

PUT /ttl/{DATASET_EXPIRATION_ID}

Begäran

Följande begäran uppdaterar förfallodatum, visningsnamn och beskrivning för datauppsättningens förfallodatum 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"
      }'

Svar

Ett lyckat svar returnerar HTTP-status 200 (OK) och den uppdaterade konfigurationen för förfallodatum för datauppsättning.

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

Ett misslyckat svar returnerar HTTP-statusen 404 (Hittades inte) om det inte finns någon sådan förfallotid för datauppsättningen.

Avbryt förfallodatum för en datauppsättning delete

Avbryt en väntande förfallokonfiguration för datauppsättning genom att göra en DELETE-begäran till /ttl/{ID}.

API-format

DELETE /ttl/{ID}

Begäran

Följande begäran avbryter en förfallotid för en datauppsättning med 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}'

Svar

Ett lyckat svar returnerar HTTP-status 200 (OK) och den avbrutna konfigurationen för förfallodatum. Inte för att förfallodatumets status-attribut är inställt på 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"
}

Exempel 400 (felaktig begäran) svar

Ett 400-fel inträffar när du försöker avbryta en datauppsättning som har en executing-, completed- eller cancelled-förfallokonfiguration.

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

Bilaga

Godkända frågeparametrar query-params

I följande tabell visas de tillgängliga frågeparametrarna när en lista över datauppsättningens förfallotider visas: