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

[Beta 版]{class="badge informative"} [Beta 版]{class="badge informative"}

工单端点 work-order-endpoint

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • 开发人员

数据卫生API中的/workorder端点允许您在Adobe Experience Platform中以编程方式管理记录删除请求。

IMPORTANT
记录删除功能当前在Beta中，仅在​ 有限版本 ​中可用。 并非所有客户都可使用。 记录删除请求仅适用于受限版本中的组织。
记录删除旨在用于数据清理、匿名数据删除或数据最小化。 它们​ 不是 ​用于数据主体权利请求（合规性），因为它与《通用数据保护条例》(GDPR)等隐私法规相关。 对于所有合规性用例，请改用Adobe Experience Platform Privacy Service。

快速入门

本指南中使用的端点属于数据卫生API。 在继续之前，请查看概述，以了解相关文档的链接、此文档中示例API调用的阅读指南，以及有关成功调用任何Experience PlatformAPI所需的所需标头的重要信息。

创建记录删除请求 create

您可以通过向/workorder端点发出POST请求，从单个数据集或所有数据集中删除一个或多个标识。

IMPORTANT
对于每月可以提交的唯一身份记录删除总数，存在不同的限制。 这些限制基于您的许可协议。 如果组织购买了Adobe Real-time Customer Data Platform和Adobe Journey Optimizer的所有版本，则每月最多可以提交100,000个身份记录删除。 已购买​ AdobeHealthcare Shield ​或​ AdobePrivacy & Security Shield ​的组织每月最多可提交600,000个身份记录删除。
通过UI发出单个记录删除请求允许您一次提交10,000个ID。 用于删除记录的API方法允许同时提交100,000个ID。
最佳实践是，根据您的ID限制，为每个请求提交尽可能多的ID。 当您打算删除大量ID时，应避免提交小量ID，或每个记录删除请求只提交一个ID。

API格式

POST /workorder
NOTE
数据生命周期请求只能根据主身份或身份映射修改数据集。 请求必须指定主标识或提供标识映射。

请求

根据请求有效负载中提供的datasetId的值，API调用将从所有数据集或您指定的单个数据集中删除身份。 以下请求从特定数据集中删除三个身份。

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 '{
        "action": "delete_identity",
        "datasetId": "c48b51623ec641a2949d339bad69cb15",
        "displayName": "Example Record Delete Request",
        "description": "Cleanup identities required by Jira request 12345.",
        "identities": [
          {
            "namespace": {
              "code": "email"
            },
            "id": "poul.anderson@example.com"
          },
          {
            "namespace": {
              "code": "email"
            },
            "id": "cordwainer.smith@gmail.com"
          },
          {
            "namespace": {
              "code": "email"
            },
            "id": "cyril.kornbluth@yahoo.com"
          }
        ]
      }'
属性
描述
action
要执行的操作。 记录删除的值必须设置为delete_identity。
datasetId
如果您要从单个数据集中删除，此值必须是相关数据集的ID。 如果要从所有数据集中删除，则将该值设置为ALL。

如果指定单个数据集，则该数据集的关联体验数据模型(XDM)架构必须定义主标识。 如果数据集没有主标识，则必须具有标识映射，才能被数据生命周期请求修改。
如果存在标识映射，它将以名为identityMap的顶级字段的形式出现。
请注意，数据集行在其标识映射中可能具有多个标识，但只能将一个标识标记为主标识。 必须包含"primary": true以强制id匹配主标识。
displayName
记录删除请求的显示名称。
description
记录删除请求的描述。
identities

一个数组，其中包含您要删除其信息的至少一个用户的身份。 每个身份由身份命名空间和一个值组成：

  • namespace：包含代表身份命名空间的单个字符串属性code。
  • id：标识值。

如果datasetId指定了单个数据集，则identities下的每个实体必须使用与架构的主标识相同的标识命名空间。

如果将datasetId设置为ALL，则identities数组不受任何单个命名空间的约束，因为每个数据集可能不同。 但是，如Identity Service所报告，您的请求仍受组织可用的命名空间限制。

响应

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

{
  "workorderId": "a15345b8-a2d6-4d6f-b33c-5b593e86439a",
  "orgId": "{ORG_ID}",
  "bundleId": "BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd",
  "action": "identity-delete",
  "createdAt": "2022-07-21T18:05:28.316029Z",
  "updatedAt": "2022-07-21T17:59:43.217801Z",
  "status": "received",
  "createdBy": "{USER_ID}",
  "datasetId": "c48b51623ec641a2949d339bad69cb15",
  "displayName": "Example Record Delete Request",
  "description": "Cleanup identities required by Jira request 12345."
}
属性
描述
workorderId
删除订单的ID。 这可用于稍后查找删除的状态。
orgId
您的组织ID。
bundleId
与此删除顺序关联的捆绑包的ID，用于调试目的。 多个删除订单捆绑在一起，由下游服务处理。
action
工作单正在执行的操作。 对于记录删除，值为identity-delete。
createdAt
创建删除顺序的时间戳。
updatedAt
上次更新删除顺序的时间戳。
status
删除顺序的当前状态。
createdBy
创建删除顺序的用户。
datasetId
受请求约束的数据集的ID。 如果请求适用于所有数据集，则该值将设置为ALL。

