Registrar órdenes de trabajo eliminadas work-order-endpoint

Use el extremo /workorder en la API de higiene de datos para crear, ver y administrar órdenes de trabajo de eliminación de registros en Adobe Experience Platform. Las órdenes de trabajo le permiten controlar, monitorizar y rastrear la eliminación de datos en conjuntos de datos para ayudarle a mantener la calidad de los datos y admitir los estándares de gobernanza de datos de su organización.

Introducción

Antes de comenzar, consulte la descripción general para obtener información sobre los encabezados necesarios, cómo leer llamadas de API de ejemplo y dónde encontrar documentación relacionada.

Cuotas y plazos de procesamiento quotas

Las órdenes de trabajo de eliminación de registros están sujetas a límites de envío de identificadores diarios y mensuales, determinados por el derecho de licencia de su organización. Estos límites se aplican a las solicitudes de eliminación de registros basadas en la IU y la API.

Derecho de envío mensual por producto quota-limits

La siguiente tabla muestra los límites de envío de identificadores por producto y nivel de asignación de derechos. Para cada producto, el límite mensual es el menor de dos valores: un límite de identificador fijo o un umbral basado en porcentajes y vinculado al volumen de datos con licencia. En la práctica, la mayoría de las organizaciones tienen límites mensuales más bajos en función de su audiencia direccionable real o de los derechos de fila de Adobe Customer Journey Analytics.

Tiempos de procesamiento para los envíos de identificadores sla-processing-timelines

Después del envío, las órdenes de trabajo de eliminación de registros se ponen en cola y se procesan según su nivel de asignación de derechos.

Si su organización requiere límites más altos, póngase en contacto con su representante de Adobe para obtener una revisión de las autorizaciones.

Lista de órdenes de trabajo eliminadas de registro list

Recupere una lista paginada de órdenes de trabajo de eliminación de registros para operaciones de higiene de datos en su organización. Filtre los resultados mediante parámetros de consulta. Cada registro de orden de trabajo incluye el tipo de acción (como identity-delete), el estado, el conjunto de datos relacionado, los detalles del usuario y los metadatos de auditoría.

Formato de API

GET /workorder

En la tabla siguiente se describen los parámetros de consulta disponibles para enumerar las órdenes de trabajo de eliminación de registros.

Solicitud

La siguiente solicitud recupera todas las órdenes de trabajo de eliminación de registros completadas, con un límite de dos por página:

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

Respuesta

Una respuesta correcta devuelve una lista paginada de órdenes de trabajo de eliminación de registros.

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

En la tabla siguiente se describen las propiedades de la respuesta.

Crear una orden de trabajo de eliminación de registros create

Para eliminar registros asociados con una o más identidades de un único conjunto de datos, varios conjuntos de datos o todos ellos, realice una petición POST al extremo /workorder.

Las órdenes de trabajo se procesan de forma asíncrona y aparecen en la lista de órdenes de trabajo después del envío. Las opciones de varios conjuntos de datos y solo perfiles (servicios segmentados) generalmente están disponibles para todos los clientes a partir de la versión de Experience Platform de marzo de 2026.

Formato de API

POST /workorder

Formatos de carga útil de identidad (namespacesIdentities o identities)

El cuerpo de la solicitud debe incluir exactamente uno de los siguientes elementos.

Si envía ambas propiedades, ninguna propiedad o proporciona una matriz vacía para la propiedad que incluye, la API devolverá HTTP 400 (Solicitud incorrecta) con uno de estos mensajes:

Solicitud

La siguiente solicitud elimina todos los registros asociados con las direcciones de correo electrónico especificadas de un conjunto de datos concreto. Utiliza el formato namespacesIdentities recomendado.

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

En la tabla siguiente se describen las propiedades para crear una orden de trabajo de eliminación de registros.

Respuesta

Una respuesta correcta devuelve los detalles de la nueva orden de trabajo de eliminación de registros.

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

En la tabla siguiente se describen las propiedades de la respuesta.

El valor de la respuesta targetServices se hace eco de su solicitud o muestra el conjunto predeterminado completo cuando se omite (consulte la tabla de respuestas anterior).

Conjunto de datos múltiple y solo perfil (API) multi-dataset-profile-only

Las siguientes opciones están disponibles a través de la API solamente y no son compatibles con la IU de higiene de los datos. Controlan qué conjuntos de datos y qué servicios procesan la eliminación, lo que permite los envíos de conjuntos de datos múltiples y las solicitudes de servicio de destino solo de perfil.

