Endpoint scadenza set di dati
L'endpoint /ttl
nell'API di igiene dei dati consente di programmare le date di scadenza dei set di dati in Adobe Experience Platform.
La scadenza di un set di dati è solo un’operazione di eliminazione ritardata nel tempo. Il set di dati non è protetto nel frattempo, pertanto può essere cancellato con altri mezzi prima che sia raggiunta la sua scadenza.
In qualsiasi momento, prima che l’eliminazione del set di dati venga effettivamente avviata, puoi annullare la scadenza o modificarne l’ora di attivazione. Dopo aver annullato la scadenza di un set di dati, puoi riaprirlo impostando una nuova scadenza.
Una volta avviata l’eliminazione del set di dati, il relativo processo di scadenza verrà contrassegnato come executing
e non può essere ulteriormente modificata. Il set di dati stesso può essere recuperabile per un massimo di sette giorni, ma solo attraverso un processo manuale avviato tramite un servizio Adobe Systems richiesta. Man mano che il richiesta viene eseguito, il data lake, il servizio Identity e il profilo cliente in tempo reale avviano processi separati per rimuovere il contenuto del set di dati dai rispettivi servizi. Una volta eliminati i dati da tutti e tre i servizi, la scadenza viene contrassegnata come completed
.
Advanced Data Lifecycle Management supporta l'eliminazione dei set di dati attraverso l'endpoint di scadenza del set di dati e l'eliminazione degli ID (dati a livello di riga) tramite le identità primarie endpoint ordine di lavoro. Puoi anche gestire scadenze dei set di dati e eliminazioni di record tramite l’interfaccia utente di Platform. Per ulteriori informazioni, consulta la documentazione collegata.
Introduzione
L’endpoint utilizzato in questa guida fa parte dell’API di igiene dei dati. Prima di continuare, controlla Guida API per informazioni sulle intestazioni richieste per operazioni CRUD, messaggi di errore, raccolte Postman e come leggere chiamate API di esempio.
x-sandbox-name: {SANDBOX_NAME}
intestazione.Elenca scadenze set di dati list
Per elencare tutte le scadenze dei set di dati per la tua organizzazione, devi eseguire una richiesta GET. I parametri di query possono essere utilizzati per filtrare la risposta in base ai risultati appropriati.
Formato API
GET /ttl?{QUERY_PARAMETERS}
{QUERY_PARAMETERS}
&
caratteri. I parametri comuni includono limit
e page
a scopo di impaginazione. Per un elenco completo dei parametri di query supportati, consulta sezione dell'appendice.Richiesta
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}'
Risposta
In caso di esito positivo, la risposta elenca le scadenze risultanti del set di dati. L'esempio seguente è stato troncato per motivi di spazio.
ttlId
nella risposta viene anche indicato come {DATASET_EXPIRATION_ID}
. Entrambi fanno riferimento all’identificatore univoco per la scadenza del set di dati.{
"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
Cercare una scadenza del set di dati lookup
Per cercare la scadenza di un set di dati, effettua una richiesta GET con {DATASET_ID}
o {DATASET_EXPIRATION_ID}
.
{DATASET_EXPIRATION_ID}
è denominato ttlId
nella risposta. Entrambi fanno riferimento all’identificatore univoco per la scadenza del set di dati.Formato API
GET /ttl/{DATASET_ID}?include=history
GET /ttl/{DATASET_EXPIRATION_ID}
{DATASET_ID}
{DATASET_EXPIRATION_ID}
Richiesta
La richiesta seguente cerca i dettagli di scadenza per il set di dati 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}'
Risposta
In caso di esito positivo, la risposta restituisce i dettagli della scadenza del set di dati.
{
"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
Tag di scadenza catalogo
Quando si utilizza l'API🔗 Catalog per cercare i dettagli del set di dati, se il set di dati ha una scadenza attiva, verrà elencato in tags.adobe/hygiene/ttl
.
Il codice JSON seguente rappresenta una risposta troncata per i dettagli di un dataset da Catalog, il cui valore di scadenza è 32503680000000
. Il valore del tag codifica la scadenza come numero intero di millisecondi dall’inizio dell’epoca 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" ],
...
},
...
}
}
Creare una scadenza del set di dati create
Per garantire che i dati vengano rimossi dal sistema dopo un determinato periodo, pianifica una scadenza per un set di dati specifico fornendo l’ID del set di dati e la data e l’ora di scadenza nel formato ISO 8601.
Per creare una scadenza del set di dati, esegui una richiesta POST come mostrato di seguito e fornisci i valori menzionati di seguito all’interno del payload.
Formato API
POST /ttl
Richiesta
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
Obbligatorio Data e ora nel formato ISO 8601. Se la stringa non presenta scostamenti di fuso orario espliciti, si presume che il fuso orario sia UTC. La durata dei dati all’interno del sistema viene impostata in base al valore di scadenza fornito.
Nota:
- La richiesta non riuscirà se per il set di dati esiste già una scadenza del set di dati.
- La data e l'ora devono essere almeno 24 ore nel futuro.
displayName
description
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 201 (Creato) e il nuovo stato di scadenza del set di dati.
{
"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 per il set di dati esiste già una scadenza, si verifica uno stato HTTP 400 (richiesta non valida). In caso di esito negativo, la risposta restituisce lo stato HTTP 404 (Non trovato) se non esiste una scadenza del set di dati (o se non disponi dell’accesso al set di dati).
Aggiornare la scadenza di un set di dati update
Per aggiornare una data di scadenza per un set di dati, utilizza una richiesta PUT e ttlId
. È possibile aggiornare displayName
, description
, e/o expiry
informazioni.
Formato API
PUT /ttl/{DATASET_EXPIRATION_ID}
{DATASET_EXPIRATION_ID}
ttlId
nella risposta.Richiesta
La richiesta seguente ripianifica la scadenza di un set di dati SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f
alla fine del 2024 (ora di Greenwich). Se viene trovata la scadenza del set di dati esistente, tale scadenza viene aggiornata con il nuovo expiry
valore.
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
Risposta
In caso di esito positivo, la risposta restituisce il nuovo stato della scadenza del set di dati e uno stato HTTP 200 (OK) se è stata aggiornata una scadenza preesistente.
{
"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
In caso di esito negativo, la risposta restituisce lo stato HTTP 404 (Non trovato) se non esiste una scadenza del set di dati.
Annullare la scadenza di un set di dati delete
Per annullare la scadenza di un set di dati, devi eseguire una richiesta DELETE.
pending
. Se si tenta di annullare una scadenza eseguita o già annullata, viene restituito un errore HTTP 404.Formato API
DELETE /ttl/{EXPIRATION_ID}
{EXPIRATION_ID}
ttlId
della scadenza del set di dati che desideri annullare.Richiesta
La seguente richiesta annulla la scadenza di un set di dati 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}'
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 204 (nessun contenuto) e il campo status
attributo impostato su cancelled
.
Recuperare la cronologia dello stato di scadenza di un set di dati retrieve-expiration-history
Per cercare la cronologia dello stato di scadenza di un set di dati specifico, utilizza {DATASET_ID}
e include=history
parametro di query in una richiesta di ricerca. Il risultato include informazioni sulla creazione della scadenza del set di dati, su eventuali aggiornamenti applicati e sulla relativa cancellazione o esecuzione (se applicabile). È inoltre possibile utilizzare {DATASET_EXPIRATION_ID}
per recuperare la cronologia dello stato di scadenza del set di dati.
Formato API
GET /ttl/{DATASET_ID}?include=history
GET /ttl/{DATASET_EXPIRATION_ID}?include=history
{DATASET_ID}
{DATASET_EXPIRATION_ID}
ttlId
nella risposta.Richiesta
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}'
Risposta
Una risposta corretta restituisce i dettagli della scadenza del set di dati, con un history
array che fornisce i dettagli relativi ai status
, expiry
, updatedAt
, e updatedBy
attributi per ciascuno degli aggiornamenti registrati.
{
"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
, e updatedBy
attributi per la scadenza al momento dell’aggiornamento.Appendice
Parametri di query accettati query-params
La tabella seguente illustra i parametri di query disponibili quando elenco scadenze set di dati:
description
, displayName
, e datasetName
Tutti i parametri contengono la possibilità di cercare per valori LIKE. Ciò significa che puoi trovare le scadenze pianificate del set di dati denominate: "Name123", "Name183", "DisplayName1234" cercando la stringa "Name1".author
created_by
corrisponde alla stringa di ricerca. Se la stringa di ricerca inizia con LIKE
o NOT LIKE
, il resto viene trattato come un modello di ricerca SQL. In caso contrario, l’intera stringa di ricerca viene trattata come una stringa letterale che deve corrispondere esattamente all’intero contenuto di una created_by
campo.author=LIKE %john%
, author=John Q. Public
cancelledDate
/ cancelledToDate
/ cancelledFromDate
updatedDate=2022-01-01
completedDate
/ completedToDate
/ completedFromDate
completedToDate=2021-11-11-06:00
createdDate
Tieni presente che le date senza un’ora (come
2021-12-07
) rappresentano il datetime all'inizio di tale giorno. Pertanto, createdDate=2021-12-07
si riferisce a qualsiasi scadenza creata il 7 dicembre 2021, a partire da 00:00:00
da a 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
Il parametro query specifica l’ordinamento dei risultati restituiti dall’API. Utilizzarlo per disporre i dati in base a uno o più campi, in ordine crescente (ASC) o decrescente (DESC). Usa il prefisso + o - per indicare rispettivamente ASC, DESC. Sono accettati i seguenti valori: displayName
, description
, , datasetName
, id
, updatedAt
updatedBy
expiry
status
.-datasetName
orgId
x-gw-ims-org-id
e viene ignorato a meno che la richiesta non fornisca un token di servizio.orgId=885737B25DC460C50A49411B@AdobeOrg
page
page=3
sandboxName
x-sandbox-name
intestazione. Utilizzare sandboxName=*
per includere le scadenze dei set di dati da tutte le sandbox.sandboxName=dev1
search
Corrisponde a scadenze in cui la stringa specificata corrisponde esattamente all’ID scadenza o è contenuto in uno di questi campi:
- autore
- nome visualizzato
- descrizione
- Nome visualizzato
- nome set di dati
search=TESTING
status
status=pending,cancelled
ttlId
ttlID=SD-c8c75921-2416-4be7-9cfd-9ab01de66c5f
updatedDate
/ updatedToDate
/ updatedFromDate
createdDate
/ createdFromDate
/ createdToDate
, ma corrisponde all’ora di aggiornamento della scadenza di un set di dati invece dell’ora di creazione.Una scadenza viene considerata aggiornata a ogni modifica, anche quando viene creata, annullata o eseguita.
updatedDate=2022-01-01