检索记录删除的状态 lookup

在您创建记录删除请求后，可以使用GET请求检查其状态。

API格式

GET /workorder/{WORK_ORDER_ID}
参数
描述
{WORK_ORDER_ID}
正在查找的记录删除的workorderId。

请求

curl -X GET \
  https://platform.adobe.io/data/core/hygiene/workorder/BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd \
  -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": "a15345b8-a2d6-4d6f-b33c-5b593e86439a",
  "orgId": "{ORG_ID}",
  "bundleId": "BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd",
  "action": "identity-delete",
  "createdAt": "2022-07-21T18:05:28.316029Z",
  "updatedAt": "2022-07-21T17:59:43.217801Z",
  "status": "received",
  "createdBy": "{USER_ID}",
  "datasetId": "c48b51623ec641a2949d339bad69cb15",
  "displayName": "Example Record Delete Request",
  "description": "Cleanup identities required by Jira request 12345.",
  "productStatusDetails": [
    {
        "productName": "Data Management",
        "productStatus": "success",
        "createdAt": "2022-08-08T16:51:31.535872Z"
    },
    {
        "productName": "Identity Service",
        "productStatus": "success",
        "createdAt": "2022-08-08T16:43:46.331150Z"
    },
    {
        "productName": "Profile Service",
        "productStatus": "waiting",
        "createdAt": "2022-08-08T16:37:13.443481Z"
    }
  ]
}
属性
描述
workorderId
删除订单的ID。 这可用于稍后查找删除的状态。
orgId
您的组织ID。
bundleId
与此删除顺序关联的捆绑包的ID，用于调试目的。 多个删除订单捆绑在一起，由下游服务处理。
action
工作单正在执行的操作。 对于记录删除，值为identity-delete。
createdAt
创建删除顺序的时间戳。
updatedAt
上次更新删除顺序的时间戳。
status
删除顺序的当前状态。
createdBy
创建删除顺序的用户。
datasetId
受请求约束的数据集的ID。 如果请求适用于所有数据集，则该值将设置为ALL。
productStatusDetails

一个数组，列出与请求相关的下游进程的当前状态。 每个数组对象包含以下属性：

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

更新记录删除请求

您可以通过发出PUT请求来更新记录删除的displayName和description。

API格式

PUT /workorder{WORK_ORDER_ID}
参数
描述
{WORK_ORDER_ID}
正在查找的记录删除的workorderId。

请求

curl -X PUT \
  https://platform.adobe.io/data/core/hygiene/workorder/BN-35c1676c-3b4f-4195-8d6c-7cf5aa21efdd \
  -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}' \
  -d '{
        "displayName" : "Update - displayName",
        "description" : "Update - description"
      }'
属性
描述
displayName
记录删除请求的更新显示名称。
description
更新了记录删除请求的描述。

响应

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

{
    "workorderId": "DI-61828416-963a-463f-91c1-dbc4d0ddbd43",
    "orgId": "{ORG_ID}",
    "bundleId": "BN-aacacc09-d10c-48c5-a64c-2ced96a78fca",
    "action": "identity-delete",
    "createdAt": "2024-06-12T20:02:49.398448Z",
    "updatedAt": "2024-06-13T21:35:01.944749Z",
    "operationCount": 1,
    "status": "ingested",
    "createdBy": "{USER_ID}",
    "datasetId": "666950e6b7e2022c9e7d7a33",
    "datasetName": "Acme_Dataset_E2E_Identity_Map_Schema_5_1718178022379",
    "displayName": "Updated Display Name",
    "description": "Updated Description",
    "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
删除订单的ID。 这可用于稍后查找删除的状态。
orgId
您的组织ID。
bundleId
与此删除顺序关联的捆绑包的ID，用于调试目的。 多个删除订单捆绑在一起，由下游服务处理。
action
工作单正在执行的操作。 对于记录删除，值为identity-delete。
createdAt
创建删除顺序的时间戳。
updatedAt
上次更新删除顺序的时间戳。
status
删除顺序的当前状态。
createdBy
创建删除顺序的用户。
datasetId
受请求约束的数据集的ID。 如果请求适用于所有数据集，则该值将设置为ALL。
productStatusDetails

一个数组，列出与请求相关的下游进程的当前状态。 每个数组对象包含以下属性：

  • productName：下游服务的名称。
  • productStatus：来自下游服务的请求的当前处理状态。
  • createdAt：服务发布最新状态的时间戳。
recommendation-more-help
332f81c1-51e7-4bde-8327-2eb07f09604f