La siguiente tabla resume cómo cambian el cuerpo y el comportamiento de la solicitud para cada opción.

Solicitudes de varios conjuntos de datos

El campo datasetId está dividido en comas: use un solo identificador (el mismo comportamiento que antes), una lista de identificadores separados por comas o el literal ALL. Para eliminar identidades de varios conjuntos de datos específicos en un solo orden de trabajo, proporcione una lista separada por comas:

"datasetId": "6707eb36eef4d42ab86d9fbe,6643f00c16ddf51767fcf780"

A continuación, las identidades se eliminan de cada uno de los conjuntos de datos enumerados. Las solicitudes de un solo conjunto de datos funcionan como siempre; use ALL para segmentar todos los conjuntos de datos. El valor debe ser exactamente uno de: ALL, un solo ID de conjunto de datos o dos o más ID de conjunto de datos separados por comas (sin combinar ALL con ID específicos).

Solo perfil (servicios segmentados)

Para quitar únicamente la identidad y los datos relacionados con el perfil sin modificar el lago de datos, incluya targetServices con exactamente estos tres valores en cualquier orden: identity, profile y ajo. Se incluyen explícitamente ID, Perfil y AJO; se excluye el lago de datos. En este modo, datasetId debe ser ALL (el caso de uso es la eliminación completa del perfil, no fragmentos por conjunto de datos).

En el siguiente ejemplo se crea una orden de trabajo de eliminación de registros de sólo perfil:

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

Las respuestas correctas para solicitudes de varios conjuntos de datos o solo de perfil siguen la misma forma que otras respuestas de orden de trabajo. Los valores devueltos datasetId y targetServices reflejan los valores de la solicitud (o la lista predeterminada completa cuando se omite targetServices), para que pueda confirmar lo que se envió.

Conversión de listas de ID a JSON para solicitudes de eliminación de registros (#convert-id-lists-to-json-for-record-delete-requests)

Use scripts de conversión para generar las cargas JSON necesarias para el extremo /workorder cuando los identificadores estén en archivos CSV, TSV o TXT. Este método es especialmente útil cuando se trabaja con archivos de datos existentes. Para obtener instrucciones y scripts listos para usar, consulte el repositorio de GitHub csv para higiene de datos.

Los scripts muestran el formato identities: un id por objeto con un namespace. La API acepta este formato tal cual; puede enviar el JSON generado directamente en el cuerpo del POST a /workorder sin ninguna conversión. El formato recomendado es namespacesIdentities; consulte Crear una orden de trabajo de eliminación de registros y Formato de carga de identidad.

Generar cargas JSON

Los siguientes ejemplos de scripts de bash muestran cómo ejecutar los scripts de conversión en Python o 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

En la tabla siguiente se describen los parámetros de los scripts de bash.

El ejemplo siguiente muestra una carga útil JSON correcta convertida desde un archivo CSV, TSV o TXT. Contiene registros asociados al área de nombres especificada y se utiliza para eliminar registros identificados por direcciones de correo electrónico.

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

En la tabla siguiente se describen las propiedades de la carga útil JSON.

Enviar los datos JSON generados al extremo /workorder

La salida del script usa el formato identities, que la API acepta tal cual. Utilice la carga útil JSON convertida como el cuerpo de la solicitud (-d) cuando envíe su solicitud POST de curl al extremo /workorder. Para ver las opciones de solicitud y las reglas de validación completas, consulte Crear una orden de trabajo de eliminación de registros.

Recuperar detalles de una orden de trabajo de eliminación de registros específica lookup

Recupere información de una orden de trabajo de eliminación de registros específica realizando una petición GET a /workorder/{WORKORDER_ID}. La respuesta incluye el tipo de acción, el estado, el conjunto de datos asociado, la información de usuario y los metadatos de auditoría.

Formato de API

GET /workorder/{WORKORDER_ID}

Solicitud

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

Respuesta

Una respuesta correcta devuelve los detalles de la orden de trabajo de eliminación de registros especificada.

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

En la tabla siguiente se describen las propiedades de la respuesta.

Actualizar una orden de trabajo de eliminación de registros update

Actualice name y description para una orden de trabajo de eliminación de registros realizando una petición PUT al extremo /workorder/{WORKORDER_ID}.

Formato de API

PUT /workorder/{WORKORDER_ID}

En la tabla siguiente se describe el parámetro de esta solicitud.

Solicitud

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

En la tabla siguiente se describen las propiedades que se pueden actualizar.

Respuesta

Una respuesta correcta devuelve la solicitud de orden de trabajo actualizada.

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