DocumentatieExperience PlatformGeavanceerde handleiding voor levenscyclusbeheer van gegevens

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

Werkordereindpunt work-order-endpoint

Last update: Tue Jun 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Ontwikkelaar

De /workorder Het eindpunt in de Hygiene API van Gegevens staat u toe om verslagen te beheren schrapt verzoeken in Adobe Experience Platform.

IMPORTANT
De functie Record verwijderen bevindt zich momenteel in de bètaversie en is alleen beschikbaar in een beperkte release. Het is niet beschikbaar voor alle klanten. Registratie-verwijderingsverzoeken zijn alleen beschikbaar voor organisaties in de beperkte release.
Gegevens verwijderen uit records moeten worden gebruikt voor het opschonen van gegevens, het verwijderen van anonieme gegevens of het minimaliseren van gegevens. Ze zijn niet te gebruiken voor verzoeken om rechten van betrokkenen (naleving) met betrekking tot privacyvoorschriften zoals de algemene gegevensbeschermingsverordening (GDPR). Gebruik voor alle gevallen waarin aan de eisen wordt voldaan Adobe Experience Platform Privacy Service in plaats daarvan.

Aan de slag

Het eindpunt dat in deze handleiding wordt gebruikt, maakt deel uit van de Data Hygiene API. Controleer voordat je doorgaat de overzicht voor verbindingen aan verwante documentatie, een gids aan lezing de steekproefAPI vraag in dit document, en belangrijke informatie betreffende vereiste kopballen die nodig zijn om met succes vraag aan om het even welk Experience Platform API te maken.

Een verzoek tot het verwijderen van records maken create

U kunt één of meerdere identiteiten van één enkele dataset of alle datasets schrappen door een verzoek van de POST aan het /workorder eindpunt.

IMPORTANT
Er zijn verschillende limieten voor het totale aantal unieke identiteitsrecords dat elke maand kan worden verzonden. Deze limieten zijn gebaseerd op uw licentieovereenkomst. Organisaties die alle edities van Adobe Real-time Customer Data Platform en Adobe Journey Optimizer hebben aangeschaft, kunnen maximaal 100.000 identiteitsgegevens verzenden en elke maand verwijderen. Organisaties die een aankoop hebben gedaan Adobe Gezondheidsschild of Privacy- en beveiligingsschild van Adobe kan maximaal 600.000 identiteitsverslagen indienen schrapt elke maand.
Eén verzoek tot verwijdering van records via de gebruikersinterface kunt u 10.000 id's tegelijk verzenden. Met de API-methode voor het verwijderen van records kunnen 100.000 id's tegelijk worden verzonden.
Het is aan te raden zoveel mogelijk id's per aanvraag in te dienen, tot aan je ID-limiet. Wanneer u een hoog volume id's wilt verwijderen, moet u een laag volume of één id per record verwijderen.

API-indeling

POST /workorder
NOTE
De verzoeken van de Levenscyclus van gegevens kunnen datasets slechts wijzigen die op primaire identiteiten of een identiteitskaart worden gebaseerd. Een verzoek moet of de primaire identiteit specificeren, of een identiteitskaart verstrekken.

Verzoek

Afhankelijk van de waarde van de datasetId verstrekt in de verzoeklading, zal de API vraag identiteiten van alle datasets of één enkele dataset schrappen die u specificeert. Het volgende verzoek schrapt drie identiteiten van een specifieke 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 '{
        "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"
          }
        ]
      }'
Eigenschap
Beschrijving
action
De uit te voeren actie. De waarde moet worden ingesteld op delete_identity voor verwijderen van records.
datasetId
Als u uit één enkele dataset schrapt, moet deze waarde identiteitskaart van de dataset in kwestie zijn. Als u uit alle datasets schrapt, plaats de waarde aan ALL.

Als u één enkele dataset specificeert, moet het bijbehorende schema van de Gegevens van de Ervaring van de dataset van het Model (XDM) een primaire bepaalde identiteit hebben. Als de dataset geen primaire identiteit heeft, dan moet het een identiteitskaart hebben om door een verzoek van de Levenscyclus van Gegevens te worden gewijzigd.
Als er een identiteitsoverzicht bestaat, wordt deze weergegeven als een veld op hoofdniveau met de naam identityMap.
Merk op dat een datasetrij vele identiteiten in zijn identiteitskaart kan hebben, maar slechts één kan als primair worden gemerkt. "primary": true moet worden opgenomen om de id om overeen te komen met een primaire identiteit.
displayName
De weergavenaam voor het verzoek om het verwijderen van records.
description
Een beschrijving voor het verzoek om record te verwijderen.
identities

Een array met de identiteiten van ten minste één gebruiker van wie u de gegevens wilt verwijderen. Elke identiteit bestaat uit een naamruimte identity en een waarde:

  • namespace: Bevat één tekenreekseigenschap, code, die staat voor de naamruimte identity.
  • id: De identiteitswaarde.

Indien datasetId geeft één gegevensset aan, elke entiteit onder identities moet dezelfde naamruimte gebruiken als de primaire identiteit van het schema.

Indien datasetId is ingesteld op ALLde identities array is niet beperkt tot één naamruimte omdat elke dataset anders kan zijn. Uw verzoeken blijven echter beperkt tot de naamruimten die beschikbaar zijn voor uw organisatie, zoals gerapporteerd door Identiteitsservice.

Antwoord

