ドキュメント Experience Platform 詳細なデータライフサイクル管理ガイド

レコードの削除作業指示 work-order-endpoint

最終更新日： 2026年3月12日

トピック：
{"id":"c132d929-fa62-4271-803e-b823be07b914"}

作成対象：

{"id":"ff6a42d2-313e-452e-93a6-792e4fad9ff8"}

Data Hygiene APIの/workorder エンドポイントを使用して、Adobe Experience Platformでレコードの削除作業指示を作成、表示、管理します。作業指示により、データセットをまたいでデータ削除を制御、監視、追跡することができ、データ品質の維持と組織のデータガバナンス基準のサポートに役立ちます。

IMPORTANT

レコードの削除作業指示は、データクレンジング、匿名データの削除、データの最小化に使用されます。 GDPRなどのプライバシー規制に基づくデータ主体の権利要求に対して、レコード削除作業指示を使用しないでください。 コンプライアンスのユースケースについては、Adobe Experience Platform Privacy Serviceを使用してください。

はじめに

開始する前に、概要を参照して、必要なヘッダー、サンプル API呼び出しの読み取り方法、関連ドキュメントの検索場所について確認してください。

クォータと処理タイムライン quotas

レコードの削除作業指示は、組織のライセンス使用権限によって決定される、毎日および毎月のID送信制限の対象となります。これらの制限は、UI ベースのレコード削除要求とAPI ベースのレコード削除要求の両方に適用されます。

NOTE

1日あたり最大 1,000,000個のIDを送信できますが は、残りの月間割り当て量で許可されている場合に限ります。月間上限が100万未満の場合、1日の提出数はその上限を超えることはできません。

製品別の月次提出資格 quota-limits

次の表に、製品および使用権限レベル別の識別子の送信制限を示します。各製品の月間上限は、2つの値のうち小さい方の値です。つまり、固定識別子の上限と、ライセンス済みデータ量に関連付けられたパーセントベースのしきい値です。実際には、多くの企業では、実際の到達可能なオーディエンスやAdobe Customer Journey Analytics行の使用権限に基づいて、月間制限が低くなっています。

製品

使用権限の説明

月額上限（どちらか小さい方）

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 アドオンなし

Customer Journey Analyticsの使用権限ごとに2,000,000個のIDまたは100個のID

Customer Journey Analytics

Privacy and Security ShieldまたはHealthcare Shield アドオンを使用する

15,000,000個のIDまたはCustomer Journey Analyticsの使用権限の行ごとに200個のID

NOTE

割り当ては、各暦月の初日にリセットされます。未使用の割り当て量は、notが引き継ぎます。
割り当て量の使用状況は、送信済みIDに対する組織のライセンス済み月間使用権限に基づいています。クォータはシステムのガードレールによって適用されませんが、監視およびレビューされる場合があります。
レコードの削除作業指示の処理能力は 共有サービス です。毎月の上限は、Real-Time CDP、Adobe Journey Optimizer、Customer Journey Analytics、および該当するShield アドオンで最も高い使用権限を反映します。

識別子の送信に関する処理タイムライン sla-processing-timelines

レコードの削除リクエストは、エンタイトルメント層に基づいて処理され、標準のお客様とShieldのお客様に対して異なるSLAのコミットメントが適用されます。処理段階とタイムラインの詳細については、データライフサイクル処理タイムラインを参照してください。

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

結果ごとに含める追加フィールドのコンマ区切りリスト。（オプション）

リクエスト

次のリクエストは、完成したすべてのレコード削除作業指示を取得します。1 ページにつき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",
        "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
    }
  }
}

次の表に、応答のプロパティを示します。

プロパティ

説明

results

レコードの配列は、作業指示オブジェクトを削除します。各オブジェクトには、以下のフィールドが含まれます。

workorderId

レコード削除作業指示の一意のID。

orgId

一意の組織ID。

bundleId

このレコード削除作業指示を含むバンドルの一意の識別子。バンドルを使用すると、複数の削除注文をグループ化し、ダウンストリームサービスで一緒に処理できます。

action

作業指示で要求されたアクションタイプ。

createdAt

作業指示が作成されたタイムスタンプ。

updatedAt

作業指示が最後に更新されたタイムスタンプ。

operationCount

作業指示に含まれる操作の数。

targetServices

