DocumentaçãoExperience PlatformGuia avançado de gerenciamento do ciclo de vida dos dados

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

Ponto de extremidade da ordem de trabalho work-order-endpoint

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Desenvolvedor

O ponto de extremidade /workorder na API da higiene de dados permite gerenciar programaticamente solicitações de exclusão de registros no Adobe Experience Platform.

IMPORTANT
O recurso de Exclusão de Registro está atualmente no Beta e só está disponível em uma versão limitada. Não está disponível para todos os clientes. As solicitações de exclusão de registro só estão disponíveis para organizações na versão limitada.
As exclusões de registros devem ser usadas para limpeza de dados, remoção de dados anônimos ou minimização de dados. Eles não devem ser usados para solicitações de direitos do titular dos dados (conformidade) relacionadas a regulamentos de privacidade, como o Regulamento Geral sobre a Proteção de Dados (GDPR). Para todos os casos de uso de conformidade, use o Adobe Experience Platform Privacy Service.

Introdução

O endpoint usado neste guia faz parte da API de higiene de dados. Antes de continuar, revise a visão geral para obter os links para a documentação relacionada, um guia para ler as chamadas de API de exemplo neste documento e informações importantes sobre os cabeçalhos necessários para fazer chamadas para qualquer API de Experience Platform com êxito.

Criar uma solicitação de exclusão de registro create

Você pode excluir uma ou mais identidades de um único conjunto de dados ou de todos os conjuntos de dados fazendo uma solicitação POST para o ponto de extremidade /workorder.

IMPORTANT
Há diferentes limites para o número total de exclusões de registros de identidade únicos que podem ser enviadas a cada mês. Esses limites são baseados no seu contrato de licença. As organizações que compraram todas as edições do Adobe Real-time Customer Data Platform e do Adobe Journey Optimizer podem enviar até 100.000 exclusões de registro de identidade a cada mês. As organizações que compraram o Adobe Healthcare Shield ou o Adobe Privacy & Security Shield podem enviar até 600.000 exclusões de registros de identidade a cada mês.
Uma única solicitação de exclusão de registro por meio da interface permite enviar 10.000 IDs de uma vez. O método da API para excluir registros permite o envio de 100.000 IDs de uma vez.
É prática recomendada enviar o máximo possível de IDs por solicitação, até o limite de ID. Quando você pretende excluir um grande volume de IDs, deve evitar o envio de um pequeno volume ou de uma única ID por solicitação de exclusão de registro.

Formato da API

POST /workorder
NOTE
As solicitações de ciclo de vida dos dados só podem modificar conjuntos de dados com base nas identidades principais ou em um mapa de identidade. Uma solicitação deve especificar a identidade primária ou fornecer um mapa de identidade.

Solicitação

Dependendo do valor de datasetId fornecido na carga da solicitação, a chamada de API excluirá identidades de todos os conjuntos de dados ou de um único conjunto de dados especificado. A solicitação a seguir exclui três identidades de um conjunto de dados específico.

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"
          }
        ]
      }'
Propriedade
Descrição
action
A ação a ser executada. O valor deve ser definido como delete_identity para exclusões de registro.
datasetId
Se você estiver excluindo de um único conjunto de dados, esse valor deverá ser a ID do conjunto de dados em questão. Se você estiver excluindo de todos os conjuntos de dados, defina o valor como ALL.

Se você estiver especificando um único conjunto de dados, o esquema do Experience Data Model (XDM) associado ao conjunto de dados deve ter uma identidade primária definida. Se o conjunto de dados não tiver uma identidade primária, ele deverá ter um mapa de identidade para ser modificado por uma solicitação do ciclo de vida dos dados.
Se existir um mapa de identidade, ele estará presente como um campo de nível superior chamado identityMap.
Observe que uma linha de conjunto de dados pode ter muitas identidades em seu mapa de identidade, mas apenas uma pode ser marcada como primária. "primary": true deve ser incluído para forçar id a corresponder a uma identidade principal.
displayName
O nome de exibição da solicitação de exclusão de registro.
description
Uma descrição para a solicitação de exclusão de registro.
identities

Uma matriz que contém as identidades de pelo menos um usuário cujas informações você deseja excluir. Cada identidade é composta de um namespace de identidade e um valor:

  • namespace: Contém uma única propriedade de cadeia de caracteres, code, que representa o namespace de identidade.
  • id: o valor de identidade.

Se datasetId especificar um único conjunto de dados, cada entidade em identities deverá usar o mesmo namespace de identidade que a identidade principal do esquema.

Se datasetId estiver definido como ALL, a matriz identities não estará restrita a nenhum namespace único, pois cada conjunto de dados pode ser diferente. No entanto, suas solicitações ainda restringem os namespaces disponíveis para sua organização, conforme relatado pelo Serviço de Identidade.

Resposta

