文档Experience Platform高级数据生命周期管理指南

记录删除工作单 work-order-endpoint

Last update: Fri Aug 08 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • 开发人员

使用数据卫生API中的/workorder端点在Adobe Experience Platform中创建、查看和管理记录删除工作单。 您可以跨数据集控制、监控和跟踪数据删除，以帮助您保持数据质量并支持组织的数据治理标准。

IMPORTANT
记录删除工作单用于数据清理、匿名数据删除或数据最小化。 请勿根据隐私法规（如GDPR）对数据主体权限请求使用记录删除工作单。 ​对于合规性用例，请使用Adobe Experience Platform Privacy Service。

快速入门

在开始之前，请参阅概述以了解所需的标头、如何读取示例API调用以及在何处查找相关文档。

配额和处理时间线 quotas

记录删除工作单受每日和每月标识符提交限制的约束，具体由贵组织的许可证权利文件决定。 这些限制同时适用于基于UI和基于API的记录删除请求。

NOTE
您每天最多可以提交​ 1,000,000个标识符，但前提是剩余的每月配额允许这样做。 如果每月上限不到100万，则每日提交内容不能超过该上限。

按产品显示的每月提交权利 quota-limits

下表显示了按产品和权利级别划分的标识符提交限制。 对于每个产品，每月上限是两个值中的较小值：固定标识符上限或与许可数据量绑定的基于百分比的阈值。

产品
权利描述
每月上限（以较小者为准）
Real-Time CDP或Adobe Journey Optimizer
不带Privacy and Security Shield或Healthcare Shield附加组件
2,000,000个标识符或可寻址受众的5%
Real-Time CDP或Adobe Journey Optimizer
带有Privacy and Security Shield或Healthcare Shield附加组件
15,000,000个标识符或10%的可寻址受众
Customer Journey Analytics
不带Privacy and Security Shield或Healthcare Shield附加组件
2,000,000个标识符或每百万CJA权利行有100个标识符
Customer Journey Analytics
带有Privacy and Security Shield或Healthcare Shield附加组件
15,000,000个标识符或每百万CJA权利行有200个标识符
NOTE
根据大多数组织的实际可寻址受众或CJA行授权，其每月限制较低。
NOTE
配额在每个日历月的第一天重置。 未使用的配额​ 未 ​延期。
NOTE
配额使用量基于贵组织为​ 提交的标识符 ​授予的每月授权。 系统护栏不强制执行配额，但可以监视和审查配额。
记录删除工作单产能是​ 共享服务。 您的每月上限反映了Real-Time CDP、Adobe Journey Optimizer、Customer Journey Analytics和任何适用的Shield加载项中的最高权限。

处理标识符提交的时间表 sla-processing-timelines

提交后，系统会根据您的权利级别对记录删除工作单进行排队和处理。

产品和权利描述
队列持续时间
最长处理时间(SLA)
不带Privacy and Security Shield或Healthcare Shield附加组件
长达15天
30 天
带有Privacy and Security Shield或Healthcare Shield附加组件
通常为24小时
15 天

如果贵组织需要更高的限制，请联系您的Adobe代表进行权利审查。

TIP
要检查您当前的配额使用情况或权利层，请参阅配额参考指南。

列表记录删除工作单 list

检索组织内数据卫生操作的分页记录删除工作单列表。 使用查询参数筛选结果。 每个工作单记录包括操作类型（如identity-delete）、状态、相关数据集和用户详细信息，以及审核元数据。

API格式

GET /workorder

下表描述了可用于列出记录删除工作单的查询参数。

