Ordres de travail de suppression d'enregistrements work-order-endpoint

Utilisez le point d’entrée /workorder dans l’API Data Hygiene pour créer, afficher et gérer des ordres de travail de suppression d’enregistrements dans Adobe Experience Platform. Les ordres de travail vous permettent de contrôler, de surveiller et de suivre la suppression des données dans les jeux de données afin de vous aider à maintenir la qualité des données et à respecter les normes de gouvernance des données de votre entreprise.

Prise en main

Avant de commencer, consultez la présentation pour en savoir plus sur les en-têtes requis, sur la lecture d’exemples d’appels API et sur l’emplacement de la documentation connexe.

Quotas et délais de traitement quotas

Les ordres de travail de suppression d’enregistrements sont soumis à des limites d’envoi d’identifiants quotidiennes et mensuelles, déterminées par les droits de licence de votre entreprise. Ces limites s’appliquent à la fois aux requêtes de suppression d’enregistrements basées sur l’interface utilisateur et les API.

Droit d’envoi mensuel par produit quota-limits

Le tableau suivant présente les limites d’envoi des identifiants par produit et niveau de droit. Pour chaque produit, la limite mensuelle est la moins élevée des deux valeurs suivantes : un plafond d’identifiant fixe ou un seuil basé sur un pourcentage lié à votre volume de données sous licence. En pratique, la plupart des entreprises ont des limites mensuelles inférieures en fonction de leur audience adressable réelle ou de leurs droits de ligne Adobe Customer Journey Analytics.

Chronologies de traitement des envois d’identifiants sla-processing-timelines

Après l’envoi, les ordres de travail de suppression d’enregistrements sont mis en file d’attente et traités en fonction de votre niveau de droit.

Si votre organisation requiert des limites plus élevées, contactez votre représentant Adobe pour une révision des droits.

Liste des ordres de travail de suppression d'enregistrements list

Récupérez une liste paginée des ordres de travail de suppression d’enregistrements pour les opérations d’hygiène des données dans votre organisation. Filtrez les résultats à l’aide des paramètres de requête. Chaque enregistrement d’ordre de travail inclut le type d’action (tel que identity-delete), le statut, les détails du jeu de données et de l’utilisateur associés, ainsi que les métadonnées d’audit.

Format d’API

GET /workorder

Le tableau suivant décrit les paramètres de requête disponibles pour répertorier les ordres de travail de suppression d'enregistrements.

Requête

La requête suivante récupère tous les ordres de travail de suppression d’enregistrements terminés, limités à deux par page :

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

Réponse

Une réponse réussie renvoie une liste paginée d’ordres de travail de suppression d’enregistrements.

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

Le tableau suivant décrit les propriétés de la réponse.

Créer un ordre de travail de suppression d'enregistrement create

Pour supprimer des enregistrements associés à une ou plusieurs identités d’un seul jeu de données, de plusieurs jeux de données ou de tous les jeux de données, envoyez une requête POST au point d’entrée /workorder.

Les ordres de travail sont traités de manière asynchrone et apparaissent dans la liste d’ordres de travail après envoi. Les options à jeux de données multiples et de profil uniquement (services ciblés) sont généralement disponibles pour tous les clients à compter de la version de mars 2026 d’Experience Platform.

Format d’API

POST /workorder

Formats des payload d’identité (namespacesIdentities ou identities)

Le corps de la requête doit inclure exactement l’un des éléments suivants.

Si vous envoyez les deux propriétés, aucune propriété ou fournissez un tableau vide pour la propriété que vous incluez, l’API renvoie HTTP 400 (Bad Request) avec l’un des messages suivants :

Requête

La requête suivante supprime tous les enregistrements associés aux adresses e-mail spécifiées d’un jeu de données spécifique. Il utilise le format de namespacesIdentities recommandé.

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

Le tableau suivant décrit les propriétés de création d'un ordre de travail de suppression d'enregistrement.

Réponse