Als de reactie succesvol was, worden de details van de record delete geretourneerd.

{
  "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."
}
Eigenschap
Beschrijving
workorderId
De id van de verwijderingsvolgorde. Dit kan worden gebruikt om de status van de schrapping later omhoog te kijken.
orgId
Uw organisatie-id.
bundleId
De id van de bundel waaraan deze verwijderingsvolgorde is gekoppeld, wordt gebruikt voor foutopsporingsdoeleinden. Meerdere verwijderingsopdrachten worden gebundeld om door downstreamdiensten te worden verwerkt.
action
De actie die door de het werkorde wordt uitgevoerd. Voor record-verwijderingen is de waarde identity-delete.
createdAt
Een tijdstempel met het tijdstip waarop de verwijderingsvolgorde is gemaakt.
updatedAt
Een tijdstempel van wanneer de verwijderingsvolgorde voor het laatst is bijgewerkt.
status
De huidige status van de verwijderingsopdracht.
createdBy
De gebruiker die de schrappingsorde creeerde.
datasetId
De id van de gegevensset waarop het verzoek betrekking heeft. Als het verzoek voor alle datasets is, zal de waarde worden geplaatst aan ALL.

De status van een record verwijderen lookup

Na u een verzoek tot verwijdering van records maken, kunt u de status controleren met een GET-aanvraag.

API-indeling

GET /workorder/{WORK_ORDER_ID}
Parameter
Beschrijving
{WORK_ORDER_ID}
De workorderId van de record te verwijderen.

Verzoek

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

Antwoord

Een geslaagde reactie retourneert de details van de verwijderingsbewerking, inclusief de huidige status.

{
  "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"
    }
  ]
}
Eigenschap
Beschrijving
workorderId
De id van de verwijderingsvolgorde. Dit kan worden gebruikt om de status van de schrapping later omhoog te kijken.
orgId
Uw organisatie-id.
bundleId
De id van de bundel waaraan deze verwijderingsvolgorde is gekoppeld, wordt gebruikt voor foutopsporingsdoeleinden. Meerdere verwijderingsopdrachten worden gebundeld om door downstreamdiensten te worden verwerkt.
action
De actie die door de het werkorde wordt uitgevoerd. Voor record-verwijderingen is de waarde identity-delete.
createdAt
Een tijdstempel met het tijdstip waarop de verwijderingsvolgorde is gemaakt.
updatedAt
Een tijdstempel van wanneer de verwijderingsvolgorde voor het laatst is bijgewerkt.
status
De huidige status van de verwijderingsopdracht.
createdBy
De gebruiker die de schrappingsorde creeerde.
datasetId
De id van de gegevensset waarop het verzoek betrekking heeft. Als het verzoek voor alle datasets is, zal de waarde worden geplaatst aan ALL.
productStatusDetails

Een array die de huidige status van downstreamprocessen met betrekking tot de aanvraag opsomt. Elk matrixobject bevat de volgende eigenschappen:

  • productName: De naam van de downstreamservice.
  • productStatus: De huidige verwerkingsstatus van het verzoek van de downstreamdienst.
  • createdAt: Een tijdstempel van wanneer de meest recente status door de service is gepost.

Een verzoek tot het verwijderen van records bijwerken

U kunt de displayName en description voor een record verwijderen door een PUT aan te vragen.

API-indeling

PUT /workorder{WORK_ORDER_ID}
Parameter
Beschrijving
{WORK_ORDER_ID}
De workorderId van de record te verwijderen.

Verzoek

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"
      }'
Eigenschap
Beschrijving
displayName
Een bijgewerkte weergavenaam voor het verzoek om het verwijderen van records.
description
Een bijgewerkte beschrijving voor de aanvraag om het record te verwijderen.

Antwoord

Als de reactie succesvol was, worden de details van de record delete geretourneerd.

{
    "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"
        }
    ]
}
Eigenschap
Beschrijving
workorderId
De id van de verwijderingsvolgorde. Dit kan worden gebruikt om de status van de schrapping later omhoog te kijken.
orgId
Uw organisatie-id.
bundleId
De id van de bundel waaraan deze verwijderingsvolgorde is gekoppeld, wordt gebruikt voor foutopsporingsdoeleinden. Meerdere verwijderingsopdrachten worden gebundeld om door downstreamdiensten te worden verwerkt.
action
De actie die door de het werkorde wordt uitgevoerd. Voor record-verwijderingen is de waarde identity-delete.
createdAt
Een tijdstempel met het tijdstip waarop de verwijderingsvolgorde is gemaakt.
updatedAt
Een tijdstempel van wanneer de verwijderingsvolgorde voor het laatst is bijgewerkt.
status
De huidige status van de verwijderingsopdracht.
createdBy
De gebruiker die de schrappingsorde creeerde.
datasetId
De id van de gegevensset waarop het verzoek betrekking heeft. Als het verzoek voor alle datasets is, zal de waarde worden geplaatst aan ALL.
productStatusDetails

Een array die de huidige status van downstreamprocessen met betrekking tot de aanvraag opsomt. Elk matrixobject bevat de volgende eigenschappen:

  • productName: De naam van de downstreamservice.
  • productStatus: De huidige verwerkingsstatus van het verzoek van de downstreamdienst.
  • createdAt: Een tijdstempel van wanneer de meest recente status door de service is gepost.
recommendation-more-help
332f81c1-51e7-4bde-8327-2eb07f09604f