Löschen von Arbeitsaufträgen aufzeichnen work-order-endpoint

Verwenden Sie den /workorder-Endpunkt in der Datenhygiene-API, um Arbeitsaufträge zum Löschen von Datensätzen in Adobe Experience Platform zu erstellen, anzuzeigen und zu verwalten. Mit Arbeitsaufträgen können Sie die Entfernung von Daten über Datensätze hinweg kontrollieren, überwachen und verfolgen, um die Datenqualität zu gewährleisten und die Data Governance-Standards Ihres Unternehmens zu unterstützen.

Erste Schritte

Bevor Sie beginnen, lesen Sie die Übersicht, um mehr über erforderliche Kopfzeilen zu erfahren, wie Sie Beispiel-API-Aufrufe lesen und wo Sie zugehörige Dokumentation finden.

Kontingente und Verarbeitungszeitpläne quotas

Arbeitsaufträge zum Löschen von Datensätzen unterliegen täglichen und monatlichen Obergrenzen für die Übermittlung von Identifikatoren, die durch die Lizenzberechtigung Ihres Unternehmens bestimmt werden. Diese Einschränkungen gelten sowohl für benutzeroberflächen- als auch für API-basierte Anfragen zum Löschen von Datensätzen.

Berechtigung zur monatlichen Übermittlung nach Produkt quota-limits

Die folgende Tabelle zeigt die Beschränkungen für die Übermittlung von Kennungen nach Produkt und Berechtigungsebene. Für jedes Produkt ist die monatliche Obergrenze der niedrigere von zwei Werten: eine feste Kennungsobergrenze oder ein prozentualer Schwellenwert, der an Ihr lizenziertes Datenvolumen gebunden ist.

Zeitleisten für die Übermittlung von Identifikatoren sla-processing-timelines

Nach der Übermittlung werden die Löschaufträge für Datensätze basierend auf Ihrer Berechtigungsstufe in die Warteschlange gestellt und verarbeitet.

Wenn für Ihr Unternehmen höhere Limits erforderlich sind, wenden Sie sich zur Überprüfung der Berechtigungen an den Adobe-Support.

Löschen von Arbeitsaufträgen auflisten list

Rufen Sie eine paginierte Liste von Datensatz-Löscharbeitsaufträgen für Datenhygienevorgänge in Ihrer Organisation ab. Filtern Sie Ergebnisse mithilfe von Abfrageparametern. Jeder Arbeitsauftragsdatensatz enthält den Aktionstyp (z. B. identity-delete), den Status, den zugehörigen Datensatz und Benutzerdetails sowie Auditmetadaten.

API-Format

GET /workorder

In der folgenden Tabelle werden die Abfrageparameter beschrieben, die für die Auflistung von Löschaufträgen für Datensätze verfügbar sind.

Anfrage

Mit der folgenden Anfrage werden alle abgeschlossenen Datensatz-Löscharbeitsaufträge abgerufen, die auf zwei pro Seite beschränkt sind:

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

Antwort

Eine erfolgreiche Antwort gibt eine paginierte Liste von Löscharbeitsaufträgen für Datensätze zurück.

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

In der folgenden Tabelle werden die Eigenschaften in der Antwort beschrieben.

Erstellen eines Arbeitsauftrags zum Löschen eines Datensatzes create

Um Datensätze, die mit einer oder mehreren Identitäten verknüpft sind, aus einem einzelnen Datensatz oder allen Datensätzen zu löschen, stellen Sie eine POST-Anfrage an den /workorder-Endpunkt.

Arbeitsaufträge werden asynchron verarbeitet und nach der Übermittlung in der Arbeitsauftragsliste angezeigt.

API-Format

POST /workorder

Anfrage

Die folgende Anfrage löscht alle Datensätze, die mit angegebenen E-Mail-Adressen aus einem bestimmten Datensatz verknüpft sind.

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

In der folgenden Tabelle werden die Eigenschaften zum Erstellen eines Arbeitsauftrags zum Löschen eines Datensatzes beschrieben.

Antwort

Eine erfolgreiche Antwort gibt die Details des neuen Datensatzlöscharbeitsauftrags zurück.

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

In der folgenden Tabelle werden die Eigenschaften in der Antwort beschrieben.

Abrufen von Details für einen bestimmten Datensatz zum Löschen von Arbeitsaufträgen lookup

Rufen Sie Informationen zu einem bestimmten Datensatz-Löscharbeitsauftrag ab, indem Sie eine GET-Anfrage an /workorder/{WORKORDER_ID} stellen. Die Antwort enthält Aktionstyp, Status, verknüpfte Datensatz- und Benutzerinformationen sowie Audit-Metadaten.

API-Format

GET /workorder/{WORKORDER_ID}

Anfrage

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

Antwort

Eine erfolgreiche Antwort gibt die Details des angegebenen Datensatzlöscharbeitsauftrags zurück.

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

In der folgenden Tabelle werden die Eigenschaften in der Antwort beschrieben.

Aktualisieren eines Datensatzlöscharbeitsauftrags

Aktualisieren Sie die name und description für einen Datensatz-Löscharbeitsauftrag, indem Sie eine PUT-Anfrage an den /workorder/{WORKORDER_ID}-Endpunkt stellen.

API-Format

PUT /workorder/{WORKORDER_ID}

Die folgende Tabelle beschreibt den Parameter für diese Anfrage.

Anfrage

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

In der folgenden Tabelle werden die Eigenschaften beschrieben, die Sie aktualisieren können.

Antwort

Eine erfolgreiche Antwort gibt die aktualisierte Arbeitsauftragsanfrage zurück.

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