使用API创建Flow Service实体的草稿
您可以在Flow Service API中使用mode=draft
查询参数将Flow Service实体(如基础连接、源连接、目标连接和数据流)设置为草稿状态。
草稿稍后可以使用新信息更新,然后在准备就绪后使用op=publish
查询参数发布。
本教程提供了有关如何将Flow Service实体设置为草稿状态,并允许您暂停和保存工作流以供以后完成的步骤。
快速入门
本教程要求您实际了解Adobe Experience Platform的以下组件:
使用平台API
有关如何成功调用平台API的信息,请参阅平台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和相应的电子标记。 您可以稍后使用此ID来更新和发布基本连接。
{
"id": "f9377f50-607a-4818-b77f-50607a181860",
"etag": "\"2f0276fa-0000-0200-0000-5eab3abb0000\""
}
Publish您的草稿基本连接 publish-your-draft-base-connection
准备好发布草稿后,向/connections
端点发出POST请求并提供要发布的草稿基础连接的ID以及用于发布的操作操作。
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和相应的电子标记。
{
"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请求,并提供要发布的草稿源连接的ID以及用于发布的操作操作。
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
要创建草稿POST连接,请向Flow Service API的/targetConnections
端点发出目标请求,并提供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草稿target连接 publish-your-draft-target-connection
准备好发布草稿后,向/targetConnections
端点发出POST请求并提供要发布的草稿ID以及用于发布的操作操作。
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
准备好发布草稿后,在提供要发布的草稿数据流的ID的同时向/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\""
}