Registra ordini di lavoro di eliminazione work-order-endpoint

Utilizza l'endpoint /workorder nell'API di igiene dei dati per creare, visualizzare e gestire gli ordini di lavoro di eliminazione dei record in Adobe Experience Platform. Gli ordini di lavoro consentono di controllare, monitorare e tenere traccia della rimozione dei dati tra i set di dati per mantenere la qualità dei dati e supportare gli standard di governance dei dati della tua organizzazione.

Introduzione

Prima di iniziare, consulta la panoramica per scoprire le intestazioni richieste, come leggere le chiamate API di esempio e dove trovare la relativa documentazione.

Quote e timeline di elaborazione quotas

Registra gli ordini di lavoro di eliminazione sono soggetti ai limiti di invio giornalieri e mensili degli identificatori, determinati dal diritto di licenza della tua organizzazione. Questi limiti si applicano sia alle richieste di cancellazione dei record basate su API che su UI.

Diritto invio mensile per prodotto quota-limits

La tabella seguente mostra i limiti di invio degli identificatori per prodotto e livello di adesione. Per ogni prodotto, il limite mensile è il minore tra due valori: un limite fisso di identificazione o una soglia basata su percentuale associata al volume di dati concesso in licenza.

Elaborazione dei timeline per l’invio degli identificatori sla-processing-timelines

Dopo la sottomissione, gli ordini di lavorazione di eliminazione dei record vengono messi in coda ed elaborati in base al livello di adesione.

Se l’organizzazione richiede limiti più elevati, contatta il rappresentante Adobe per una revisione dell’adesione.

Elenca gli ordini di lavoro di eliminazione record list

Recuperare un elenco impaginato di ordini di lavoro di eliminazione record per le operazioni di igiene dei dati nell'organizzazione. Filtra i risultati utilizzando i parametri di query. Ogni record dell'ordine di lavoro include il tipo di azione (ad esempio identity-delete), lo stato, il set di dati correlato, i dettagli utente e i metadati di controllo.

Formato API

GET /workorder

Nella tabella seguente vengono descritti i parametri di query disponibili per elencare gli ordini di lavorazione per l'eliminazione dei record.

Richiesta

La richiesta seguente recupera tutti gli ordini di lavoro di eliminazione record completati, limitati a due per pagina:

curl -X GET \
  "https://platform.adobe.io/data/core/hygiene/workorder?status=completed&limit=2" \
  -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 un elenco impaginato di ordini di lavoro di eliminazione record.

{
  "results": [
    {
      "workorderId": "DI-1729d091-b08b-47f4-923f-6a4af52c93ac",
      "orgId": "9C1F2AC143214567890ABCDE@AcmeOrg",
      "bundleId": "BN-4cfabf02-c22a-45ef-b21f-bd8c3d631f41",
      "action": "identity-delete",
      "createdAt": "2034-03-15T11:02:10.935Z",
      "updatedAt": "2034-03-15T11:10:10.938Z",
      "operationCount": 3,
      "targetServices": [
        "profile",
        "datalake",
        "identity"
      ],
      "status": "received",
      "createdBy": "a.stark@acme.com <a.stark@acme.com> BD8C3D631F41@acme.com",
      "datasetId": "a7b7c8f3a1b8457eaa5321ab",
      "datasetName": "Acme_Customer_Exports",
      "displayName": "Customer Identity Delete Request",
      "description": "Scheduled identity deletion for compliance"
    }
  ],
  "total": 1,
  "count": 1,
  "_links": {
    "next": {
      "href": "https://platform.adobe.io/workorder?page=1&limit=2",
      "templated": false
    },
    "page": {
      "href": "https://platform.adobe.io/workorder?limit={limit}&page={page}",
      "templated": true
    }
  }
}

Nella tabella seguente sono descritte le proprietà della risposta.

Crea un ordine di lavoro di eliminazione record create

Per eliminare i record associati a una o più identità da un singolo set di dati o da tutti i set di dati, effettuare una richiesta POST all'endpoint /workorder.

Gli ordini di lavoro vengono elaborati in modo asincrono e vengono visualizzati nell'elenco degli ordini di lavoro dopo l'invio.

Formato API

POST /workorder

Richiesta

La richiesta seguente elimina tutti i record associati a indirizzi e-mail specifici da un particolare set di dati.

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 '{
        "displayName": "Acme Loyalty - Customer Data Deletion",
        "description": "Delete all records associated with the specified email addresses from the Acme_Loyalty_2023 dataset.",
        "action": "delete_identity",
        "datasetId": "7eab61f3e5c34810a49a1ab3",
        "namespacesIdentities": [
          {
            "namespace": {
              "code": "email"
            },
            "IDs": [
              "alice.smith@acmecorp.com",
              "bob.jones@acmecorp.com",
              "charlie.brown@acmecorp.com"
            ]
          }
        ]
      }'