削除を処理したターゲットサービスのセット。デフォルト値は、組織の使用権限によって異なります。 Real-Time CDPまたはAdobe Journey Optimizerを持つ組織の場合、デフォルトはサポートされているサービスの完全なセット（["datalake", "identity", "profile", "ajo"]）です。 Customer Journey Analyticsのみの組織の場合（Real-Time Customer Profileの使用権限がない場合）、有効な値は[“datalake”]のみです。

status

作業指示の現在のステータス。使用可能な値は、received、validated、submitted、ingested、completedおよびfailedです。

createdBy

作業指示を作成したユーザーの電子メールと識別子。

datasetId

作業指示でターゲットとするデータセット：単一のデータセット ID、データセット IDのコンマ区切りリスト（マルチデータセット）、またはリテラル ALL。リクエストがプロファイルのみのモードを使用した場合、この値はALLです。

datasetName

作業指示に関連付けられているデータセットの名前。

displayName

作業指示の人間が読み取れるラベル。

description

作業指示の目的の説明。

total

クエリに一致するレコード削除作業指示の合計数。

count

現在のページ内のレコード削除作業指示の数。

_links

ページネーションとナビゲーションリンク：

next

次のページのhref （文字列）とtemplated （ブール値）を持つオブジェクト。

page

ページナビゲーション用にhref （文字列）とtemplated （ブール値）を持つオブジェクト。

レコード削除作業指示の作成 create

1つのデータセット、複数のデータセット、またはすべてのデータセットから1つ以上のIDに関連付けられたレコードを削除するには、/workorder エンドポイントにPOST リクエストを行います。

作業指示は非同期的に処理され、送信後に作業指示リストに表示されます。 2026年3月のExperience Platform リリースでは、すべてのユーザーがマルチデータセットおよびプロファイルのみの（ターゲットサービス）オプションを使用できます。

TIP

APIを介して送信された各レコード削除作業指示には、最大 100,000 ID を含めることができます。効率を最大化するために、リクエストごとに可能な限り多くのIDを送信します。単一IDの作業指示など、少人数の提出は避けてください。

API 形式

POST /workorder

IMPORTANT

レコードの削除作業指示は、プライマリ ID フィールドにのみ作用します。次の制限が適用されます。

データセットスキーマは、プライマリ IDまたはID マップを定義する必要があります。 関連するXDM スキーマがプライマリ IDまたはID マップを定義するデータセットからのみ、レコードを削除できます。
セカンダリIDはスキャンされません。 データセットに複数のID フィールドが含まれる場合、一致にはプライマリ IDのみが使用されます。プライマリ以外のIDに基づいて、レコードをターゲティングまたは削除することはできません。
入力されたプライマリ IDのないレコードはスキップされます。 レコードにプライマリ ID メタデータが入力されていない場合、削除の対象にはなりません。
ID設定の前に取り込まれたデータは対象外です。 データ取り込み後にプライマリ ID フィールドがスキーマに追加された場合、以前に取り込んだレコードはレコード削除作業指示で削除できません。

NOTE

既に有効な有効期限を持つデータセットに対してレコード削除作業指示を作成しようとすると、リクエストはHTTP 400 （不正なリクエスト）を返します。アクティブな有効期限は、まだ完了していないスケジュールされた削除です。

ID ペイロード形式（`namespacesIdentities`または`identities`）

リクエスト本文には、次のうち1つだけを含める必要があります。

形式

プロパティ

シェイプ

使用するタイミング

おすすめ

namespacesIdentities

namespace （例：{ "code": "email" }）およびids （ID文字列の配列）を持つオブジェクトの配列。

手動で構築されたペイロードでもコード生成されたペイロードでも、すべてのペイロードに対して使用します。これは、多くのIDが同じ名前空間を共有する場合に、ペイロードサイズを小さくするのに特に効率的です。

さんも受け入れました

identities

namespace （例：{ "code": "email" }）と1つのid （文字列）を持つオブジェクトの配列。

下位互換性を使用できます。これは、csv-to-data-hygiene変換スクリプトによって生成される形式です。サービスは、この形式を内部で正規化するため、結果の動作は同じです。

両方のプロパティ、両方のプロパティを送信するか、含めるプロパティに 空の配列 を指定すると、APIは HTTP 400 （不正なリクエスト） を次のいずれかのメッセージで返します。

両方のプロパティが提供されました： "Identities and NamespacesIdentities are not allowed at the same time"
リストが提供されていないか、空ではありません： "Identities are Empty for Delete Identity request."

リクエスト

