작업 주문 삭제 기록 work-order-endpoint
데이터 위생 API의 /workorder
끝점을 사용하여 Adobe Experience Platform에서 레코드 삭제 작업 주문을 만들고, 보고, 관리합니다. 작업 주문을 통해 데이터 세트 간 데이터 제거를 제어, 모니터링 및 추적하여 데이터 품질을 유지하고 조직의 데이터 거버넌스 표준을 지원하는 데 도움이 됩니다.
시작
시작하기 전에 개요를 참조하여 필수 헤더, 샘플 API 호출 읽기 방법 및 관련 설명서를 찾을 위치에 대해 알아보십시오.
할당량 및 처리 타임라인 quotas
기록 삭제 작업 지시는 조직의 라이선스 자격에 따라 결정되는 일별 및 월별 식별자 제출 제한을 따릅니다. 이러한 제한은 UI 및 API 기반 레코드 삭제 요청 모두에 적용됩니다.
제품별 월별 제출 권한 quota-limits
다음 표는 제품 및 자격 수준별 식별자 제출 제한을 보여 줍니다. 각 제품에 대해 월간 상한은 고정 식별자 천장이나 사용 허가된 데이터 볼륨에 연결된 백분율 기반 임계값의 두 값 중 적은 값입니다.
레코드 삭제 작업 주문 용량은 공유 서비스 입니다. 월간 캡은 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
단일 데이터 세트 또는 모든 데이터 세트에서 하나 이상의 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가 있을 수 있지만, 한 ID만 기본으로 표시할 수 있습니다.
"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
: 서비스에서 가장 최근 상태를 게시한 타임스탬프입니다.
이 속성은 처리를 시작하기 위해 작업 주문이 다운스트림 서비스에 제출된 후에 사용할 수 있습니다.