查询参数
描述
search
以下字段中的部分匹配（通配符搜索）不区分大小写：author、displayName、description或datasetName。 此外，还要与确切的到期ID匹配。
type
按工作单类型（如identity-delete）筛选结果。
status
以逗号分隔的工作单状态列表。 状态值区分大小写。
枚举： received，validated，submitted，ingested，completed，failed
author
查找最近更新工作单的人员（或原始创建者）。 接受文本或SQL模式。
displayName
工作单显示名称不区分大小写的匹配。
description
对工单说明进行不区分大小写的匹配。
workorderId
与工单ID完全匹配。
sandboxName
与请求中使用的沙盒名称完全匹配，或使用*包括所有沙盒。
fromDate
按在此日期或之后创建的工作单进行筛选。 需要设置toDate。
toDate
按在此日期或之前创建的工作单进行筛选。 需要设置fromDate。
filterDate
仅返回在此日期创建、更新或更改状态的工作单。
page
要返回的页面索引（从0开始）。
limit
每页最大结果数（1-100，默认值： 25）。
orderBy
结果的排序顺序。 使用+或-前缀进行升序/降序。 示例：orderBy=-datasetName。
properties
每个结果要包含的其他字段的逗号分隔列表。 可选。

请求

以下请求检索所有已完成的记录删除工作单，每页最多检索两个工作单：

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

响应

成功的响应将返回记录删除工作单的分页列表。

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

下表描述了响应中的属性。

属性
描述
results
删除工单对象的记录数组。 每个对象都包含以下字段。
workorderId
记录删除工作单的唯一标识符。
orgId
您的独特组织标识符。
bundleId
包含此记录删除工作单的捆绑的唯一标识符。 捆绑功能允许下游服务将多个删除订单分组在一起进行处理。
action
工作单中请求的操作类型。
createdAt
创建工作单时的时间戳。
updatedAt
上次更新工作单的时间戳。
operationCount
工作单中包含的工序数。
targetServices
工作单的目标服务列表。
status
工作单的当前状态。 可能的值为： received、validated、submitted、ingested、completed和failed。
createdBy
创建工作单的用户的电子邮件和标识符。
datasetId
与工作单关联的数据集的唯一标识符。 如果该请求适用于所有数据集，则此字段将设置为“全部”。
datasetName
与工作单关联的数据集的名称。
displayName
工单的可读标签。
description
工作单用途的描述。
total
与查询匹配的记录删除工作单的总数。
count
当前页删除工作单的记录数。
_links
分页和导航链接。
next
下一页具有href （字符串）和templated （布尔值）的对象。
page
用于页面导航的具有href （字符串）和templated （布尔值）的对象。

创建记录删除工作单 create

要从单个数据集或所有数据集中删除与一个或多个标识关联的记录，请对/workorder端点发出POST请求。

工作单以异步方式处理，并在提交后显示在工作单列表中。

TIP
通过API提交的每个记录删除工作单最多可包含​ 100,000个标识。 提交每个请求尽可能多的身份以最大限度地提高效率。 避免低容量提交，如单个ID工单。

API格式

POST /workorder
NOTE
您只能从关联XDM架构定义主身份或身份映射的数据集中删除记录。
NOTE
如果您尝试为已具有活动过期日期的数据集创建记录删除工作单，请求将返回HTTP 400（错误请求）。活动过期是任何尚未完成的计划删除。

请求

以下请求从特定数据集中删除与指定电子邮件地址关联的所有记录。

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

下表描述了用于创建记录删除工作单的属性。

属性
描述
displayName
此记录删除工作单的人工可读标签。
description
记录删除工作单的描述。
action
为记录删除工作单请求的操作。 要删除与给定身份关联的记录，请使用delete_identity。
datasetId
数据集的唯一标识符。 使用特定数据集的数据集ID，或ALL定位所有数据集。 数据集必须具有主身份映射或身份映射。 如果存在标识映射，则它将显示为名为identityMap的顶级字段。
请注意，数据集行在其标识映射中可能具有多个标识，但只能将一个标识标记为主标识。 必须包含"primary": true以强制id匹配主标识。
namespacesIdentities

一个对象数组，每个对象包含：

  • namespace：具有code属性的对象，该属性指定身份命名空间（例如，“email”）。
  • IDs：要删除此命名空间的一组标识值。

身份命名空间为身份数据提供上下文。 您可以使用Experience Platform提供的标准命名空间或创建自己的命名空间。 若要了解详细信息，请参阅身份命名空间文档和身份服务API规范。

响应

成功的响应将返回新记录删除工作单的详细信息。

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

下表描述了响应中的属性。