Uma resposta bem-sucedida retorna os detalhes da exclusão do registro.

{
  "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."
}
Propriedade
Descrição
workorderId
A ID da ordem de exclusão. Isso pode ser usado para consultar o status da exclusão posteriormente.
orgId
Sua ID da organização.
bundleId
A ID do pacote ao qual esta ordem de exclusão está associada, usada para fins de depuração. Várias ordens de exclusão são agrupadas para serem processadas pelos serviços downstream.
action
A ação que está sendo executada pela ordem de serviço. Para exclusões de registro, o valor é identity-delete.
createdAt
Um carimbo de data e hora de quando a ordem de exclusão foi criada.
updatedAt
Um carimbo de data e hora de quando a ordem de exclusão foi atualizada pela última vez.
status
O status atual da ordem de exclusão.
createdBy
O usuário que criou a ordem de exclusão.
datasetId
A ID do conjunto de dados sujeito à solicitação. Se a solicitação for para todos os conjuntos de dados, o valor será definido como ALL.

Recuperar o status de uma exclusão de registro lookup

Depois de criar uma solicitação de exclusão de registro, você poderá verificar seu status usando uma solicitação GET.

Formato da API

GET /workorder/{WORK_ORDER_ID}
Parâmetro
Descrição
{WORK_ORDER_ID}
O workorderId da exclusão de registro que você está procurando.

Solicitação

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

Resposta

Uma resposta bem-sucedida retorna os detalhes da operação de exclusão, incluindo seu status atual.

{
  "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"
    }
  ]
}
Propriedade
Descrição
workorderId
A ID da ordem de exclusão. Isso pode ser usado para consultar o status da exclusão posteriormente.
orgId
Sua ID da organização.
bundleId
A ID do pacote ao qual esta ordem de exclusão está associada, usada para fins de depuração. Várias ordens de exclusão são agrupadas para serem processadas pelos serviços downstream.
action
A ação que está sendo executada pela ordem de serviço. Para exclusões de registro, o valor é identity-delete.
createdAt
Um carimbo de data e hora de quando a ordem de exclusão foi criada.
updatedAt
Um carimbo de data e hora de quando a ordem de exclusão foi atualizada pela última vez.
status
O status atual da ordem de exclusão.
createdBy
O usuário que criou a ordem de exclusão.
datasetId
A ID do conjunto de dados sujeito à solicitação. Se a solicitação for para todos os conjuntos de dados, o valor será definido como ALL.
productStatusDetails

Uma matriz que lista o status atual dos processos downstream relacionados à solicitação. Cada objeto de matriz contém as seguintes propriedades:

  • productName: O nome do serviço downstream.
  • productStatus: o status de processamento atual da solicitação do serviço downstream.
  • createdAt: Um carimbo de data e hora de quando o status mais recente foi postado pelo serviço.

Atualizar uma solicitação de exclusão de registro

Você pode atualizar o displayName e o description para uma exclusão de registro fazendo uma solicitação PUT.

Formato da API

PUT /workorder{WORK_ORDER_ID}
Parâmetro
Descrição
{WORK_ORDER_ID}
O workorderId da exclusão de registro que você está procurando.

Solicitação

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"
      }'
Propriedade
Descrição
displayName
Um nome de exibição atualizado para a solicitação de exclusão de registro.
description
Uma descrição atualizada da solicitação de exclusão de registro.

Resposta

Uma resposta bem-sucedida retorna os detalhes da exclusão do registro.

{
    "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"
        }
    ]
}
Propriedade
Descrição
workorderId
A ID da ordem de exclusão. Isso pode ser usado para consultar o status da exclusão posteriormente.
orgId
Sua ID da organização.
bundleId
A ID do pacote ao qual esta ordem de exclusão está associada, usada para fins de depuração. Várias ordens de exclusão são agrupadas para serem processadas pelos serviços downstream.
action
A ação que está sendo executada pela ordem de serviço. Para exclusões de registro, o valor é identity-delete.
createdAt
Um carimbo de data e hora de quando a ordem de exclusão foi criada.
updatedAt
Um carimbo de data e hora de quando a ordem de exclusão foi atualizada pela última vez.
status
O status atual da ordem de exclusão.
createdBy
O usuário que criou a ordem de exclusão.
datasetId
A ID do conjunto de dados sujeito à solicitação. Se a solicitação for para todos os conjuntos de dados, o valor será definido como ALL.
productStatusDetails

Uma matriz que lista o status atual dos processos downstream relacionados à solicitação. Cada objeto de matriz contém as seguintes propriedades:

  • productName: O nome do serviço downstream.
  • productStatus: o status de processamento atual da solicitação do serviço downstream.
  • createdAt: Um carimbo de data e hora de quando o status mais recente foi postado pelo serviço.
recommendation-more-help
332f81c1-51e7-4bde-8327-2eb07f09604f