Skapa utkast av dina Flow Service-enheter med API:t
Du kan använda frågeparametern mode=draft
i Flow Service API för att ange dina Flow Service-entiteter som dina basanslutningar, källanslutningar, målanslutningar och dataflöden till ett utkasttillstånd.
Utkast kan uppdateras senare med ny information och sedan publiceras när de är klara med frågeparametern op=publish
.
I den här självstudiekursen beskrivs hur du ställer in dina Flow Service-entiteter till ett utkasttillstånd och låter dig pausa och spara arbetsflödena för slutförande vid ett senare tillfälle.
Komma igång
Den här självstudiekursen kräver att du har en fungerande förståelse för följande komponenter i Adobe Experience Platform:
- Källor: Experience Platform tillåter data att hämtas från olika källor samtidigt som du kan strukturera, etikettera och förbättra inkommande data med hjälp av plattformstjänster.
- Sandlådor: Experience Platform tillhandahåller virtuella sandlådor som partitionerar en enda plattformsinstans till separata virtuella miljöer för att utveckla och utveckla program för digitala upplevelser.
Använda plattforms-API:er
Mer information om hur du kan anropa plattforms-API:er finns i guiden Komma igång med plattforms-API:er.
Kontrollera om det finns stöd för utkastläge
Du måste också kontrollera om anslutningsspecifikations-ID och motsvarande flödespec-ID för källan som du använder är aktiverat för utkastläge.
accordion | ||
---|---|---|
Begäran | ||
Följande begäran hämtar anslutningsinformationen för Azure File Storage:
|
accordion | ||
---|---|---|
svar | ||
Ett lyckat svar returnerar anslutningsinformationen för källan. Kontrollera att
|
accordion | ||
---|---|---|
Begäran | ||
Följande begäran hämtar flödesspecifikationsinformation för en molnlagringskälla:
|
accordion | ||
---|---|---|
svar | ||
Ett lyckat svar returnerar flödesspecifikationsinformationen för källan. Kontrollera att
|
Skapa ett utkast till basanslutning create-a-draft-base-connection
Om du vill skapa en utkastsbasanslutning skickar du en POST till /connections
-slutpunkten för Flow Service API:t och anger mode=draft
som en frågeparameter.
API-format
POST /connections?mode=draft
mode
mode
till draft
.Begäran
Följande begäran skapar en utkastsbasanslutning för källan Azure File Storage:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections?mode=draft' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "ACME Azure File Storage Base Connection",
"description": "Azure File Storage base connection for ACME data (DRAFT)",
"auth": {
"specName": "Basic Authentication",
"params": {
"host": "{HOST}",
"userId": "{USER_ID}",
"password": "{PASSWORD}"
}
},
"connectionSpec": {
"id": "be5ec48c-5b78-49d5-b8fa-7c89ec4569b8",
"version": "1.0"
}
}'
Svar
Ett lyckat svar returnerar basanslutnings-ID:t och motsvarande tagg för utkastet till basanslutning. Du kan använda det här ID:t senare för att uppdatera och publicera din basanslutning.
{
"id": "f9377f50-607a-4818-b77f-50607a181860",
"etag": "\"2f0276fa-0000-0200-0000-5eab3abb0000\""
}
Publish din utkastanslutning publish-your-draft-base-connection
När utkastet är klart att publiceras kan du göra en POST-förfrågan till slutpunkten /connections
och ange ID:t för den utkastbasanslutning som du vill publicera samt en åtgärd för publicering.
API-format
POST /connections/{BASE_CONNECTION_ID}/action?op=publish
op
op
till publish
.Begäran
Följande begäran publicerar utkastet till basanslutning för Azure File Storage som skapades i ett tidigare steg.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections/f9377f50-607a-4818-b77f-50607a181860/action?op=publish' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
Svar
Ett lyckat svar returnerar ID:t och motsvarande tagg för din publicerade basanslutning.
{
"id": "f9377f50-607a-4818-b77f-50607a181860",
"etag": "\"2f0276fa-0000-0200-0000-5eab3abb0000\""
}
Skapa en utkastskällanslutning create-a-draft-source-connection
Om du vill skapa en utkastskällanslutning skickar du en POST till /sourceConnections
-slutpunkten för Flow Service API:t och anger mode=draft
som en frågeparameter.
API-format
POST /sourceConnections?mode=draft
mode
mode
till draft
.Begäran
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections?mode=draft' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "ACME Azure File Storage Source Connection",
"description: "Azure File Storage source connection for ACME data (DRAFT)",
"baseConnectionId": "f9377f50-607a-4818-b77f-50607a181860",
"data": {
"format": "delimited",
},
"params": {
"path": "/acme/summerCampaign/account.csv",
"type": "file"
},
"connectionSpec": {
"id": "be5ec48c-5b78-49d5-b8fa-7c89ec4569b8",
"version": "1.0"
}
}'
Svar
Ett lyckat svar returnerar källanslutnings-ID och motsvarande tagg för utkastkällanslutningen. Du kan använda det här ID:t senare för att uppdatera och publicera din källanslutning.
{
"id": "26b53912-1005-49f0-b539-12100559f0e2",
"etag": "\"11004d97-0000-0200-0000-5f3c3b140000\""
}
Publish din utkastkällanslutning publish-your-draft-source-connection
När utkastet är klart att publiceras gör du en POST till slutpunkten /sourceConnections
och anger ID:t för den utkastkällanslutning som du vill publicera samt en åtgärd för publicering.
API-format
POST /sourceConnections/{SOURCE_CONNECTION_ID}/action?op=publish
op
op
till publish
.Begäran
Följande begäran publicerar utkastskällanslutningen för Azure File Storage som skapades i ett tidigare steg.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections/26b53912-1005-49f0-b539-12100559f0e2/action?op=publish' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
Svar
Ett lyckat svar returnerar ID:t och motsvarande tagg för den publicerade källanslutningen.
{
"id": "26b53912-1005-49f0-b539-12100559f0e2",
"etag": "\"11004d97-0000-0200-0000-5f3c3b140000\""
}
Skapa en målanslutning för utkast create-a-draft-target-connection
Om du vill skapa en målanslutning för utkast, skickar du en POST till /targetConnections
-slutpunkten för Flow Service API:t och anger mode=draft
som en frågeparameter.
API-format
POST /targetConnections?mode=draft
mode
mode
till draft
.Begäran
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections?mode=draft' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "ACME Azure File Storage Target Connection",
"description": "Azure File Storage target connection ACME data (DRAFT)",
"data": {
"schema": {
"id": "{SCHEMA_ID}",
"version": "application/vnd.adobe.xed-full+json;version=1"
}
},
"params": {
"dataSetId": "{DATASET_ID}"
},
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}'
Svar
Ett lyckat svar returnerar målanslutnings-ID och motsvarande tagg för utkastet till målanslutning. Du kan använda det här ID:t senare för att uppdatera och publicera målanslutningen.
{
"id": "dbc5c132-bc2a-4625-85c1-32bc2a262558",
"etag": "\"8e000533-0000-0200-0000-5f3c40fd0000\""
}
Publish din målanslutning för utkast publish-your-draft-target-connection
När utkastet är klart att publiceras gör du en POST till slutpunkten /targetConnections
och anger ID:t för den målanslutning du vill publicera samt en åtgärd för publicering.
API-format
POST /targetConnections/{TARGET_CONNECTION_ID}/action?op=publish
op
op
till publish
.Begäran
Följande begäran publicerar utkastet till målanslutning för Azure File Storage som skapades i ett tidigare steg.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections/dbc5c132-bc2a-4625-85c1-32bc2a262558/action?op=publish' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
Svar
Ett lyckat svar returnerar ID:t och motsvarande tagg för den publicerade målanslutningen.
{
"id": "dbc5c132-bc2a-4625-85c1-32bc2a262558",
"etag": "\"8e000533-0000-0200-0000-5f3c40fd0000\""
}
Skapa ett utkast till dataflöde create-a-draft-dataflow
Om du vill ange ett dataflöde som ett utkast gör du en POST till slutpunkten /flows
samtidigt som du lägger till mode=draft
som en frågeparameter. På så sätt kan du skapa ett dataflöde och spara det som ett utkast.
API-format
POST /flows?mode=draft
mode
mode
till draft
.Begäran
Följande begäran skapar ett utkast till dataflöde.
'https://platform.adobe.io/data/foundation/flowservice/flows?mode=draft' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "ACME Azure File Storage Dataflow",
"description": "Azure File Storage dataflow for ACME data (DRAFT)",
"sourceConnectionIds": [
"26b53912-1005-49f0-b539-12100559f0e2"
],
"targetConnectionIds": [
"dbc5c132-bc2a-4625-85c1-32bc2a262558"
],
"flowSpec": {
"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"version": "1.0"
}
}'
Svar
Ett lyckat svar returnerar flödes-ID och motsvarande tagg för utkastet av dataflöde. Du kan använda det här ID:t senare för att uppdatera och publicera dataflödet.
{
"id": "c9751426-dff8-49b0-965f-50defcf4187b",
"etag": "\"69057131-0000-0200-0000-640f48320000\""
}
Publish ditt datautkastflöde publish-your-draft-dataflow
När utkastet är klart att publiceras kan du göra en POST-förfrågan till /flows
-slutpunkten och ange ID:t för det utkastdataflöde som du vill publicera samt en åtgärd för publicering.
API-format
POST /flows/{FLOW_ID}/action?op=publish
op
op
till publish
.Begäran
Följande begäran publicerar ditt utkast till dataflöde.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows/c9751426-dff8-49b0-965f-50defcf4187b/action?op=publish' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
Svar
Ett lyckat svar returnerar ID:t och motsvarande etag
i dataflödet.
{
"id": "c9751426-dff8-49b0-965f-50defcf4187b",
"etag": "\"69057131-0000-0200-0000-640f48320000\""
}
Nästa steg
Genom att följa den här självstudiekursen har du lärt dig hur du skapar utkast för dina Flow Service-entiteter och publicerar dessa utkast. Mer information om källor finns i Källöversikt.