属性
描述
workorderId
记录删除工作单的唯一标识符。 使用此值查找删除的状态或详细信息。
orgId
您的独特组织标识符。
bundleId
包含此记录删除工作单的捆绑的唯一标识符。 捆绑功能允许下游服务将多个删除订单分组在一起进行处理。
action
记录删除工作单中请求的操作类型。
createdAt
创建工作单时的时间戳。
updatedAt
上次更新工作单的时间戳。
operationCount
工作单中包含的工序数。
targetServices
记录删除工作单的目标服务列表。
status
记录删除工作单的当前状态。
createdBy
创建记录删除工作单的用户的电子邮件和标识符。
datasetId
数据集的唯一标识符。 如果请求适用于所有数据集，则该值将设置为ALL。
datasetName
此记录删除工作单的数据集名称。
displayName
记录删除工作单的人工可读标签。
description
记录删除工作单的描述。
NOTE
记录删除工作单的操作属性当前在API响应中为identity-delete。 如果API更改为使用其他值（如delete_identity），则将相应地更新此文档。

检索特定记录删除工作单的详细信息 lookup

通过向/workorder/{WORKORDER_ID}发出GET请求，检索特定记录删除工作单的信息。 响应包括操作类型、状态、关联的数据集和用户信息以及审核元数据。

API格式

GET /workorder/{WORKORDER_ID}
参数
描述
{WORK_ORDER_ID}
您所查找的记录删除工作单的唯一标识符。

请求

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

响应

成功的响应将返回指定记录删除工作单的详细信息。

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

下表描述了响应中的属性。

属性
描述
workorderId
记录删除工作单的唯一标识符。
orgId
您组织的唯一标识符。
bundleId
包含此记录删除工作单的捆绑的唯一标识符。 捆绑功能允许下游服务将多个删除订单分组在一起进行处理。
action
记录删除工作单中请求的操作类型。
createdAt
创建工作单时的时间戳。
updatedAt
上次更新工作单的时间戳。
operationCount
工作单中包含的工序数。
targetServices
受此记录删除工作单影响的目标服务列表。
status
记录删除工作单的当前状态。
createdBy
创建记录删除工作单的用户的电子邮件和标识符。
datasetId
与工作单关联的数据集的唯一标识符。
datasetName
与工作单关联的数据集的名称。
displayName
记录删除工作单的人工可读标签。
description
记录删除工作单的描述。

更新记录删除工作单

通过向name端点发出PUT请求，为记录删除工作单更新description和/workorder/{WORKORDER_ID}。

API格式

PUT /workorder/{WORKORDER_ID}

下表描述了此请求的参数。

参数
描述
{WORK_ORDER_ID}
要更新的记录删除工作单的唯一标识符。

请求

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

下表描述了可以更新的属性。

属性
描述
name
记录删除工作单的更新后的人类可读标签。
description
记录删除工作单的更新描述。

响应

成功的响应会返回更新的工作单请求。

{
  "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"
        }
    ]
}
属性
描述
workorderId
记录删除工作单的唯一标识符。
orgId
您组织的唯一标识符。
bundleId
包含此记录删除工作单的捆绑的唯一标识符。 捆绑功能允许下游服务将多个删除订单分组在一起进行处理。
action
记录删除工作单中请求的操作类型。
createdAt
创建工作单时的时间戳。
updatedAt
上次更新工作单的时间戳。
operationCount
工作单中包含的工序数。
targetServices
受此记录删除工作单影响的目标服务列表。
status
记录删除工作单的当前状态。 可能的值为： received、validated、submitted、ingested、completed和failed。
createdBy
创建记录删除工作单的用户的电子邮件和标识符。
datasetId
与记录删除工作单关联的数据集的唯一标识符。
datasetName
与记录删除工作单关联的数据集的名称。
displayName
记录删除工作单的人工可读标签。
description
记录删除工作单的描述。
productStatusDetails

列出请求下游进程的当前状态的数组。 每个对象包含：

  • productName：下游服务的名称。
  • productStatus：下游服务的当前处理状态。
  • createdAt：服务发布最新状态时的时间戳。

在将工作单提交到下游服务以开始处理之后，此属性可用。

recommendation-more-help
332f81c1-51e7-4bde-8327-2eb07f09604f