Nella tabella seguente vengono descritte le proprietà per la creazione di un ordine di lavoro di eliminazione record.

Risposta

In caso di esito positivo, la risposta restituisce i dettagli del nuovo ordine di lavoro di eliminazione record.

{
  "workorderId": "DI-95c40d52-6229-44e8-881b-fc7f072de63d",
  "orgId": "8B1F2AC143214567890ABCDE@AcmeOrg",
  "bundleId": "BN-c61bec61-5ce8-498f-a538-fb84b094adc6",
  "action": "identity-delete",
  "createdAt": "2035-06-02T09:21:00.000Z",
  "updatedAt": "2035-06-02T09:21:05.000Z",
  "operationCount": 1,
  "targetServices": [
    "profile",
    "datalake",
    "identity"
  ],
  "status": "received",
  "createdBy": "c.lannister@acme.com <c.lannister@acme.com> 7EAB61F3E5C34810A49A1AB3@acme.com",
  "datasetId": "7eab61f3e5c34810a49a1ab3",
  "datasetName": "Acme_Loyalty_2023",
  "displayName": "Loyalty Identity Delete Request",
  "description": "Schedule deletion for Acme loyalty program dataset"
}

Nella tabella seguente sono descritte le proprietà della risposta.

Recuperare i dettagli per un ordine di lavoro di eliminazione record specifico lookup

Recuperare le informazioni per un ordine di lavoro di eliminazione record specifico effettuando una richiesta GET a /workorder/{WORKORDER_ID}. La risposta include tipo di azione, stato, set di dati e informazioni utente associati e metadati di audit.

Formato API

GET /workorder/{WORKORDER_ID}

Richiesta

curl -X GET \
  https://platform.adobe.io/data/core/hygiene/workorder/DI-6fa98d52-7bd2-42a5-bf61-fb5c22ec9427 \
  -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’ordine di lavoro di eliminazione del record specificato.

{
  "workorderId": "DI-6fa98d52-7bd2-42a5-bf61-fb5c22ec9427",
  "orgId": "3C7F2AC143214567890ABCDE@AcmeOrg",
  "bundleId": "BN-dbe3ffad-cb0b-401f-91ae-01c189f8e7b2",
  "action": "identity-delete",
  "createdAt": "2037-01-21T08:25:45.119Z",
  "updatedAt": "2037-01-21T08:30:45.233Z",
  "operationCount": 3,
  "targetServices": [
    "ajo",
    "profile",
    "datalake",
    "identity"
  ],
  "status": "received",
  "createdBy": "g.baratheon@acme.com <g.baratheon@acme.com> C189F8E7B2@acme.com",
  "datasetId": "d2f1c8a4b8f747d0ba3521e2",
  "datasetName": "Acme_Marketing_Events",
  "displayName": "Marketing Identity Delete Request",
  "description": "Scheduled identity deletion for marketing compliance"
}

Nella tabella seguente sono descritte le proprietà della risposta.

Aggiornare un ordine di lavoro di eliminazione record

Aggiornare name e description per un ordine di lavoro di eliminazione record effettuando una richiesta PUT all'endpoint /workorder/{WORKORDER_ID}.

Formato API

PUT /workorder/{WORKORDER_ID}

Nella tabella seguente viene descritto il parametro per questa richiesta.

Richiesta

curl -X PUT \
  https://platform.adobe.io/data/core/hygiene/workorder/DI-893a6b1d-47c2-41e1-b3f1-2d7c2956aabb \
  -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 '{
        "name": "Updated Marketing Identity Delete Request",
        "description": "Updated deletion request for marketing data"
      }'

Nella tabella seguente sono descritte le proprietà che è possibile aggiornare.

Risposta

In caso di esito positivo, la risposta restituisce la richiesta dell’ordine di lavoro aggiornato.

{
  "workorderId": "DI-893a6b1d-47c2-41e1-b3f1-2d7c2956aabb",
  "orgId": "7D4E2AC143214567890ABCDE@AcmeOrg",
  "bundleId": "BN-12abcf45-32ea-45bc-9d1c-8e7b321cabc8",
  "action": "identity-delete",
  "createdAt": "2038-04-15T12:14:29.210Z",
  "updatedAt": "2038-04-15T12:30:29.442Z",
  "operationCount": 2,
  "targetServices": [
    "profile",
    "datalake"
  ],
  "status": "received",
  "createdBy": "b.tarth@acme.com <b.tarth@acme.com> 8E7B321CABC8@acme.com",
  "datasetId": "1a2b3c4d5e6f7890abcdef12",
  "datasetName": "Acme_Marketing_2024",
  "displayName": "Updated Marketing Identity Delete Request",
  "description": "Updated deletion request for marketing data",
  "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"
        }
    ]
}