Werkorders opnemen om gegevens te verwijderen work-order-endpoint

Gebruik het /workorder eindpunt in de API voor gegevenshygiëne om werkorders voor het verwijderen van records in Adobe Experience Platform te maken, weer te geven en te beheren. Met werkorders kunt u gegevensverwijdering in verschillende gegevenssets beheren, controleren en volgen, zodat u de gegevenskwaliteit kunt behouden en de standaarden voor gegevensbeheer van uw organisatie kunt ondersteunen.

Aan de slag

Alvorens u begint, zie het overzichtom over vereiste kopballen te leren, hoe te steekproefAPI vraag lezen, en waar te om verwante documentatie te vinden.

Quoten en verwerkingstijdlijnen quotas

Voor het opnemen van verwijderwerkorders gelden dagelijkse en maandelijkse indieningslimieten voor id's, die worden bepaald door de licentierechten van uw organisatie. Deze limieten gelden voor aanvragen voor het verwijderen van records via de gebruikersinterface en API.

Maandelijkse indieningstoeslagrechten per product quota-limits

In de volgende tabel staan de indieningslimieten voor id's per product en machtigingsniveau. Voor elk product is de maandelijkse limiet de laagste van twee waarden: een vast identificatieplafond of een op percentage gebaseerde drempel die is gekoppeld aan uw gelicentieerde gegevensvolume.

Tijdlijnen verwerken voor id-verzending sla-processing-timelines

Na verzending worden werkorders voor het verwijderen van records in een wachtrij geplaatst en verwerkt op basis van uw machtigingsniveau.

Als uw organisatie hogere limieten nodig heeft, neemt u contact op met uw Adobe-vertegenwoordiger voor een beoordeling van uw rechten.

Werkorders voor het verwijderen van records weergeven list

Haal een gepagineerde lijst op van werkorders voor het verwijderen van records voor bewerkingen voor gegevenshygiëne in uw organisatie. De resultaten van de filter gebruikend vraagparameters. Elk werkorderrecord bevat het actietype (zoals identity-delete ), de status, de gerelateerde gegevensset en gebruikersgegevens en metagegevens van de audit.

API formaat

GET /workorder

In de volgende tabel worden de queryparameters beschreven die beschikbaar zijn voor het opnemen van recordverwijderwerkorders.

Verzoek

Met de volgende aanvraag worden alle voltooide werkorders voor het verwijderen van records opgehaald, met een maximum van twee per pagina:

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

Reactie

Een succesvolle reactie keert een gepagineerde lijst van verslag terug schrapt werkorden.

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

In de volgende tabel worden de eigenschappen in het antwoord beschreven.

Een werkorder voor het verwijderen van records maken create

Om verslagen te schrappen verbonden aan één of meerdere identiteiten van één enkele dataset of alle datasets, doe een POST- verzoek aan het /workorder eindpunt.

Werkorders worden asynchroon verwerkt en verschijnen na verzending in de lijst met werkorders.

API formaat

POST /workorder

Verzoek

Het volgende verzoek schrapt alle verslagen verbonden aan gespecificeerde e-mailadressen van een bepaalde dataset.

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

In de volgende tabel worden de eigenschappen beschreven voor het maken van een werkvolgorde voor het verwijderen van records.

Reactie

Een succesvolle reactie keert de details van het nieuwe verslag terug schrapt werkorde.

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

In de volgende tabel worden de eigenschappen in het antwoord beschreven.

Gegevens ophalen voor een specifieke werkorder voor het verwijderen van records lookup

U kunt informatie voor een specifieke werkorder voor het verwijderen van records ophalen door een GET-aanvraag in te dienen bij /workorder/{WORKORDER_ID} . De reactie omvat actietype, status, bijbehorende dataset en gebruikersinformatie, en controlemetagegevens.

API formaat

GET /workorder/{WORKORDER_ID}

Verzoek

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

Reactie

Een geslaagde reactie retourneert de details van de opgegeven werkvolgorde voor het verwijderen van records.

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

In de volgende tabel worden de eigenschappen in het antwoord beschreven.

De werkvolgorde voor het verwijderen van records bijwerken

Werk de name en description voor een recordverwijderwerkorder bij door een PUT-aanvraag in te dienen bij het /workorder/{WORKORDER_ID} -eindpunt.

API formaat

PUT /workorder/{WORKORDER_ID}

In de volgende tabel wordt de parameter voor deze aanvraag beschreven.

Verzoek

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

In de volgende tabel worden de eigenschappen beschreven die u kunt bijwerken.

Reactie

Een geslaagde reactie retourneert de bijgewerkte aanvraag voor de werkorder.

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