Une réponse réussie renvoie les détails du nouvel ordre de travail de suppression d’enregistrement.

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

Le tableau suivant décrit les propriétés de la réponse.

La valeur du targetServices de réponse fait écho à votre requête ou affiche le jeu par défaut complet lorsqu’elle est omise (voir le tableau de réponse ci-dessus).

Jeu de données multiple et profil uniquement (API) multi-dataset-profile-only

Les options suivantes sont disponibles via l’API uniquement et ne sont pas prises en charge dans l’interface utilisateur Data Hygiene. Ils contrôlent quels jeux de données et quels services traitent la suppression, ce qui permet d’envoyer plusieurs jeux de données et de gérer des demandes de services ciblées spécifiques au profil.

Le tableau suivant résume la manière dont le corps de la requête et le comportement changent pour chaque option.

Requêtes de jeux de données multiples

Le champ datasetId est fractionné par des virgules : utilisez un identifiant unique (même comportement que précédemment), une liste d’identifiants séparés par des virgules ou la ALL littérale. Pour supprimer des identités de plusieurs jeux de données spécifiques dans un ordre de travail, fournissez une liste séparée par des virgules :

"datasetId": "6707eb36eef4d42ab86d9fbe,6643f00c16ddf51767fcf780"

Les identités sont ensuite supprimées de chacun des jeux de données répertoriés. Les requêtes de jeu de données unique fonctionnent comme toujours. Utilisez des ALL pour cibler chaque jeu de données. La valeur doit être exactement l’une des suivantes : ALL, un identifiant de jeu de données unique ou plusieurs identifiants de jeu de données séparés par des virgules (pas de combinaison de ALL avec des identifiants spécifiques).

Profil uniquement (services ciblés)

Pour supprimer uniquement les données d’identité et de profil tout en laissant le lac de données intact, incluez les targetServices avec exactement ces trois valeurs dans n’importe quel ordre : identity, profile et ajo. L’identité, le profil et AJO sont explicitement inclus ; le lac de données est exclu. Dans ce mode, les datasetId doivent être ALL (le cas d’utilisation est la suppression complète de profil, et non les fragments par jeu de données).

L’exemple suivant crée un ordre de travail de suppression d’enregistrements de profil uniquement :

curl -X POST \
  "https://platform.adobe.io/data/core/hygiene/workorder" \
  -H 'Content-Type: application/json' \
  -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 'x-sandbox-id: {SANDBOX_ID}' \
  -d '{
    "action": "delete_identity",
    "datasetId": "ALL",
    "displayName": "Profile-only delete for specified identity",
    "description": "Delete identity, profile, and AJO data only; datalake unchanged.",
    "targetServices": ["identity", "profile", "ajo"],
    "namespacesIdentities": [
      {
        "namespace": { "code": "email" },
        "ids": ["user@example.com"]
      }
    ]
  }'

Les réponses réussies pour des requêtes portant sur plusieurs jeux de données ou des profils uniquement suivent la même forme que les autres réponses d’ordre de travail. Les datasetId et targetServices renvoyés reflètent les valeurs de la demande (ou la liste complète par défaut lorsque targetServices est omis), afin que vous puissiez confirmer ce qui a été envoyé.

