使用API建立Flow Service個實體的草稿
您可以在Flow Service API中使用mode=draft
查詢引數,將您的Flow Service實體(例如基礎連線、來源連線、目標連線和資料流)設定為草稿狀態。
草稿稍後可以使用新資訊進行更新,然後在準備就緒後使用op=publish
查詢引數發佈。
本教學課程提供如何將Flow Service實體設定為草稿狀態的步驟,並可讓您暫停並儲存工作流程以供日後完成。
快速入門
本教學課程需要您實際瞭解下列Adobe Experience Platform元件:
使用平台API
如需如何成功呼叫Platform API的詳細資訊,請參閱Platform API快速入門的指南。
檢查草稿模式支援
您也必須檢查您所使用之來源的連線規格ID與對應的流量規格ID是否已針對草稿模式啟用。
accordion | ||
---|---|---|
要求 | ||
下列要求會擷取Azure File Storage的連線規格資訊:
|
accordion | ||
---|---|---|
回應 | ||
成功的回應會傳回您來源的連線規格資訊。 若要驗證您的來源是否支援草稿模式,請檢查
|
accordion | ||
---|---|---|
要求 | ||
以下請求會擷取雲端儲存空間來源的流量規格詳細資料:
|
accordion | ||
---|---|---|
回應 | ||
成功的回應會傳回來源的流程規格資訊。 若要驗證您的來源是否支援草稿模式,請檢查
|
建立拔模基礎連線 create-a-draft-base-connection
若要建立草稿基底連線,請向Flow Service API的/connections
端點提出POST要求,並提供mode=draft
作為查詢引數。
API格式
POST /connections?mode=draft
mode
mode
設定為draft
。要求
下列要求會建立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"
}
}'
回應
成功的回應會傳回草稿基本連線的基本連線ID和對應的etag。 您可以稍後使用此ID來更新及發佈您的基礎連線。
{
"id": "f9377f50-607a-4818-b77f-50607a181860",
"etag": "\"2f0276fa-0000-0200-0000-5eab3abb0000\""
}
Publish您的草稿基底連線 publish-your-draft-base-connection
一旦您的草稿已準備好發佈,請向/connections
端點提出POST要求,並提供您要發佈的草稿基底連線識別碼,以及發佈的動作操作。
API格式
POST /connections/{BASE_CONNECTION_ID}/action?op=publish
op
op
設定為publish
。要求
下列要求會發佈在先前步驟建立的Azure File Storage草稿基底連線。
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}' \
回應
成功的回應會傳回已發佈基本連線的ID和對應的etag。
{
"id": "f9377f50-607a-4818-b77f-50607a181860",
"etag": "\"2f0276fa-0000-0200-0000-5eab3abb0000\""
}
建立草稿來源連線 create-a-draft-source-connection
若要建立草稿來源連線,請向Flow Service API的/sourceConnections
端點提出POST要求,並提供mode=draft
作為查詢引數。
API格式
POST /sourceConnections?mode=draft
mode
mode
設為draft
。要求
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"
}
}'
回應
成功的回應會傳回來源連線ID,以及草稿來源連線的對應標籤。 您可以稍後使用此ID來更新及發佈來源連線。
{
"id": "26b53912-1005-49f0-b539-12100559f0e2",
"etag": "\"11004d97-0000-0200-0000-5f3c3b140000\""
}
Publish您的草稿來源連線 publish-your-draft-source-connection
準備好要發佈草稿後,請向/sourceConnections
端點提出POST要求,並提供您要發佈的草稿來源連線識別碼,以及發佈的動作操作。
API格式
POST /sourceConnections/{SOURCE_CONNECTION_ID}/action?op=publish
op
op
設為publish
。要求
下列要求會發佈在先前步驟中建立的Azure File Storage的草稿來源連線。
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}' \
回應
成功的回應會傳回已發佈來源連線的ID和對應標籤。
{
"id": "26b53912-1005-49f0-b539-12100559f0e2",
"etag": "\"11004d97-0000-0200-0000-5f3c3b140000\""
}
建立草稿目標連線 create-a-draft-target-connection
若要建立草稿目標連線,請向Flow Service API的/targetConnections
端點提出POST要求,並提供mode=draft
作為查詢引數。
API格式
POST /targetConnections?mode=draft
mode
mode
設為draft
。要求
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"
}
}'
回應
成功回應會傳回目標連線ID,以及草稿目標連線的對應標籤。 您可以稍後使用此ID來更新及發佈目標連線。
{
"id": "dbc5c132-bc2a-4625-85c1-32bc2a262558",
"etag": "\"8e000533-0000-0200-0000-5f3c40fd0000\""
}
Publish您的草稿目標連線 publish-your-draft-target-connection
準備好要發佈草稿後,請向/targetConnections
端點提出POST要求,並提供您要發佈的草稿目標連線識別碼,以及發佈的動作操作。
API格式
POST /targetConnections/{TARGET_CONNECTION_ID}/action?op=publish
op
op
設為publish
。要求
下列要求會發佈在先前步驟建立的Azure File Storage目標連線草稿。
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}' \
回應
成功的回應會傳回已發佈目標連線的ID和對應標籤。
{
"id": "dbc5c132-bc2a-4625-85c1-32bc2a262558",
"etag": "\"8e000533-0000-0200-0000-5f3c40fd0000\""
}
建立草稿資料流 create-a-draft-dataflow
若要將資料流設定為草稿,請在將mode=draft
新增為查詢引數時對/flows
端點提出POST要求。 這可讓您建立資料流並將其儲存為草稿。
API格式
POST /flows?mode=draft
mode
mode
設為draft
。要求
以下請求會建立草稿資料流。
'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"
}
}'
回應
成功回應會傳回草稿資料流的流程ID和對應標籤。 您可以稍後使用此ID來更新及發佈資料流。
{
"id": "c9751426-dff8-49b0-965f-50defcf4187b",
"etag": "\"69057131-0000-0200-0000-640f48320000\""
}
Publish您的草稿資料流 publish-your-draft-dataflow
準備好要發佈草稿後,向/flows
端點提出POST要求,同時提供您要發佈的草稿資料流識別碼,以及發佈動作的操作。
API格式
POST /flows/{FLOW_ID}/action?op=publish
op
op
設為publish
。要求
以下請求會發佈您的草稿資料流。
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}' \
回應
成功的回應會傳回您的資料流的ID和對應的etag
。
{
"id": "c9751426-dff8-49b0-965f-50defcf4187b",
"etag": "\"69057131-0000-0200-0000-640f48320000\""
}