이 자습서에서는 다음을 사용하여 기본 정보, 일정 및 매핑 세트를 포함하여 데이터 흐름을 업데이트하는 단계를 설명합니다. Flow Service API.
이 자습서를 사용하려면 유효한 흐름 ID가 있어야 합니다. 유효한 흐름 ID가 없는 경우 소스 개요 이 자습서를 시도하기 전에 설명된 단계를 따르십시오.
또한 이 자습서에서는 Adobe Experience Platform의 다음 구성 요소를 이해하고 있어야 합니다.
Platform API를 성공적으로 호출하는 방법에 대한 자세한 내용은 의 안내서를 참조하십시오. platform API 시작하기.
데이터 흐름을 업데이트하는 첫 번째 단계는 흐름 ID를 사용하여 데이터 흐름 세부 정보를 검색하는 것입니다. 에 GET 요청을 하여 기존 데이터 흐름의 현재 세부 정보를 볼 수 있습니다. /flows
엔드포인트.
API 형식
GET /flows/{FLOW_ID}
매개변수 | 설명 |
---|---|
{FLOW_ID} |
고유 id 검색할 데이터 흐름의 값입니다. |
요청
다음 요청은 플로우 ID에 대한 업데이트된 정보를 검색합니다.
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/flows/2edc08ac-4df5-4fe6-936f-81a19ce92f5c' \
-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}'
응답
성공적인 응답은 버전, 일정 및 고유 식별자( )를 포함하여 데이터 흐름의 현재 세부 정보를 반환합니다id
).
{
"items": [
{
"id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
"createdAt": 1612310475905,
"updatedAt": 1614122324830,
"createdBy": "{CREATED_BY}",
"updatedBy": "{UPDATED_BY}",
"createdClient": "{CREATED_CLIENT}",
"updatedClient": "{UPDATED_CLIENT}",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "{ORG_ID}",
"name": "Database dataflow using BigQuery",
"description": "collecting test1.Mytable from Google BigQuery",
"flowSpec": {
"id": "14518937-270c-4525-bdec-c2ba7cce3860",
"version": "1.0"
},
"state": "enabled",
"version": "\"5400d99c-0000-0200-0000-60358d540000\"",
"etag": "\"5400d99c-0000-0200-0000-60358d540000\"",
"sourceConnectionIds": [
"b7581b59-c603-4df1-a689-d23d7ac440f3"
],
"targetConnectionIds": [
"320f119a-5ac1-4ab1-88ea-eb19e674ea2e"
],
"inheritedAttributes": {
"sourceConnections": [
{
"id": "b7581b59-c603-4df1-a689-d23d7ac440f3",
"connectionSpec": {
"id": "3c9b37f8-13a6-43d8-bad3-b863b941fedd",
"version": "1.0"
},
"baseConnection": {
"id": "6990abad-977d-41b9-a85d-17ea8cf1c0e4",
"connectionSpec": {
"id": "3c9b37f8-13a6-43d8-bad3-b863b941fedd",
"version": "1.0"
}
}
}
],
"targetConnections": [
{
"id": "320f119a-5ac1-4ab1-88ea-eb19e674ea2e",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}
]
},
"scheduleParams": {
"startTime": "1612310466",
"frequency": "week",
"interval": "15",
"backfill": "true"
},
"transformations": [
{
"name": "Copy",
"params": {
"deltaColumn": {
"name": "Datefield",
"dateFormat": "YYYY-MM-DD",
"timezone": "UTC"
}
}
},
{
"name": "Mapping",
"params": {
"mappingId": "0b090130b58b4819afc78b6dc98b484d",
"mappingVersion": "0"
}
}
],
"runs": "/flows/2edc08ac-4df5-4fe6-936f-81a19ce92f5c/runs",
"lastOperation": {
"started": 1614122316652,
"updated": 1614122324830,
"percentCompleted": 100.0,
"status": {
"value": "completed",
"errors": []
},
"ops": [
{
"op": "replace",
"path": "/scheduleParams/frequency",
"value": "week"
}
],
"operation": "update"
},
"lastRunDetails": {
"id": "a10cc80b-fbea-4c6b-873e-d7fd32f4d12d",
"state": "success",
"startedAtUTC": 1613079975512,
"completedAtUTC": 1613080027511
}
}
]
}
PATCH 데이터 흐름의 실행 일정, 이름 및 설명을 업데이트하려면 Flow Service 흐름 ID, 버전 및 사용할 새 일정을 제공하는 동안 API입니다.
다음 If-Match
PATCH 요청을 할 때 헤더가 필요합니다. 이 헤더의 값은 업데이트할 연결의 고유한 버전입니다. 데이터 흐름이 성공적으로 업데이트될 때마다 etag 값이 업데이트됩니다.
API 형식
PATCH /flows/{FLOW_ID}
요청
다음 요청은 플로우 실행 일정과 데이터 흐름의 이름 및 설명을 업데이트합니다.
curl -X PATCH \
'https://platform.adobe.io/data/foundation/flowservice/flows/2edc08ac-4df5-4fe6-936f-81a19ce92f5c' \
-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 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
-d '[
{
"op": "replace",
"path": "/scheduleParams/frequency",
"value": "day"
},
{
"op": "replace",
"path": "/name",
"value": "Database Dataflow Feb2021"
},
{
"op": "replace",
"path": "/description",
"value": "Database dataflow for testing update API"
}
]'
속성 | 설명 |
---|---|
op |
데이터 흐름을 업데이트하는 데 필요한 작업을 정의하는 데 사용되는 작업 호출입니다. 작업에는 다음이 포함됩니다. add , replace , 및 remove . |
path |
플로우에서 업데이트할 부분을 정의합니다. |
value |
매개 변수를 업데이트할 새 값입니다. |
응답
성공적인 응답은 흐름 ID와 업데이트된 etag를 반환합니다. 에 GET 요청을 하여 업데이트를 확인할 수 있습니다. Flow Service 흐름 ID를 제공하는 동안 API입니다.
{
"id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
"etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}
에 PATCH 요청을 하여 기존 데이터 흐름의 매핑 세트를 업데이트할 수 있습니다. Flow Service API 및 업데이트된 값 제공 mappingId
및 mappingVersion
.
API 형식
PATCH /flows/{FLOW_ID}
요청
다음 요청은 데이터 흐름의 매핑 세트를 업데이트합니다.
curl -X PATCH \
'https://platform.adobe.io/data/foundation/flowservice/flows/2edc08ac-4df5-4fe6-936f-81a19ce92f5c' \
-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 'If-Match: "50014cc8-0000-0200-0000-6036eb720000"' \
-d '[
{
"op": "replace",
"path": "/transformations/0",
"value": {
"name": "Mapping",
"params": {
"mappingId": "c5f22f04e09f44498e528901546a83b1",
"mappingVersion": 2
}
}
}
]'
속성 | 설명 |
---|---|
op |
데이터 흐름을 업데이트하는 데 필요한 작업을 정의하는 데 사용되는 작업 호출입니다. 작업에는 다음이 포함됩니다. add , replace , 및 remove . |
path |
플로우에서 업데이트할 부분을 정의합니다. 이 예에서는 transformations 을(를) 업데이트 중입니다. |
value.name |
업데이트할 속성의 이름입니다. |
value.params.mappingId |
데이터 흐름의 매핑 세트를 업데이트하는 데 사용할 새 매핑 ID입니다. |
value.params.mappingVersion |
업데이트된 매핑 ID와 연결된 새 매핑 버전입니다. |
응답
성공적인 응답은 흐름 ID와 업데이트된 etag를 반환합니다. 에 GET 요청을 하여 업데이트를 확인할 수 있습니다. Flow Service 흐름 ID를 제공하는 동안 API입니다.
{
"id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
"etag": "\"2c000802-0000-0200-0000-613976440000\""
}
이 자습서에 따라 다음을 사용하여 데이터 흐름의 기본 정보, 일정 및 매핑 세트를 업데이트했습니다. Flow Service API. 소스 커넥터 사용에 대한 자세한 내용은 소스 개요.