Convertir les listes d’ID en JSON pour les requêtes de suppression d’enregistrements (#convert-id-lists-to-json-for-record-delete-requests)

Utilisez des scripts de conversion pour produire les payloads JSON requises pour le point d’entrée /workorder lorsque vos identifiants se trouvent dans des fichiers CSV, TSV ou TXT. Cette approche est particulièrement utile lorsque vous travaillez avec des fichiers de données existants. Pour obtenir des scripts et des instructions prêts à l’emploi, reportez-vous au référentiel GitHub csv-to-data-hygiene.

Les scripts génèrent le format identities : un id par objet avec un namespace. L’API accepte ce format en l’état. Vous pouvez envoyer le fichier JSON généré directement dans le corps de la requête POST à /workorder sans conversion. Le format recommandé est le namespacesIdentities. Voir Création d’un ordre de travail de suppression d’enregistrement et Format de payload d’identité.

Générer des payloads JSON

Les exemples de script bash suivants montrent comment exécuter les scripts de conversion en Python ou Ruby :

#!/usr/bin/env bash

rm -rf ./output && mkdir output
for NAME in UTF8 CSV TSV TXT XYZ big; do
  ./csv-to-DI-payload.py sample/sample-$NAME.* \
      --verbose \
      --column 2 \
      --namespace email \
      --dataset-id 66f4161cc19b0f2aef3edf10 \
      --description 'a simple sample' \
      --output-dir output
  echo Checking output/sample-$NAME-*.json against expect/sample-$NAME-*.json
  diff <(cat output/sample-$NAME-*.json) <(cat expect/sample-$NAME-*.json) || echo Unexpected output in sample-$NAME-*.*
done

#!/usr/bin/env bash

rm -rf ./output && mkdir output
for NAME in UTF8 CSV TSV TXT XYZ big; do
  ./csv-to-DI-payload.rb sample/sample-$NAME.* \
      --verbose \
      --column 2 \
      --namespace email \
      --dataset-id 66f4161cc19b0f2aef3edf10 \
      --description 'a simple sample' \
      --output-dir output
  echo Checking output/sample-$NAME-*.json against expect/sample-$NAME-*.json
  diff <(cat output/sample-$NAME-*.json) <(cat expect/sample-$NAME-*.json) || echo Unexpected output in sample-$NAME-*.*
done

Le tableau ci-dessous décrit les paramètres des scripts bash.

L’exemple ci-dessous montre une payload JSON réussie convertie à partir d’un fichier CSV, TSV ou TXT. Contient des enregistrements associés à l'espace de noms spécifié et sert à supprimer les enregistrements identifiés par les adresses e-mail.

{
  "action": "delete_identity",
  "datasetId": "66f4161cc19b0f2aef3edf10",
  "displayName": "output/sample-big-001.json",
  "description": "a simple sample",
  "identities": [
    {
      "namespace": {
        "code": "email"
      },
      "id": "1"
    },
    {
      "namespace": {
        "code": "email"
      },
      "id": "2"
    }
  ]
}

Le tableau suivant décrit les propriétés de la payload JSON.

Envoyer les données JSON générées au point d’entrée /workorder

La sortie de script utilise le format identities, que l’API accepte en l’état. Utilisez la payload JSON convertie comme corps de requête (-d) lorsque vous envoyez votre requête POST curl au point d’entrée /workorder. Pour connaître les options de demande complète et les règles de validation, voir Création d’un ordre de travail de suppression d’enregistrement.

Récupérer les détails d’un ordre de travail de suppression d’enregistrement spécifique lookup

Récupérez les informations relatives à un ordre de travail de suppression d’enregistrement spécifique en adressant une requête GET à /workorder/{WORKORDER_ID}. La réponse inclut le type d’action, le statut, les informations associées relatives au jeu de données et à l’utilisateur, ainsi que les métadonnées d’audit.

Format d’API

GET /workorder/{WORKORDER_ID}

Requête

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

Réponse

Une réponse réussie renvoie les détails de l'ordre de travail de suppression d'enregistrement spécifié.

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

Le tableau suivant décrit les propriétés de la réponse.

Mettre à jour un ordre de travail de suppression d'enregistrement update

Mettez à jour la name et la description d’un ordre de travail de suppression d’enregistrement en effectuant une requête PUT au point d’entrée /workorder/{WORKORDER_ID}.

Format d’API

PUT /workorder/{WORKORDER_ID}

Le tableau suivant décrit le paramètre pour cette requête.

Requête

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

Le tableau suivant décrit les propriétés que vous pouvez mettre à jour.

Réponse

Une réponse réussie renvoie la demande d’ordre de travail mise à jour.

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