Criar um fluxo de dados para uma origem OneTrust Integration usando a API Flow Service
Criado para:
- Desenvolvedor
O tutorial a seguir orienta você pelas etapas para criar uma conexão de origem e um fluxo de dados para trazer dados de consentimento históricos e agendados de OneTrust Integration para a Adobe Experience Platform usando a Flow Service API.
Pré-requisitos
Antes de conectar o OneTrust Integration ao Experience Platform, você deve primeiro recuperar o token de acesso. Para obter instruções detalhadas sobre como encontrar o token de acesso, consulte o OneTrust Integration guia do OAuth 2.
O token de acesso não é atualizado automaticamente depois que expira porque os tokens de atualização de sistema para sistema não têm suporte no OneTrust. Portanto, é necessário garantir que seu token de acesso seja atualizado na conexão antes que ela expire. O tempo de vida máximo configurável para um token de acesso é de um ano. Para saber mais sobre como atualizar seu token de acesso, consulte o OneTrust documento sobre como gerenciar suas credenciais de cliente do OAuth 2.0.
Conectar o OneTrust Integration ao Experience Platform usando a API Flow Service
O tutorial a seguir orienta você pelas etapas para criar uma conexão de origem OneTrust Integration e criar um fluxo de dados para trazer dados OneTrust Integration para a Experience Platform usando a Flow Service API.
Criar uma conexão básica
Uma conexão base retém informações entre sua origem e a Experience Platform, incluindo as credenciais de autenticação da origem, o estado atual da conexão e a ID de conexão base exclusiva. A ID de conexão básica permite explorar e navegar pelos arquivos de dentro da origem e identificar os itens específicos que deseja assimilar, incluindo informações sobre os tipos de dados e formatos.
Para criar uma ID de conexão base, faça uma solicitação POST para o ponto de extremidade /connections
ao fornecer suas credenciais de autenticação do OneTrust Integration como parte do corpo da solicitação.
Formato da API
POST /connections
Solicitação
A solicitação a seguir cria uma conexão base para OneTrust Integration:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-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": "ONETRUST base connection",
"description": "ONETRUST base connection to authenticate to Experience Platform",
"connectionSpec": {
"id": "cf16d886-c627-4872-9936-fb08d6cba8cc",
"version": "1.0"
},
"auth": {
"specName": "OAuth2 Refresh Code",
"params": {
"accessToken": "{ACCESS_TOKEN}"
}
}
}'
name
description
connectionSpec.id
auth.specName
auth.params.
auth.params.accessToken
Resposta
Uma resposta bem-sucedida retorna a conexão base recém-criada, incluindo seu identificador de conexão exclusivo (id
). Essa ID é necessária para explorar a estrutura de arquivos e o conteúdo da fonte na próxima etapa.
{
"id": "622124ca-6d18-47f7-999c-66f599955309",
"etag": "\"2e026443-0000-0200-0000-621f1af80000\""
}
Explorar sua fonte
Usando a ID de conexão básica gerada na etapa anterior, você pode explorar arquivos e diretórios executando solicitações do GET.
Use as chamadas a seguir para localizar o caminho do arquivo que você deseja trazer para Experience Platform:
Formato da API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}
Ao executar solicitações do GET para explorar a estrutura e o conteúdo do arquivo de origem, você deve incluir os parâmetros de consulta listados na tabela abaixo:
{BASE_CONNECTION_ID}
objectType=rest
rest
.{OBJECT}
fileType=json
json
é o único tipo de arquivo com suporte.{PREVIEW}
Solicitação
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/622124ca-6d18-47f7-999c-66f599955309/explore?objectType=rest&object=json&fileType=json&preview=true' \
-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 a estrutura do arquivo consultado.
{
"format": "hierarchical",
"schema": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"size": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"numberOfElements": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"last": {
"type": "boolean"
},
"pageable": {
"type": "object",
"properties": {
"paged": {
"type": "boolean"
},
"pageNumber": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"offset": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"tokenId": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"pageSize": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"unpaged": {
"type": "boolean"
},
"sort": {
"type": "object",
"properties": {
"unsorted": {
"type": "boolean"
},
"sorted": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
}
}
},
"sort": {
"type": "object",
"properties": {
"unsorted": {
"type": "boolean"
},
"sorted": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
},
"content": {
"type": "object",
"properties": {
"LastUpdatedDate": {
"type": "string"
},
"Identifier": {
"type": "string"
},
"Language": {
"type": "string"
},
"TestDataSubject": {
"type": "boolean"
},
"CreatedDate": {
"type": "string"
},
"DataElements": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"Id": {
"type": "string"
},
"Purposes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Status": {
"type": "string"
},
"LastTransactionDate": {
"type": "string"
},
"CustomPreferences": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"LastUpdatedDate": {},
"ExpiryDate": {},
"Topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"IsConsented": {
"type": "boolean"
},
"Id": {
"type": "string"
},
"Name": {
"type": "string"
}
}
}
},
"TotalTransactionCount": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"LastReceiptId": {},
"ConsentDate": {
"type": "string"
},
"LastInteractionDate": {},
"Name": {
"type": "string"
},
"FirstTransactionDate": {
"type": "string"
},
"LastTransactionCollectionPointId": {
"type": "string"
},
"LastTransactionCollectionPointVersion": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"Version": {
"type": "integer",
"minimum": -9007199254740992,
"maximum": 9007199254740991
},
"attributes": {
"type": "object",
"properties": {}
},
"Id": {
"type": "string"
},
"PurposeNote": {},
"WithdrawalDate": {
"type": "string"
}
}
}
}
}
},
"first": {
"type": "boolean"
},
"empty": {
"type": "boolean"
}
}
},
"data": [
{
"number": 0,
"size": 100,
"numberOfElements": 100,
"last": false,
"pageable": {
"limit": 100,
"offset": 0,
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"tokenId": 100,
"pageSize": 100,
"pageNumber": 0,
"unpaged": false,
"paged": true
},
"sort": {
"sorted": true,
"unsorted": false,
"empty": false
},
"content": {
"Id": "de1ab4d2-6ccf-42bd-b363-2d8cac60c88c",
"Language": "en-us",
"Identifier": "gkumar@onetrust.com",
"LastUpdatedDate": "2019-06-05T12:02:07Z",
"CreatedDate": "2018-05-02T03:14:28Z",
"Purposes": [
{
"Id": "9edf57bb-0449-4c15-98e4-8641522e5ff4",
"Name": "Purpose_UAT",
"Version": 1,
"Status": "ACTIVE",
"FirstTransactionDate": "2018-05-02T03:14:27Z",
"LastTransactionDate": "2019-05-29T11:08:26Z",
"WithdrawalDate": "2019-05-29T11:05:30Z",
"ConsentDate": "2018-05-02T03:14:27Z",
"TotalTransactionCount": 5,
"Topics": [
{
"Id": "d6e3d675-3d6f-4f4e-a157-bd93829ee632",
"Name": "Topic_UAT",
"IsConsented": true
}
],
"LastTransactionCollectionPointId": "735c85c8-c69c-44bc-8bad-ec0e806090bd",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "814c073a-95f1-4fc9-8263-1ec62225c5e9",
"Name": "Multi Pur_UAT",
"Version": 1,
"Status": "ACTIVE",
"FirstTransactionDate": "2018-05-02T03:17:33Z",
"LastTransactionDate": "2018-05-02T03:19:49Z",
"ConsentDate": "2018-05-02T03:17:33Z",
"TotalTransactionCount": 4,
"LastTransactionCollectionPointId": "9a5b7375-bc13-47e8-8a58-1ca7d9c06c8e",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "4d52dcc4-82bf-44bf-ac49-854eba6ff8f3",
"Name": "Eloqua_UAT",
"Version": 1,
"Status": "ACTIVE",
"FirstTransactionDate": "2018-05-02T03:26:36Z",
"LastTransactionDate": "2019-03-07T03:23:25Z",
"ConsentDate": "2018-05-02T03:26:36Z",
"TotalTransactionCount": 3,
"Topics": [
{
"Id": "690ad782-6280-4ea4-b62a-1514c39fc838",
"Name": "Eloqua_topic",
"IsConsented": true
}
],
"LastTransactionCollectionPointId": "f8886377-e4b1-45e4-b1c0-d7dacb744db8",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "723300e3-96cb-4da4-abdd-4913c05be215",
"Name": "Purpose 1",
"Version": 2,
"Status": "EXPIRED",
"FirstTransactionDate": "2019-02-27T06:29:48Z",
"LastTransactionDate": "2019-02-28T12:00:45Z",
"ConsentDate": "2019-02-27T06:29:48Z",
"ExpiryDate": "2019-02-28T12:00:45Z",
"TotalTransactionCount": 2,
"LastTransactionCollectionPointId": "3dbfb978-10f9-44a9-9669-d699674edd9d",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "4a5e6278-17f1-4283-beee-29f81cde2bd0",
"Name": "kbpurpose1",
"Version": 1,
"Status": "NO_CONSENT",
"FirstTransactionDate": "2019-03-07T03:21:58Z",
"LastTransactionDate": "2019-05-29T03:56:37Z",
"TotalTransactionCount": 6,
"LastTransactionCollectionPointId": "cea42a12-5de4-421a-b429-092e8d523948",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "a36f98d0-c662-4f61-a2a1-8bdab69e3c3a",
"Name": "Pur 1",
"Version": 1,
"Status": "ACTIVE",
"FirstTransactionDate": "2019-03-07T03:23:25Z",
"LastTransactionDate": "2019-03-07T03:23:27Z",
"ConsentDate": "2019-03-07T03:23:25Z",
"TotalTransactionCount": 2,
"LastTransactionCollectionPointId": "f8886377-e4b1-45e4-b1c0-d7dacb744db8",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "41ebdf32-068b-4239-89ac-42e20262c5a9",
"Name": "Send Notifications about Changes to Preferences",
"Version": 1,
"Status": "ACTIVE",
"FirstTransactionDate": "2019-03-07T03:24:11Z",
"LastTransactionDate": "2019-03-07T03:27:29Z",
"ConsentDate": "2019-03-07T03:24:11Z",
"TotalTransactionCount": 2,
"LastTransactionCollectionPointId": "c29a99a9-de4d-4367-973b-95b0217d0640",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "759d8b24-e4c0-4107-86e2-3a408db13e6b",
"Name": "GJ Purpose 07",
"Version": 2,
"Status": "WITHDRAWN",
"FirstTransactionDate": "2019-03-07T03:27:29Z",
"LastTransactionDate": "2019-05-29T11:09:03Z",
"WithdrawalDate": "2019-05-29T11:09:03Z",
"ConsentDate": "2019-03-07T03:27:29Z",
"TotalTransactionCount": 18,
"LastTransactionCollectionPointId": "cea42a12-5de4-421a-b429-092e8d523948",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "a57ee9da-b494-49e2-b562-6dfa31f190df",
"Name": "kbpurpose2",
"Version": 1,
"Status": "WITHDRAWN",
"FirstTransactionDate": "2019-03-28T03:23:44Z",
"LastTransactionDate": "2019-03-28T03:24:29Z",
"WithdrawalDate": "2019-03-28T03:24:29Z",
"ConsentDate": "2019-03-28T03:23:44Z",
"TotalTransactionCount": 2,
"LastTransactionCollectionPointId": "c29a99a9-de4d-4367-973b-95b0217d0640",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "a1ccd810-94a0-4b58-946b-6705eae15c5b",
"Name": "Purpose01 v2",
"Version": 2,
"Status": "EXPIRED",
"FirstTransactionDate": "2019-05-29T04:05:42Z",
"LastTransactionDate": "2019-06-05T12:02:06Z",
"WithdrawalDate": "2019-05-29T11:09:12Z",
"ConsentDate": "2019-05-29T04:05:42Z",
"ExpiryDate": "2019-06-05T12:02:06Z",
"TotalTransactionCount": 8,
"Topics": [
{
"Id": "af7bf604-2058-4089-985c-c84083e3e3e3",
"Name": "New_Topic",
"IsConsented": true
}
],
"LastTransactionCollectionPointId": "735c85c8-c69c-44bc-8bad-ec0e806090bd",
"LastTransactionCollectionPointVersion": 1
},
{
"Id": "a313353a-e13b-4554-be08-22cf4a78a31c",
"Name": "Purpose_1804 v2",
"Version": 2,
"Status": "ACTIVE",
"FirstTransactionDate": "2019-05-29T04:05:42Z",
"LastTransactionDate": "2019-05-29T11:09:30Z",
"WithdrawalDate": "2019-05-29T11:05:30Z",
"ConsentDate": "2019-05-29T04:05:42Z",
"TotalTransactionCount": 4,
"CustomPreferences": [
{
"Id": "4935d35a-7216-480d-9da9-1aef0e078b89",
"Name": "Custom_S",
"Options": [
{
"Id": "8acc2f9f-37f8-4ace-a513-fae6b7dd0aa9",
"Name": "Option2",
"IsConsented": true
}
]
}
],
"LastTransactionCollectionPointId": "735c85c8-c69c-44bc-8bad-ec0e806090bd",
"LastTransactionCollectionPointVersion": 1
}
],
"TestDataSubject": false
},
"first": true,
"empty": false
}
]
}
Criar uma conexão de origem
Você pode criar uma conexão de origem fazendo uma solicitação POST para a API Flow Service. Uma conexão de origem consiste em uma ID de conexão, um caminho para o arquivo de dados de origem e uma ID de especificação de conexão.
Formato da API
POST /sourceConnections
Solicitação
A solicitação a seguir cria uma conexão de origem para OneTrust Integration:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
-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": "ONETRUST Source Connection",
"description": "ONETRUST Source Connection",
"baseConnectionId": "622124ca-6d18-47f7-999c-66f599955309",
"connectionSpec": {
"id": "cf16d886-c627-4872-9936-fb08d6cba8cc",
"version": "1.0"
},
"data": {
"format": "json"
},
"params": {}
}'
name
description
baseConnectionId
connectionSpec.id
data.format
json
.Resposta
Uma resposta bem-sucedida retorna o identificador exclusivo (id
) da conexão de origem recém-criada. Essa ID é necessária em uma etapa posterior para criar um fluxo de dados.
{
"id": "eb5833d3-230d-4700-80cc-bda396e7af8a",
"etag": "\"da04c07f-0000-0200-0000-621f1afc0000\""
}
Criar um esquema XDM de destino
Para que os dados de origem sejam usados no Experience Platform, um esquema de destino deve ser criado para estruturar os dados de origem de acordo com suas necessidades. O esquema de destino é usado para criar um conjunto de dados do Experience Platform no qual os dados de origem estão contidos.
Um esquema XDM de destino pode ser criado executando uma solicitação POST para a API do Registro de Esquema.
Para obter etapas detalhadas sobre como criar um esquema XDM de destino, consulte o tutorial sobre criação de um esquema usando a API.
Criar um conjunto de dados de destino
Um conjunto de dados de destino pode ser criado executando uma solicitação POST para a API de Serviço de Catálogo, fornecendo a ID do esquema de destino na carga.
Para obter etapas detalhadas sobre como criar um conjunto de dados de destino, consulte o tutorial sobre criação de um conjunto de dados usando a API.
Criar uma conexão de destino
Uma conexão de destino representa a conexão com o destino em que os dados assimilados devem ser armazenados. Para criar uma conexão de destino, você deve fornecer a ID de especificação de conexão fixa que corresponde ao Data Lake. Esta ID é: c604ff05-7f1a-43c0-8e18-33bf874cb11c
.
Agora você tem os identificadores exclusivos, um esquema de destino, um conjunto de dados de destino e a ID de especificação da conexão para o Data Lake. Usando esses identificadores, você pode criar uma conexão de destino usando a API Flow Service para especificar o conjunto de dados que conterá os dados de origem de entrada.
Formato da API
POST /targetConnections
Solicitação
A solicitação a seguir cria uma conexão de destino para OneTrust Integration:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-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": "ONETRUST Target Connection",
"description": "ONETRUST Target Connection",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "json"
},
"params": {
"dataSetId": "61f6ca3f33978c19486bb463"
}
}'
name
description
connectionSpec.id
c604ff05-7f1a-43c0-8e18-33bf874cb11c
.data.format
params.dataSetId
Resposta
Uma resposta bem-sucedida retorna o identificador exclusivo (id
) da nova conexão de destino. Essa ID é necessária nas etapas posteriores.
{
"id": "495f761f-310a-4a7b-ae78-5b1152d74b38",
"etag": "\"410a7b0c-0000-0200-0000-621f1afd0000\""
}
Criar um mapeamento
Para que os dados de origem sejam assimilados em um conjunto de dados de destino, eles devem primeiro ser mapeados para o esquema de destino ao qual o conjunto de dados de destino adere. Isso é feito executando uma solicitação POST para Data Prep API com mapeamentos de dados definidos na carga da solicitação.
Formato da API
POST /conversion/mappingSets
Solicitação
curl -X POST \
'https://platform.adobe.io/data/foundation/conversion/mappingSets' \
-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 '{
"version": 0,
"xdmSchema": "https://ns.adobe.com/{TENANT_ID}/schemas/cfc8cee182e546c1fb35071185524b465e06bf1acb74f30d",
"xdmVersion": "1.0",
"id": null,
"mappings": [{
"sourceType": "ATTRIBUTE",
"source": "content.Identifier",
"destination": "_id",
"name": "id",
"description": "Identifier field"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.Identifier",
"destination": "_exchangesandboxbravo.Identifier"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.Language",
"destination": "_exchangesandboxbravo.Language",
"description": "Language field"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.CreatedDate",
"destination": "_exchangesandboxbravo.CreatedDate",
"description": "Created Date field"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.LastUpdatedDate",
"destination": "_exchangesandboxbravo.LastUpdatedDate",
"description": "Created Date field"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.DataElements",
"destination": "_exchangesandboxbravo.DataElements"
},
{
"sourceType": "ATTRIBUTE",
"source": "content.Purposes",
"destination": "_exchangesandboxbravo.Purposes"
}
]
}'
xdmSchema
mappings.destinationXdmPath
mappings.sourceAttribute
Resposta
Uma resposta bem-sucedida retorna detalhes do mapeamento recém-criado, incluindo seu identificador exclusivo (id
). Esse valor é necessário em uma etapa posterior para criar um fluxo de dados.
{
"id": "a87f130e82f04d5188da01f087805c4b",
"version": 0,
"createdDate": 1646205694395,
"modifiedDate": 1646205694395,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
Criar um fluxo
A última etapa para trazer dados de OneTrust Integration para a Experience Platform é criar um fluxo de dados. Até agora, você tem os seguintes valores necessários preparados:
Um fluxo de dados é responsável por agendar e coletar dados de uma origem. Você pode criar um fluxo de dados executando uma solicitação POST enquanto fornece os valores mencionados anteriormente na carga.
Para agendar uma assimilação, primeiro defina o valor da hora inicial como a época em segundos. Em seguida, defina o valor de frequência para uma das cinco opções: once
, minute
, hour
, day
ou week
. O valor do intervalo designa o período entre duas assimilações consecutivas. No entanto, criar uma assimilação única não requer que um intervalo seja definido. Para todas as outras frequências, o valor do intervalo deve ser definido como igual ou maior que 15
.
Formato da API
POST /flows
Solicitação
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-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": "ONETRUST dataflow",
"description": "ONETRUST dataflow",
"flowSpec": {
"id": "6499120c-0b15-42dc-936e-847ea3c24d72",
"version": "1.0"
},
"sourceConnectionIds": [
"eb5833d3-230d-4700-80cc-bda396e7af8a"
],
"targetConnectionIds": [
"495f761f-310a-4a7b-ae78-5b1152d74b38"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "a87f130e82f04d5188da01f087805c4b",
"mappingVersion": 0
}
}
],
"scheduleParams": {
"startTime": "1625040887",
"frequency": "minute",
"interval": 15
}
}'
name
description
flowSpec.id
6499120c-0b15-42dc-936e-847ea3c24d72
.flowSpec.version
1.0
.sourceConnectionIds
targetConnectionIds
transformations
transformations.name
transformations.params.mappingId
transformations.params.mappingVersion
0
.scheduleParams.startTime
scheduleParams.frequency
once
, minute
, hour
, day
ou week
.scheduleParams.interval
once
e deve ser maior ou igual a 15
para outros valores de frequência.Resposta
Uma resposta bem-sucedida retorna a ID (id
) do fluxo de dados recém-criado. Você pode usar essa ID para monitorar, atualizar ou excluir seu fluxo de dados.
{
"id": "70045189-42f0-493d-9b9e-be1045a9f4fa",
"etag": "\"1601e900-0000-0200-0000-621f1b080000\""
}
Apêndice
A seção a seguir fornece informações sobre as etapas que podem ser seguidas para monitorar, atualizar e excluir o fluxo de dados.
Monitorar seu fluxo de dados
Depois que o fluxo de dados for criado, você poderá monitorar os dados que estão sendo assimilados por meio dele para ver informações sobre execuções de fluxo, status de conclusão e erros. Para obter exemplos completos de API, leia o guia em monitorando seus fluxos de dados de fontes usando a API.
Atualizar seu fluxo de dados
Atualize os detalhes do seu fluxo de dados, como seu nome e descrição, bem como seu agendamento de execução e conjuntos de mapeamento associados fazendo uma solicitação PATCH para o ponto de extremidade /flows
da API Flow Service, ao mesmo tempo em que fornece a ID do seu fluxo de dados. Ao fazer uma solicitação PATCH, você deve fornecer o etag
exclusivo do fluxo de dados no cabeçalho If-Match
. Para obter exemplos completos de API, leia o guia em atualizando fluxos de dados de fontes usando a API.
Atualizar sua conta
Atualize o nome, a descrição e as credenciais da conta de origem executando uma solicitação PATCH para a API Flow Service enquanto fornece a ID da conexão base como um parâmetro de consulta. Ao fazer uma solicitação PATCH, você deve fornecer o etag
exclusivo da sua conta de origem no cabeçalho If-Match
. Para obter exemplos completos de API, leia o guia em atualizando a conta de origem usando a API.
Excluir seu fluxo de dados
Exclua seu fluxo de dados executando uma solicitação DELETE para a API Flow Service enquanto fornece a ID do fluxo de dados que você deseja excluir como parte do parâmetro de consulta. Para obter exemplos completos de API, leia o guia em excluindo seus fluxos de dados usando a API.
Excluir sua conta
Exclua sua conta executando uma solicitação DELETE para a API Flow Service enquanto fornece a ID de conexão básica da conta que você deseja excluir. Para obter exemplos completos de API, leia o guia em excluindo sua conta de origem usando a API.