次のリクエストは、特定のデータセットから、指定されたメールアドレスに関連付けられたすべてのレコードを削除します。推奨されるnamespacesIdentities形式が使用されます。

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

レコード削除作業指示に対して要求されたアクション。特定のIDに関連付けられているレコードを削除するには、delete_identityを使用します。

datasetId

データセットの一意のID。値は、リテラル ALL、単一のデータセット ID、または2つ以上のデータセット IDのコンマ区切りリスト（例："id1,id2,id3"）のいずれかである必要があります。 ALLを特定のIDと組み合わせることはできません。単一のデータセット要求は以前と同じように動作し、複数のデータセット要求はリストされている各データセットからIDを削除し、ALLはすべてのデータセットをターゲットにします。データセットには、プライマリ IDまたはID マップが必要です。 ID マップが存在する場合、そのID マップはidentityMapという名前の最上位フィールドとして存在します。
注意: データセット行のIDは多くありますが、プライマリとしてマークできるのは1つだけです。 idがプライマリ IDと強制的に一致させるには、"primary": trueを含める必要があります。
プロファイルのみの削除にtargetServicesを使用する場合、datasetIdはALLである必要があります。

targetServices

オプション。削除を処理するサービスを指定します。デフォルト値は、組織の使用権限によって異なります。 Real-Time CDPまたはAdobe Journey Optimizerを持つ組織は、サポートされているサービス（["datalake", "identity", "profile", "ajo"]）の完全なセットをデフォルトで受け取ります。 Customer Journey Analyticsを使用しているが、Real-Time Customer Profileの使用権限を持たない組織は、[ 「datalake」 ]のみを使用できます。プロファイル関連のデータのみに削除を制限し、データレイクを変更しないままにするには、これを["identity", "profile", "ajo"]に設定します（順序は問いません）。このプロファイルのみのモードでは、Real-Time CDPまたはAdobe Journey Optimizerの使用権限が必要です。datasetIdはALLである必要があります。

identities

identitiesまたはnamespacesIdentitiesのいずれかを正確に使用します。 オブジェクトの配列。各オブジェクトはnamespace （例：code、"email"）およびid （単一のID文字列）です。下位互換性を確保し、変換スクリプトによって生成されます。サービスは、この形式を内部で正規化します。動作は同じです。上記のID ペイロード形式を参照してください。

namespacesIdentities

identitiesまたはnamespacesIdentitiesのいずれかを正確に使用します。 オブジェクトの配列。各オブジェクトはnamespace （例：code、"email"）およびids （ID文字列の配列）です。すべてのペイロードに対して推奨。 namespacesIdentities プロパティは、多くのIDが1つの名前空間を共有する場合に、よりコンパクトになります。上記のID ペイロード形式を参照してください。 ID名前空間：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",
    "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"
}

次の表に、応答のプロパティを示します。

プロパティ

説明

workorderId

レコード削除作業指示の一意のID。この値を使用して、削除のステータスまたは詳細を検索します。

orgId

一意の組織ID。

bundleId

action

レコード削除作業指示で要求されたアクションタイプ。

createdAt

作業指示が作成されたタイムスタンプ。

updatedAt

作業指示が最後に更新されたタイムスタンプ。

operationCount

作業指示に含まれる操作の数。

targetServices

レコード削除作業指示のターゲットサービスのリスト。

status

レコード削除作業指示の現在のステータス。

createdBy

レコード削除作業指示を作成したユーザーの電子メールと識別子。

datasetId

データセットの一意のID。すべてのデータセットに対するリクエストの場合、値は ALL に設定されます。複数のデータセット要求の場合、値はコンマ区切りのリストまたは送信された単一のIDを反映します。

datasetName

このレコード削除作業指示のデータセット名。

displayName

レコード削除作業指示の人間が読み取れるラベル。

description

レコード削除作業指示の説明。

応答targetServicesの値は、リクエストを反映するか、省略した場合にデフォルトの設定を完全に表示します（上記の応答表を参照）。

マルチデータセットおよびプロファイルのみ（API） multi-dataset-profile-only

次のオプションはAPIでのみ使用でき、データハイジーン UIではサポートされていません。削除を処理するデータセットとサービスを制御し、複数のデータセット送信とプロファイルのみのターゲットサービスリクエストを可能にします。

次の表に、各オプションのリクエスト本文と動作の変更方法を示します。

オプション

リクエスト本文の変更

動作

マルチデータセット

datasetIdでコンマ区切りのリストを使用します（例："id1,id2,id3"）。単一IDまたはALLが変更されていません。

