[Beta]{class="badge informative"} [Beta]{class="badge informative"}
Endpoint ordine di lavoro work-order-endpoint
Il /workorder
L’endpoint nell’API di igiene dei dati consente di gestire in modo programmatico le richieste di eliminazione dei record in Adobe Experience Platform.
Introduzione
L’endpoint utilizzato in questa guida fa parte dell’API di igiene dei dati. Prima di continuare, controlla panoramica per i collegamenti alla documentazione correlata, una guida per la lettura delle chiamate API di esempio di questo documento e informazioni importanti sulle intestazioni richieste necessarie per effettuare correttamente le chiamate a qualsiasi API di Experienci Platform.
Creare una richiesta di eliminazione record create
Per eliminare una o più identità da un singolo set di dati o da tutti i set di dati, effettua una richiesta POST al /workorder
endpoint.
Un singolo registrare la richiesta di eliminazione tramite l’interfaccia utente ti consente di inviare 10.000 ID contemporaneamente. Il metodo API per eliminare i record consente di inviare contemporaneamente 100.000 ID.
È consigliabile inviare il maggior numero possibile di ID per richiesta, fino al limite dell’ID. Quando intendi eliminare un volume elevato di ID, devi evitare di inviare un volume basso o un singolo ID per richiesta di cancellazione del record.
Formato API
POST /workorder
Richiesta
A seconda del valore del datasetId
fornito nel payload della richiesta, la chiamata API eliminerà le identità da tutti i set di dati o da un singolo set di dati specificato. La richiesta seguente elimina tre identità da un set di dati specifico.
curl -X POST \
https://platform.adobe.io/data/core/hygiene/workorder \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'Content-Type: application/json' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"action": "delete_identity",
"datasetId": "c48b51623ec641a2949d339bad69cb15",
"displayName": "Example Record Delete Request",
"description": "Cleanup identities required by Jira request 12345.",
"identities": [
{
"namespace": {
"code": "email"
},
"id": "poul.anderson@example.com"
},
{
"namespace": {
"code": "email"
},
"id": "cordwainer.smith@gmail.com"
},
{
"namespace": {
"code": "email"
},
"id": "cyril.kornbluth@yahoo.com"
}
]
}'
action
delete_identity
per le eliminazioni di record.datasetId
ALL
.Se specifichi un singolo set di dati, lo schema Experience Data Model (XDM) associato al set di dati deve avere un’identità primaria definita. Se il set di dati non ha un’identità primaria, per poter essere modificato da una richiesta del ciclo di vita dei dati deve disporre di una mappa di identità.
Se esiste una mappa di identità, questa sarà presente come campo di livello principale denominato
identityMap
.Tieni presente che una riga di set di dati può avere molte identità nella relativa mappa di identità, ma solo una può essere contrassegnata come principale.
"primary": true
deve essere incluso per forzare id
affinché corrisponda a un’identità primaria.displayName
description
identities
Matrice contenente le identità di almeno un utente di cui desideri eliminare le informazioni. Ogni identità è composta da un spazio dei nomi delle identità e un valore:
namespace
: contiene una singola proprietà stringa,code
, che rappresenta lo spazio dei nomi dell’identità.id
: valore di identità.
Se datasetId
specifica un singolo set di dati, ogni entità in identities
deve utilizzare lo stesso spazio dei nomi dell’identità primaria dello schema.
Se datasetId
è impostato su ALL
, il identities
l’array non è vincolato a un singolo spazio dei nomi poiché ogni set di dati potrebbe essere diverso. Tuttavia, le richieste di sono ancora vincolate agli spazi dei nomi disponibili per la tua organizzazione, come segnalato da Servizio identità.
Risposta
In caso di esito positivo, la risposta restituisce i dettagli dell’eliminazione del record.
{
"workorderId": "a15345b8-a2d6-4d6f-b33c-5b593e86439a",
"orgId": "{ORG_ID}",
"bundleId": "BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd",
"action": "identity-delete",
"createdAt": "2022-07-21T18:05:28.316029Z",
"updatedAt": "2022-07-21T17:59:43.217801Z",
"status": "received",
"createdBy": "{USER_ID}",
"datasetId": "c48b51623ec641a2949d339bad69cb15",
"displayName": "Example Record Delete Request",
"description": "Cleanup identities required by Jira request 12345."
}
workorderId
orgId
bundleId
action
identity-delete
.createdAt
updatedAt
status
createdBy
datasetId
ALL
.Recuperare lo stato di un'eliminazione record lookup
Dopo di te creare una richiesta di eliminazione record, puoi controllarne lo stato utilizzando una richiesta GET.
Formato API
GET /workorder/{WORK_ORDER_ID}
{WORK_ORDER_ID}
workorderId
dell’eliminazione record che stai cercando.Richiesta
curl -X GET \
https://platform.adobe.io/data/core/hygiene/workorder/BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd \
-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 dell’operazione di eliminazione, compreso lo stato corrente.
{
"workorderId": "a15345b8-a2d6-4d6f-b33c-5b593e86439a",
"orgId": "{ORG_ID}",
"bundleId": "BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd",
"action": "identity-delete",
"createdAt": "2022-07-21T18:05:28.316029Z",
"updatedAt": "2022-07-21T17:59:43.217801Z",
"status": "received",
"createdBy": "{USER_ID}",
"datasetId": "c48b51623ec641a2949d339bad69cb15",
"displayName": "Example Record Delete Request",
"description": "Cleanup identities required by Jira request 12345.",
"productStatusDetails": [
{
"productName": "Data Management",
"productStatus": "success",
"createdAt": "2022-08-08T16:51:31.535872Z"
},
{
"productName": "Identity Service",
"productStatus": "success",
"createdAt": "2022-08-08T16:43:46.331150Z"
},
{
"productName": "Profile Service",
"productStatus": "waiting",
"createdAt": "2022-08-08T16:37:13.443481Z"
}
]
}
workorderId
orgId
bundleId
action
identity-delete
.createdAt
updatedAt
status
createdBy
datasetId
ALL
.productStatusDetails
Array che elenca lo stato corrente dei processi a valle correlati alla richiesta. Ogni oggetto array contiene le seguenti proprietà:
productName
: nome del servizio downstream.productStatus
: stato di elaborazione corrente della richiesta dal servizio a valle.createdAt
: marca temporale di quando il servizio ha pubblicato lo stato più recente.
Aggiornare una richiesta di eliminazione record
È possibile aggiornare displayName
e description
per eliminare un record effettuando una richiesta PUT.
Formato API
PUT /workorder{WORK_ORDER_ID}
{WORK_ORDER_ID}
workorderId
dell’eliminazione record che stai cercando.Richiesta
curl -X PUT \
https://platform.adobe.io/data/core/hygiene/workorder/BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd \
-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}' \
-d '{
"displayName" : "Update - displayName",
"description" : "Update - description"
}'
displayName
description
Risposta
In caso di esito positivo, la risposta restituisce i dettagli dell’eliminazione del record.
{
"workorderId": "DI-61828416-963a-463f-91c1-dbc4d0ddbd43",
"orgId": "{ORG_ID}",
"bundleId": "BN-aacacc09-d10c-48c5-a64c-2ced96a78fca",
"action": "identity-delete",
"createdAt": "2024-06-12T20:02:49.398448Z",
"updatedAt": "2024-06-13T21:35:01.944749Z",
"operationCount": 1,
"status": "ingested",
"createdBy": "{USER_ID}",
"datasetId": "666950e6b7e2022c9e7d7a33",
"datasetName": "Acme_Dataset_E2E_Identity_Map_Schema_5_1718178022379",
"displayName": "Updated Display Name",
"description": "Updated Description",
"productStatusDetails": [
{
"productName": "Data Management",
"productStatus": "waiting",
"createdAt": "2024-06-12T20:11:18.447747Z"
},
{
"productName": "Identity Service",
"productStatus": "success",
"createdAt": "2024-06-12T20:36:09.020832Z"
},
{
"productName": "Profile Service",
"productStatus": "waiting",
"createdAt": "2024-06-12T20:11:18.447747Z"
},
{
"productName": "Journey Orchestrator",
"productStatus": "success",
"createdAt": "2024-06-12T20:12:19.843199Z"
}
]
}
workorderId
orgId
bundleId
action
identity-delete
.createdAt
updatedAt
status
createdBy
datasetId
ALL
.productStatusDetails
Array che elenca lo stato corrente dei processi a valle correlati alla richiesta. Ogni oggetto array contiene le seguenti proprietà:
productName
: nome del servizio downstream.productStatus
: stato di elaborazione corrente della richiesta dal servizio a valle.createdAt
: marca temporale di quando il servizio ha pubblicato lo stato più recente.