削除作業指示のレコード work-order-endpoint
Data Hygiene API の /workorder
エンドポイントを使用して、Adobe Experience Platformでのレコード削除作業指示の作成、表示および管理をおこないます。 作業指示を使用すると、データセット間でデータの削除を制御、監視および追跡して、データ品質を維持し、組織のデータガバナンス標準をサポートできます。
はじめに
開始する前に、 概要を参照して、必要なヘッダー、サンプル API 呼び出しの読み方および関連ドキュメントの場所を確認してください。
割り当て量と処理タイムライン quotas
レコードの削除作業指示は、組織のライセンス使用権限によって決定され、1 日ごとおよび 1 か月ごとの識別子の送信制限の対象となります。 これらの制限は、UI ベースと API ベースのレコード削除リクエストの両方に適用されます。
製品別の月間送信使用権限 quota-limits
次の表に、製品および資格レベル別の識別子の送信制限を示します。 各製品の月額上限は、固定の識別子上限またはライセンス取得済みデータボリュームに関連付けられた割合ベースのしきい値の、2 つの値のいずれか小さい方です。
レコード削除作業指示能力は 共有サービス です。 1 か月の上限には、Real-Time CDP、Adobe Journey Optimizer、Customer Journey Analyticsおよび該当する Shield アドオン全体で最高の使用権限が反映されます。
識別子の送信のタイムラインの処理 sla-processing-timelines
送信後、レコードの削除作業指示は、使用権限レベルに基づいてキューに入れられ、処理されます。
組織でさらに上限が必要な場合は、Adobe担当者に連絡して使用権限のレビューを依頼してください。
レコード削除作業指示のリスト list
組織のデータハイジーン操作用の、ページ分割されたレコード削除作業指示のリストを取得します。 クエリパラメーターを使用して結果をフィルタリングします。 各作業指示レコードには、アクションタイプ(identity-delete
など)、ステータス、関連するデータセットおよびユーザーの詳細、監査メタデータが含まれています。
API 形式
GET /workorder
次の表では、レコード削除作業指示のリストに使用できる問合せパラメータを説明します。
search
type
identity-delete
など)で結果をフィルタリングします。status
列挙:
received
、validated
、submitted
、ingested
、completed
、failed
author
displayName
description
workorderId
sandboxName
*
を使用してすべてのサンドボックスを含めます。fromDate
toDate
が設定されている必要があります。toDate
fromDate
が設定されている必要があります。filterDate
page
limit
orderBy
+
または -
のプレフィックスを使用します。 例:orderBy=-datasetName
。properties
リクエスト
次のリクエストは、すべての完了済みレコード削除作業指示を取得します(ページあたり 2 つに制限されています)。
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
単一のデータセットまたはすべてのデータセットから 1 つ以上の ID に関連付けられたレコードを削除するには、/workorder
エンドポイントに対して POST リクエストを実行します。
作業指示は非同期で処理され、送信後に作業指示リストに表示されます。
API 形式
POST /workorder
リクエスト
次のリクエストは、指定されたメールアドレスに関連付けられているすべてのレコードを、特定のデータセットから削除します。
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
ALL
を使用してすべてのデータセットをターゲットにします。 データセットには、プライマリ ID または ID マップが必要です。 ID マップが存在する場合、identityMap
という名前の最上位フィールドとして存在します。データセット行の ID マップに多くの ID が含まれている場合がありますが、プライマリとしてマークできるのは 1 つだけであることに注意してください。
"primary": true
がプライマリ ID と一致するように強制するには、id
を含める必要があります。namespacesIdentities
オブジェクトの配列。各オブジェクトには、以下が含まれます。
namespace
:ID 名前空間を指定するcode
プロパティを持つオブジェクト(例:「email」)。IDs
:この名前空間で削除する ID 値の配列。
ID 名前空間は、ID データに対するコンテキストを提供します。 Experience Platformが提供する標準の名前空間を使用するか、独自の名前空間を作成できます。 詳しくは、ID 名前空間ドキュメントおよび ID サービス 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
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
:最新のステータスがサービスからポストされたときのタイムスタンプ。
このプロパティは、作業指示がダウンストリームサービスに送信されて処理を開始した後に使用できます。