IDは、リストされたデータセットから（または1つのデータセットから、またはALL時にすべてのデータセットから）削除されます。

プロファイルのみ（ターゲットサービス）

targetServicesを正確に["identity", "profile", "ajo"] （注文）に追加します。 datasetIdが必要："ALL"。

削除を処理するのは、ID、プロファイル、Adobe Journey Optimizerのみです。データレイクは変更されません。

複数のデータセットのリクエスト

datasetId フィールドはコンマで分割されます。単一のID （以前と同じ動作）、IDのコンマ区切りリスト、またはリテラル ALLを使用します。 1つの作業指示で複数の特定のデータセットからIDを削除するには、コンマ区切りのリストを指定します。

"datasetId": "6707eb36eef4d42ab86d9fbe,6643f00c16ddf51767fcf780"

その後、リストされた各データセットからIDが削除されます。単一データセットのリクエストは従来どおり機能します。ALLを使用して、すべてのデータセットをターゲットにします。値は、ALL、単一のデータセット ID、またはコンマで区切られた2つ以上のデータセット IDのいずれかである必要があります（ALLを特定のIDと組み合わせることはできません）。

プロファイルのみ（ターゲットサービス）

データレイクを変更せずにIDおよびプロファイル関連のデータのみを削除するには、targetServicesを正確に3つの値に含めます：identity、profile、およびajo。 ID、プロファイル、AJOは明示的に含まれ、データレイクは除外されます。このモードでは、datasetIdはALLである必要があります（ユースケースは、データセットごとのフラグメントではなく、プロファイル全体の削除です）。

次の例では、プロファイルのみのレコード削除作業指示を作成します。

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

複数のデータセットまたはプロファイルのみのリクエストに対する正常な応答は、他の作業指示の応答と同じ形状に従います。返されるdatasetIdとtargetServicesは、リクエストの値（targetServicesが省略された場合の完全なデフォルトのリスト）を反映しているので、送信された内容を確認できます。

NOTE

レコードの削除作業指示のアクションプロパティは、現在、API応答でidentity-deleteです。 APIが異なる値（delete_identityなど）を使用するように変更された場合、このドキュメントは適宜更新されます。

レコード削除要求のID リストをJSONに変換（#convert-id-lists-to-json-for-record-delete-requests）

識別子がCSV、TSV、またはTXT ファイルにある場合、/workorder エンドポイントに必要なJSON ペイロードを生成するには、変換スクリプトを使用します。この方法は、既存のデータファイルを操作する場合に特に役立ちます。すぐに使用できるスクリプトと手順については、csv-to-data-hygiene GitHub リポジトリを参照してください。

スクリプトは identities 形式（オブジェクトごとにid個でnamespace個）を出力します。 APIはこの形式をそのまま受け入れます。生成されたJSONをPOST本文で/workorderに直接送信できます。変換は行われません。推奨される形式は namespacesIdentities です。レコード削除作業指示の作成およびID ペイロード形式を参照してください。

JSON ペイロードの生成

次のbash スクリプトの例は、PythonまたはRubyで変換スクリプトを実行する方法を示しています。

Python スクリプトを実行する例

code language-bash

#!/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

Ruby スクリプトを実行する例

code language-bash

#!/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

次の表に、bash スクリプトのパラメーターを示します。

パラメーター

説明

verbose

詳細な出力を有効にします。

column

削除するID値を含む列のインデックス（1 ベース）またはヘッダー名。指定しない場合、デフォルトは最初の列になります。

namespace

スクリプトに渡されたID名前空間コード（例：email）。生成されたJSONは、各オブジェクトのnamespace.code プロパティでこれを使用します。

dataset-id

データセットの一意の識別子：単一ID、マルチデータセットのコンマ区切りID、またはすべてのデータセットのALL。

description

レコード削除作業指示の説明。

output-dir

出力JSON ペイロードを書き込むディレクトリ。

以下の例は、CSV、TSV、またはTXT ファイルから変換されたJSON ペイロードの成功を示しています。指定された名前空間に関連付けられたレコードが含まれており、メールアドレスで識別されたレコードを削除するために使用されます。

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

次の表に、JSON ペイロードのプロパティを示します。

プロパティ

説明

action

レコード削除作業指示に対して要求されたアクション。変換スクリプトで自動的にdelete_identityに設定されます。

datasetId

データセットの一意の識別子（単一ID、コンマ区切りID、またはALL）。

displayName

このレコードの人間が判読可能なラベルは、作業指示を削除します。

description

レコード削除作業指示の説明。

identities

オブジェクトの配列。各オブジェクトには
が含まれます

namespace: ID名前空間を指定するcode プロパティを持つオブジェクト（例：「email」）。
id：この名前空間に対して削除するID値。

生成されたJSON データを`/workorder` エンドポイントに送信します

スクリプト出力は、APIがそのまま受け入れるidentities形式を使用します。 curl POST リクエストを/workorder エンドポイントに送信する場合、変換されたJSON ペイロードをリクエスト本文（-d）として使用します。完全なリクエストオプションと検証ルールについては、レコード削除作業指示の作成を参照してください。

特定のレコード削除作業指示の詳細の取得 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

レコード削除作業指示の一意のID。

orgId

組織の一意のID。

bundleId

action

レコード削除作業指示で要求されたアクションタイプ。

createdAt

作業指示が作成されたタイムスタンプ。

updatedAt

作業指示が最後に更新されたタイムスタンプ。

operationCount

作業指示に含まれる操作の数。

targetServices

このレコード削除作業指示の影響を受けるターゲットサービスのリスト。

status

レコード削除作業指示の現在のステータス。

createdBy

レコード削除作業指示を作成したユーザーの電子メールと識別子。

datasetId

作業指示に関連付けられているデータセットの一意の識別子（単一ID、コンマ区切りID、またはALL）。

datasetName

作業指示に関連付けられているデータセットの名前。

displayName

レコード削除作業指示の人間が読み取れるラベル。

description

レコード削除作業指示の説明。

レコード削除作業指示の更新 update

レコード削除作業指示のnameおよびdescriptionを更新するには、/workorder/{WORKORDER_ID} エンドポイントにPUT リクエストを行います。

API 形式

PUT /workorder/{WORKORDER_ID}

次の表に、このリクエストのパラメーターを示します。

パラメーター

説明

{WORK_ORDER_ID}

更新するレコード削除作業指示の一意の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

レコード削除作業指示の一意のID。

orgId

組織の一意のID。

bundleId

action

レコード削除作業指示で要求されたアクションタイプ。

createdAt

作業指示が作成されたタイムスタンプ。

updatedAt

作業指示が最後に更新されたタイムスタンプ。

operationCount

作業指示に含まれる操作の数。

targetServices

このレコード削除作業指示の影響を受けるターゲットサービスのリスト。

status

レコード削除作業指示の現在のステータス。使用可能な値は、received、validated、submitted、ingested、completedおよびfailedです。

createdBy

レコード削除作業指示を作成したユーザーの電子メールと識別子。

datasetId

レコード削除作業指示に関連付けられているデータセットの一意の識別子（単一ID、コンマ区切りID、またはALL）。

datasetName

レコード削除作業指示に関連付けられているデータセットの名前。

displayName

レコード削除作業指示の人間が読み取れるラベル。

description

レコード削除作業指示の説明。

productStatusDetails

リクエストのダウンストリームプロセスの現在のステータスをリストする配列。各オブジェクトには次のものが含まれます。

productName：ダウンストリームサービスの名前。
productStatus：下流サービスからの現在の処理ステータス。
createdAt：最新のステータスがサービスによって投稿されたタイムスタンプ。

このプロパティは、作業指示が下流サービスに送信された後、処理を開始するために使用できます。

recommendation-more-help

experience-platform-help-hygiene

レコードの削除作業指示 work-order-endpoint

はじめに

クォータと処理タイムライン quotas

製品別の月次提出資格 quota-limits

識別子の送信に関する処理タイムライン sla-processing-timelines

リスト レコードの削除作業指示 list

レコード削除作業指示の作成 create

ID ペイロード形式（namespacesIdentitiesまたはidentities）

マルチデータセットおよびプロファイルのみ（API） multi-dataset-profile-only

複数のデータセットのリクエスト

プロファイルのみ（ターゲットサービス）

レコード削除要求のID リストをJSONに変換（#convert-id-lists-to-json-for-record-delete-requests）

JSON ペイロードの生成

生成されたJSON データを/workorder エンドポイントに送信します

特定のレコード削除作業指示の詳細の取得 lookup

レコード削除作業指示の更新 update

リストレコードの削除作業指示 list

ID ペイロード形式（`namespacesIdentities`または`identities`）

生成されたJSON データを`/workorder` エンドポイントに送信します