Eindpunt gegevensset

Gebruik het /ttl eindpunt in de API voor gegevenshygiëne om te plannen wanneer datasets in Adobe Experience Platform moeten worden verwijderd.

Een gegevenssetvervaldatum is een vertraagde schrappingsverrichting. De gegevensset is niet in de tussentijd beschermd en kan op een andere manier worden verwijderd vóór de geplande vervaldatum.

Voordat het verwijderen begint, kunt u de vervaldatum annuleren of de geplande tijd ervan wijzigen. Stel een nieuwe vervaldatum in om een geannuleerde vervaldatum opnieuw te openen.

Nadat het verwijderen is gestart, wordt de vervaltaak gemarkeerd als executing en kan deze niet meer worden gewijzigd. De gegevensset kan maximaal zeven dagen worden hersteld, maar alleen via een handmatig verzoek van de Adobe-service. Tijdens schrapping, verwijderen het gegevens meer, de Dienst van de Identiteit, en het Profiel van de Klant in real time elk de gegevenssetinhoud afzonderlijk. Wanneer het verwijderen is voltooid, wordt de vervaldatum gemarkeerd als completed .

Het geavanceerde Beheer van de Levenscyclus van Gegevens steunt datasetschrappingen door het eindpunt van de gegevenssetvervalsing en identiteitskaart schrappingen (rij-vlakke gegevens) gebruikend primaire identiteiten via het ​ werkordeeindpunt ​. U kunt ​ datasetvervalingen ​ en ​ verslagschrappingen ​ door Experience Platform UI ook beheren. Raadpleeg de gekoppelde documentatie voor meer informatie.

Aan de slag

Het eindpunt dat in deze handleiding wordt gebruikt, maakt deel uit van de Data Hygiene API. Alvorens verder te gaan, te herzien gelieve de ​ API gids ​ voor informatie over vereiste kopballen voor verrichtingen CRUD, foutenmeldingen, de inzamelingen van Postman, en hoe te om steekproefAPI vraag te lezen.

Verlopen gegevensset weergeven list

U kunt van alle datasettermijnen een lijst maken die voor uw organisatie door een verzoek van GET aan het /ttl eindpunt worden gevormd.

De resultaten van de filter gebruikend vraagparameters om slechts de termijnen terug te keren die aan uw criteria voldoen. Elk resultaat omvat status en configuratiedetails voor elke datasetvervaldatum.

API formaat

GET /ttl?{QUERY_PARAMETERS}

Verzoek

Het volgende verzoek wint alle datasettermijnen terug die vóór 1 Augustus, 2021 worden bijgewerkt, en laatst bijgewerkt door een gebruiker de waarvan naam "Jansen"aanpast.

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

Reactie

Een succesvolle reactie maakt een lijst van de resulterende datasetvervaldata. Het volgende voorbeeld is afgekapt voor ruimte.

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

Een gegevensset opzoeken die vervalt lookup

Haal de details voor een specifieke configuratie van de datasetvervaldatum door een verzoek van GET met of identiteitskaart van de datasetvervaldatum of datasetidentiteitskaart als wegparameter te doen.

API formaat

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

Verzoek

In het volgende verzoek worden de vervalgegevens voor de gegevensset 62759f2ede9e601b63a2ee14 weergegeven:

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

Reactie

Een succesvolle reactie keert de details van de datasetvervaldatum terug.

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

Vervaltags voor catalogi

Wanneer het gebruiken van de ​ Catalogus API ​ om datasetdetails op te zoeken, als de dataset een actieve afloop heeft zal het onder tags.adobe/hygiene/ttl worden vermeld.

In de volgende JSON wordt een ingekorte API-reactie van de catalogus weergegeven voor een dataset met de vervalwaarde 32503680000000 . De tag codeert de vervaldatum als het aantal milliseconden dat is verstreken sinds het Unix-tijdperk.

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

Een gegevensset maken die vervalt create

Creeer een nieuwe configuratie van de datasetvervaldatum om te bepalen wanneer een dataset zal verlopen en verkiesbaar voor schrapping zijn.
Geef de id van de gegevensset, de vervaldatum of de datum-tijd (in ISO 8601-indeling), een weergavenaam en (optioneel) een beschrijving op.

Om een datasetvervaldatum tot stand te brengen, verzend een POST- verzoek zoals hieronder getoond.

API formaat

POST /ttl

Verzoek

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

Reactie

Een succesvolle reactie keert een (Gecreeerde) status HTTP 201 en de nieuwe configuratie van de datasetvervaldatum terug.

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

De HTTP-status 400 (Onjuist verzoek) treedt op als er al een gegevenssetvervaldatum bestaat voor de gegevensset. De HTTP-status 404 (Niet gevonden) treedt op als een dergelijke gegevensset niet bestaat of als u geen toegang hebt tot de gegevensset.

Een configuratie voor de vervaldatum van een gegevensset bijwerken update

Als u een bestaande vervalconfiguratie van een gegevensset wilt bijwerken, vraagt u PUT om /ttl/DATASET_EXPIRATION_ID . U kunt alleen de velden displayName , description en expiry van de configuratie bijwerken. Updates zijn alleen toegestaan wanneer de vervalstatus pending is.

API formaat

PUT /ttl/{DATASET_EXPIRATION_ID}

Verzoek

De volgende aanvraag werkt de vervaldatum, weergavenaam en beschrijving voor de vervaldatum van de gegevensset bij 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"
      }'

Reactie

Een succesvolle reactie keert HTTP status 200 (OK) en de bijgewerkte configuratie van de datasetvervaldatum terug.

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

Een mislukte reactie retourneert een HTTP-status van 404 (Niet gevonden) als een dergelijke vervaldatum van de gegevensset niet bestaat.

Vervaldatum gegevensset annuleren delete

Annuleer een in afwachting zijnde configuratie voor de vervaldatum van een dataset door een DELETE-aanvraag in te dienen bij /ttl/{ID}.

API formaat

DELETE /ttl/{ID}

Verzoek

Het volgende verzoek annuleert een gegevenssetvervaldatum met identiteitskaart 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}'

Reactie

Een succesvolle reactie keert HTTP status 200 (OK) en de geannuleerde configuratie van de datasetvervaldatum terug. Het kenmerk status van de vervaldatum wordt niet ingesteld op 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"
}

Voorbeeld 400 (Slecht Verzoek) reactie

Er treedt een fout van 400 op wanneer u probeert een gegevensset te annuleren die de vervalconfiguratie executing , completed of cancelled heeft.

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

Bijlage

Geaccepteerde queryparameters query-params

De volgende lijst schetst de beschikbare vraagparameters wanneer ​ van de lijst dataset vervalst ​: