openapi: 3.2.0 info: description: "Use the Adobe Experience Platform Flow Service API to connect and activate data to various destinations within and outside of Adobe Experience Platform. This API reference is centered on exporting data to batch destinations like Amazon S3, SFTP, Azure Blob.\n>**NOTE**: Refer to [Flow Service API - Sources](https://developer.adobe.com/experience-platform-apis/references/flow-service/) if you are looking for API documentation to perform operations on *sources* in Experience Platform.\n- **Related documentation**:\n - [Destinations overview](http://www.adobe.com/go/destinations-overview-en)\n - [Activate data to file-based destinations - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/activate-segments-file-based-destinations.html)\n - [Activate data to streaming destinations - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/streaming-destinations.html)\n - [Update destination dataflows - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/update-destination-dataflows.html)\n - [Export datasets - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/export-datasets.html)\n\n- **API paths**:\n - PLATFORM Gateway URL: https://platform.adobe.io/\n - Base path for this API: /data/foundation/flowservice\n - Example of a complete path: https://platform.adobe.io/data/foundation/flowservice/flows\n\n- **Required headers**:\n - All service calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, see the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).\n - All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header `x-sandbox-name` whose value is the all-lowercase name of the sandbox the operation will take place in (for example, \"prod\"). See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.\n - All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header `Content-Type` with a value of `application/json`.\n\n- **API error handling**:\n - Refer to the Experience Platform API troubleshooting guide for [FAQs](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#faq), [API status codes](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#api-status-codes), and [request header errors](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#request-header-errors). You can also view a list of [common Flow Service error messages](https://experienceleague.adobe.com/docs/experience-platform/sources/errors/flow-service-errors.html) and resolution suggestions.\n\n\n- **Sorting and filtering responses**:\n - When performing listing (GET) requests in the Flow Service API, you can use query parameters to [sort and filter responses](https://experienceleague.adobe.com/docs/experience-platform/dataflows/api/sort-and-filter.html)." title: Flow Service API - Destinations Dataflows API version: 1.0.0 servers: - url: https://{environment}.adobe.io/data/foundation/flowservice description: Adobe IO gateway endpoint variables: environment: default: platform enum: - platform - platform-stage tags: - name: Dataflows description: Destination dataflows represent the data transfer between a source connection (Experience Platform) and a target connection (the destination you set up). This also includes information regarding the data export schedule, and the transformation specifications of the data being exported to your destination. A dataflow instance is specific to a tenant and organization. paths: /flows: get: tags: - Dataflows summary: Retrieve a list of destination dataflows description: 'You can retrieve a list of all destination dataflows for your organization by making a GET request to the `/flows` endpoint. When performing listing (GET) requests in the Flow Service API, you can use query parameters to [sort and filter responses](https://experienceleague.adobe.com/docs/experience-platform/dataflows/api/sort-and-filter.html).

Use `isDestinationFlow` as query parameter to return destination dataflows only, like this: `https://platform.adobe.io/data/foundation/flowservice/flows?property=inheritedAttributes.properties.isDestinationFlow==true`

Additionally, you can use query parameters to return only the dataflows for a specific destination. To do this, pass in the `connectionSpec.id` of the desired destination by using the `property` query parameter, as shown further below. See also the list of `connectionSpec` IDs for the most commonly used batch destinations:
>**NOTE**: This operation allows you to retrieve a maximum of 100 entities. The most recently created or updated entities are returned first. Use filters to return the dataflows that are most relevant to you. ' operationId: getFlows parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XApiKey' - $ref: '#/components/parameters/XImsOrgId' - $ref: '#/components/parameters/XSandboxId' - $ref: '#/components/parameters/Accept' - in: query name: property description: 'A comma-separated list of top-level object properties to be returned in the response. Used to cut down the amount of data returned in the response body. For example, `property=id==3416976c-a9ca-4bba-901a-1f08f66978ff,6a8d82b-1caf-45d1-908d-cadabc9d63a6,3c9b37f8-13a6-43d8-bad3-b863b941fedd`. ' required: false schema: type: string examples: filterDestinationDataflows: summary: Filter dataflows for destinations only value: inheritedAttributes.properties.isDestinationFlow==true filterS3Dataflows: summary: Filter dataflows for Amazon S3 destination value: inheritedAttributes.targetConnections[].connectionSpec.id==4fce964d-3f37-408f-9778-e597338a21ee filterSftpDataflows: summary: Filter dataflows for SFTP destination value: inheritedAttributes.targetConnections[].connectionSpec.id==36965a81-b1c6-401b-99f8-22508f1e6a26 - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/orderby' - $ref: '#/components/parameters/count' - $ref: '#/components/parameters/continuationToken' responses: '200': description: Successful operation. A successful response returns a list of dataflows that match the request parameters. x-summary: List of Dataflows Retrieved content: application/json: schema: oneOf: - $ref: '#/components/schemas/Batch_Flow' - $ref: '#/components/schemas/Streaming_Flow' examples: Flows: $ref: '#/components/examples/Batch_Flows' '401': description: The token provided in the Authorization header is invalid. x-summary: Invalid Authorization Token content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error_code: 401013 message: Oauth token is not valid '403': description: You are not authorized to perform this operation x-summary: Authorization Error - Access Denied content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: An Internal error occurred. x-summary: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' post: tags: - Dataflows summary: Create a destination dataflow description: 'You can create a destination dataflow by making a POST request to the `/flows` endpoint. ' operationId: postFlow parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/Content-type' - $ref: '#/components/parameters/XApiKey' - $ref: '#/components/parameters/XImsOrgId' - $ref: '#/components/parameters/XSandboxId' - $ref: '#/components/parameters/Accept' requestBody: required: true content: application/json: schema: oneOf: - $ref: '#/components/schemas/Create_Batch_Destination_Flow_Request' - $ref: '#/components/schemas/Create_Streaming_Destination_Flow_Request' - $ref: '#/components/schemas/Create_Batch_Destination_Flow_Request_V2' examples: Create_Batch_Destination_Flow: $ref: '#/components/examples/Create_Batch_Destination_Flow' Create_Batch_Destination_Flow_Dataset_V2: $ref: '#/components/examples/Create_Batch_Destination_Flow_Dataset_V2' Create_Batch_Destination_Flow_Segment_V2: $ref: '#/components/examples/Create_Batch_Destination_Flow_Segment_V2' responses: '201': description: A new destination dataflow was successfully created. The response contains the unique identifier (ID) and the etag value of the dataflow. x-summary: Dataflow Created Successfully content: application/json: schema: $ref: '#/components/schemas/Patch_Flow_Response' examples: Create_Flow_Response: $ref: '#/components/examples/Create_Flow_Response' '401': description: The token provided in the Authorization header is invalid. x-summary: Invalid Authorization Token content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error_code: 401013 message: Oauth token is not valid '403': description: You are not authorized to perform this operation x-summary: Authorization Error - Access Denied content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: An Internal error occurred. x-summary: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' /flows/{id}: get: tags: - Dataflows summary: Retrieve a destination dataflow's details description: 'You can retrieve detailed information about a specific destination dataflow by making a GET request to the `/flows` endpoint and providing the ID of the dataflow you want to inspect. ' operationId: getFlowById parameters: - name: id in: path description: The ID of the destination dataflow you are looking to retrieve. required: true schema: type: string - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XApiKey' - $ref: '#/components/parameters/XImsOrgId' - $ref: '#/components/parameters/XSandboxId' - $ref: '#/components/parameters/Accept' responses: '200': description: The specified dataflow was successfully retrieved. x-summary: Dataflow Details Retrieved content: application/json: schema: oneOf: - $ref: '#/components/schemas/Batch_Flow' - $ref: '#/components/schemas/Streaming_Flow' examples: Batch_Flow_Daily_Full_Once_Scheduled: $ref: '#/components/examples/Batch_Flow_Daily_Full_Once_Scheduled' Batch_Flow_Daily_Full_Once_Chained: $ref: '#/components/examples/Batch_Flow_Daily_Full_Once_Chained' Batch_Flow_Daily_Full_Scheduled: $ref: '#/components/examples/Batch_Flow_Daily_Full_Scheduled' Batch_Flow_Daily_Full_Chained: $ref: '#/components/examples/Batch_Flow_Daily_Full_Chained' Batch_Flow_First_Full_Then_Incremental_DAILY: $ref: '#/components/examples/Batch_Flow_First_Full_Then_Incremental_DAILY' Batch_Flow_First_Full_Then_Incremental_EVERY_3_HOURS: $ref: '#/components/examples/Batch_Flow_First_Full_Then_Incremental_EVERY_3_HOURS' Batch_Flow_Profile_Mapping_And_Identities_V2: $ref: '#/components/examples/Batch_Flow_Profile_Mapping_And_Identities_V2' Batch_Flow_External_Audience_Profile_Mapping_And_Identities: $ref: '#/components/examples/Batch_Flow_External_Audience_Profile_Mapping_And_Identities' Batch_Flow_Dataset_Schedule_V2: $ref: '#/components/examples/Batch_Flow_Dataset_Schedule_V2' '401': description: The token provided in the Authorization header is invalid. x-summary: Invalid Authorization Token content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error_code: 401013 message: Oauth token is not valid '403': description: You are not authorized to perform this operation x-summary: Authorization Error - Access Denied content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: The specified dataflow ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: Not Found - Dataflow ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: flows not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-] '500': description: An Internal error occurred. x-summary: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' patch: tags: - Dataflows summary: Update a destination dataflow description: 'You can update a destination dataflow by making a PATCH request to the `/flows` endpoint and providing the ID of the dataflow you want to update. In the body of the request, provide the updated configuration of the dataflow. ' operationId: patchFlowById parameters: - name: id in: path description: The ID of the destination dataflow you are looking to update. required: true schema: type: string - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XApiKey' - $ref: '#/components/parameters/XImsOrgId' - $ref: '#/components/parameters/XSandboxId' - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/Content-type' - $ref: '#/components/parameters/if-match' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Patch_Flow_Request' examples: Batch_Flow_Daily_Full_Once_Scheduled: $ref: '#/components/examples/Patch_Batch_Flow_Daily_Full_Once_Scheduled' Batch_Flow_External_Audience_Daily_Full_Once_Scheduled: $ref: '#/components/examples/Patch_Batch_Flow_External_Audience_Daily_Full_Once_Scheduled' Batch_Flow_Enrichment_Info_Daily_Full_Once_Scheduled: $ref: '#/components/examples/Patch_Batch_Flow_Enrichment_Info_Daily_Full_Once_Scheduled' Batch_Flow_Daily_Full_Once_Chained: $ref: '#/components/examples/Patch_Batch_Flow_Daily_Full_Once_Chained' Add_Profile_Selectors: $ref: '#/components/examples/Patch_Profile_Selectors' Update_Source_Connection: $ref: '#/components/examples/Patch_Source_Connection' Update_Dataset_Schedule: $ref: '#/components/examples/Patch_Dataset_Schedule_Params' Patch_Profile_Mapping: $ref: '#/components/examples/Patch_Profile_Mapping' Patch_Primary_Fields: $ref: '#/components/examples/Patch_Primary_Fields' Patch_Mandatory_Fields: $ref: '#/components/examples/Patch_Mandatory_Fields' responses: '200': description: Details of your newly updated dataflow are returned. x-summary: Dataflow Updated Successfully content: application/json: schema: $ref: '#/components/schemas/Patch_Flow_Response' examples: Patch_Flow_Response: $ref: '#/components/examples/Patch_Flow_Response' '401': description: The token provided in the Authorization header is invalid. x-summary: Invalid Authorization Token content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error_code: 401013 message: Oauth token is not valid '403': description: You are not authorized to perform this operation x-summary: Authorization Error - Access Denied content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: The specified dataflow ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: Not Found - Dataflow ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: flows not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-] errorDetails: flows not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-] '412': description: Pre-condition failed error. This can occur if the supplied eTag does not match the latest eTag for the resource.
To resolve this, you need to fetch the entity again, make sure that your changes are compatible with new version of the entity, then place the new etag in the If-Match header, and finally make the API call. x-summary: Precondition Failed - ETag Mismatch content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: Supplied version=["04001277-0000-0200-0000-62d9b13e00001"] does not match the current version on entity=["0400117f-0000-0200-0000-62d9bca50000"] errorDetails: Supplied version=["04001277-0000-0200-0000-62d9b13e00001"] does not match the current version on entity=["0400117f-0000-0200-0000-62d9bca50000"] '500': description: An Internal error occurred. x-summary: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' delete: tags: - Dataflows summary: Delete a destination dataflow description: 'You can delete the specified destination dataflow by making a DELETE request to the `/flows` endpoint and providing the ID of the dataflow that you wish to delete in the request path. ' operationId: deleteFlowById parameters: - name: id in: path description: The ID of the destination dataflow you are looking to delete. required: true schema: type: string - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XApiKey' - $ref: '#/components/parameters/XImsOrgId' - $ref: '#/components/parameters/XSandboxId' - $ref: '#/components/parameters/Accept' responses: '202': description: A successful response returns HTTP status 202 (No Content) and a blank body. You can confirm the deletion by attempting a lookup (GET) request to the dataflow. The API will return an HTTP 404 (Not Found) error, indicating that the dataflow has been deleted. x-summary: Deletion Accepted - Dataflow Marked for Deletion '401': description: The token provided in the Authorization header is invalid. x-summary: Invalid Authorization Token content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error_code: 401013 message: Oauth token is not valid '403': description: You are not authorized to perform this operation x-summary: Authorization Error - Access Denied content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: The specified dataflow ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: Not Found - Dataflow ID Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: flows not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-] '500': description: An Internal error occurred. x-summary: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: BaseSegmentSelectorValue: type: object title: Segment Selector Value Object description: "Contains the fields that are relevant for the segment activation, including information about the export schedule, export mode, and more. \n" properties: id: type: string title: Segment ID description: Specify the ID of the segment you are adding to the destination dataflow. systemSegmentId: type: string title: System Segment ID description: An identifier used for externally generated audiences brought into Experience Platform. namespace: type: string title: Namespace description: Indicates the origin of the audience. An external origin describes external audiences brought into Experience Platform, while an internal origin describes audiences created in Experience Platform through the Segmentation Service. name: type: string title: Segment name description: Specify the name of the segment you are adding to the destination dataflow. Note that this field is not mandatory and you can successfully add a segment to the destination dataflow without providing its name. description: type: string title: Description description: Specify the description of the segment you are adding to the destination dataflow. Note that this field is not mandatory and you can successfully add a segment to the destination dataflow without providing its description. exportMode: type: string title: Export Mode description: "For more information about the two options, refer to [export full files](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#export-full-files) and [export incremental files](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#export-incremental-files) in the batch destinations activation tutorial. \n" enum: - DAILY_FULL_EXPORT - FIRST_FULL_THEN_INCREMENTAL createTime: type: string title: Create Time description: A system-generated time in epoch seconds to represent when the segment was first activated to the flow. example: '1658344069' updateTime: type: string title: Update Time description: A system-generated time in epoch seconds to represent when the segment activation details were modified. example: '1658427026' schedule: type: object description: Indicates various settings related to the export schedule of a segment to your destination. properties: frequency: type: string title: Export Frequency description: Indicates the frequency with which files are exported from Experience Platform to your destination. The options `EVERY_3_HOURS`, `EVERY_6_HOURS`, `EVERY_8_HOURS`, `EVERY_12_HOURS` are supported for incremental file exports only. enum: - ONCE - DAILY - EVERY_3_HOURS - EVERY_6_HOURS - EVERY_8_HOURS - EVERY_12_HOURS triggerType: type: string title: Trigger Type description: 'This field is required only when selecting the `DAILY_FULL_EXPORT` mode in the frequency selector. Supported frequency types are `ONCE` and `DAILY`.
Select `AFTER_SEGMENT_EVAL` to have the activation job run immediately after the daily Platform batch segmentation job completes. This ensures that when the activation job runs, the most up-to-date profiles are exported to your destination.
Select `SCHEDULED` to have the activation job run at a fixed time. This ensures that Experience Platform profile data is exported at the same time each day, but the profiles you export may not be the most up-to -date, depending on whether the batch segmentation job has completed before the activation job starts. When selecting this option, you must also add a `startTime` to indicate at which time in UTC the daily exports should occur. ' enum: - SCHEDULED - AFTER_SEGMENT_EVAL startDate: type: string title: Start Date description: The date when the segment should start exporting profiles to your destination.
The correct format is `YYYY-MM-DD`. example: '2022-07-20' endDate: type: string title: End Date description: 'Not applicable when selecting `"exportMode":"DAILY_FULL_EXPORT"` and `"frequency":"ONCE"`. Sets the date when segment members stop being exported to the destination.
The correct format is `YYYY-MM-DD`. ' example: '2022-07-29' startTime: type: string title: Start Time description: 'A 24-hour format to represent when files containing members of the segment should be generated and exported to your destination. Note: This field is not applicable when you define `"exportMode":"DAILY_FULL_EXPORT"` and `"triggerType"="AFTER_SEGMENT_EVAL"`.
The correct format is `HH:MM`. Minutes must be `00`. ' example: '20:00' FlowSpec_V2: type: object title: (Beta) Flow Spec description: Model to capture the flow specification. Each destination has a specific flow spec ID in Experience Platform. properties: id: type: string title: Flow Spec ID. enum: - 1a0514a6-33d4-4c7f-aff8-594799c47549 - 269ba276-16fc-47db-92b0-c1049a3c131f - fd36aaa4-bf2b-43fb-9387-43785eeeb799 - 354d6aad-4754-46e4-a576-1b384561c440 - 752d422f-b16f-4f0d-b1c6-26e448e3b388 - 95bd8965-fc8a-4119-b9c3-944c2c2df6d2 - 976d663b-80b4-4193-be6b-2d0487516623 - 585c15c4-6cbf-4126-8f87-e26bff78b657 - 7e635b9f-e59b-4546-8ba8-fce6496693c8 - cd2fc47e-e838-4f38-a581-8fff2f99b63a - db060570-a155-418a-a6d3-b4d97698e5dc - 17be2013-2549-41ce-96e7-a70363bec293 description: "The Flow Spec ID of the destination that you are looking to connect and activate segments or datasets to. To retrieve the flow spec ID, perform a `GET` operation on the `flowspecs` endpoint, as shown in the [flow specs API reference documentation](https://developer.adobe.com/experience-platform-apis/references/flow-service/#operation/retrieveFlowSpec). Please note that these beta destinations support both dataset and profile exports so use the appropriate Flow Spec ID.

\nFlow Spec ID:\n * `1a0514a6-33d4-4c7f-aff8-594799c47549`: (Beta) Amazon S3 - Segment\n * `269ba276-16fc-47db-92b0-c1049a3c131f`: (Beta) Amazon S3 - Dataset\n * `fd36aaa4-bf2b-43fb-9387-43785eeeb799`: (Beta) SFTP - Segment\n * `354d6aad-4754-46e4-a576-1b384561c440`: (Beta) SFTP - Dataset\n * `752d422f-b16f-4f0d-b1c6-26e448e3b388`: (Beta) Azure Blob Storage - Segment\n * `95bd8965-fc8a-4119-b9c3-944c2c2df6d2`: (Beta) Azure Blob Storage - Dataset\n * `976d663b-80b4-4193-be6b-2d0487516623`: (Beta) Google Cloud Storage - Segment\n * `585c15c4-6cbf-4126-8f87-e26bff78b657`: (Beta) Google Cloud Storage - Dataset\n * `7e635b9f-e59b-4546-8ba8-fce6496693c8`: (Beta) Data Landing Zone - Segment\n * `cd2fc47e-e838-4f38-a581-8fff2f99b63a`: (Beta) Data Landing Zone - Dataset\n * `db060570-a155-418a-a6d3-b4d97698e5dc`: (Beta) Azure Data Lake Gen2 - Segment\n * `17be2013-2549-41ce-96e7-a70363bec293`: (Beta) Azure Data Lake Gen2 - Dataset\n" Patch_Flow_Response: type: object title: Patch Flow Response description: API response for a successful PATCH operation. properties: id: type: string title: Flow ID description: The dataflow ID for which the API request was made. etag: type: string title: E-Tag description: An updated etag for the dataflow ID. DatasetScheduleParams_V2: type: object title: Dataset Schedule Params description: Schedule params for controlling dataset exports schedule. required: - startTime - interval - timeUnit properties: exportMode: title: Export mode type: string description: Select `DAILY_FULL_EXPORT` or `FIRST_FULL_THEN_INCREMENTAL`.
`DAILY_FULL_EXPORT` can only be used in combination with `timeUnit`:`day` and `interval`:`0` for a one-time full export of the dataset. Daily full exports of datasets are not supported. If you need daily exports, use the incremental export option.
`FIRST_FULL_THEN_INCREMENTAL` triggers an export of one or multiple files representing a full snapshot of the dataset. Subsequent files are incremental additions to the dataset since the previous export. enum: - DAILY_FULL_EXPORT - FIRST_FULL_THEN_INCREMENTAL startTime: title: Start Time type: integer description: The start time of the dataset export expressed as a timestamp in epoch **seconds**. endTime: title: End Time type: integer description: The scheduled time of the dataset export expressed as a timestamp in epoch **seconds**. interval: title: Interval type: integer description: The interval of the dataset export frequency. Note that only 3,6,9, or 12-hour and 1-day frequencies are supported. enum: - 1 - 3 - 6 - 9 - 12 timeUnit: description: The time unit of the dataset export frequency. Note that only 3,6,9, or 12-hour and 1-day frequencies are supported. type: string enum: - hour - day folderNameTemplate: type: string title: Folder Name Template description: 'Specify the expected folder name structure in your storage location where the exported files will be deposited. Several macros are available to use, as listed below. All these macros are optional.

' example: '%DESTINATION_NAME%_%DATASET_ID%_%DATASET_NAME%_%DATETIME(YYYYMMdd_HHmmss)%' StreamingTransformations: type: object Create_Streaming_Destination_Flow_Request: type: object title: Create Streaming Destination Flow Request. description: Model for defining request body for create flow API. required: - name - flowSpec - sourceConnectionIds - targetConnectionIds - transformations properties: name: type: string title: Flow Name description: A suitable flow name. description: type: string title: Flow Description description: An optional flow description. flowSpec: $ref: '#/components/schemas/FlowSpec' sourceConnectionIds: $ref: '#/components/schemas/SourceConnectionIds' targetConnectionIds: $ref: '#/components/schemas/TargetConnectionIds' transformations: type: string title: TBD BatchTransformations: type: object required: - transformations properties: transformations: type: array title: Flow Transformations description: 'A list of dataflow transformations and other mapping fields relevant to the exported profiles. Individual profile fields are described further below.
For dataset dataflows, the `transformations` list will always be empty. ' items: $ref: '#/components/schemas/BatchTransformation' SourceConnectionIds: type: array title: Source Connection IDs description: 'Add one source connection ID, which enables the connection to your Experience Platform data. Follow the step [Connect to your Experience Platform data](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/connect-activate-batch-destinations.html#connect-to-your-experience-platform-data) to learn how to obtain a source connection ID. ' items: type: string BatchSegmentSelector_V2: type: object title: (Beta) Segment Selector description: 'A segment selector object to define a segment for activation. For detailed explanation of each field, refer to the documentation link: https://experienceleague.adobe.com/docs/experience-platform/destinations/api/connect-activate-batch-destinations.html#activate-data. ' properties: type: type: string title: Segment Type description: Use the hardcoded value `PLATFORM_SEGMENT`. enum: - PLATFORM_SEGMENT value: allOf: - $ref: '#/components/schemas/BaseSegmentSelectorValue' - type: object properties: fileNameTemplate: type: string title: (Beta) File Name Template description: 'This field determines the file name format of the files that are exported to your destination. Several macros are available to use, as listed below:

' example: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' BaseFlowItem: type: object title: Flow Items description: Parameters specific to batch and streaming destination dataflows. required: - id - description - createdClient - updatedClient - createdBy - updatedBy - imsOrgId - sandboxId - sandboxName - etag - state - sourceConnectionIds - targetConnectionIds - inheritedAttributes properties: id: type: string title: Flow ID description: The ID of the dataflow. systemSegmentId: type: string title: System Segment ID description: An identifier used for externally generated audiences brought into Experience Platform. namespace: type: string title: Namespace description: Indicates the origin of the audience. An external origin describes external audiences brought into Experience Platform, while an internal origin describes audiences created in Experience Platform through the Segmentation Service. description: type: string title: Flow description description: The description of the dataflow. createdClient: type: string title: Created client description: The Adobe Identity Management System (IMS) client who created the dataflow. This can be an application or a user. For example, the value `exc_app` represents dataflows created in the Experience Platform UI. updatedClient: type: string title: Updated client description: The Adobe Identity Management System (IMS) client who last updated the dataflow. This can be an application or a user. For example, the value `exc_app` represents dataflows created in the Experience Platform UI. createdBy: type: string title: Created User description: The Adobe ID of the Identity Management System (IMS) user who created the dataflow. In the case of service tokens, the value for `createdBy` is the same as `createdClient`. updatedBy: type: string title: Updated User description: The Adobe ID of the Identity Management System (IMS) user who last updated the dataflow. In the case of service tokens, the value for `createdBy` is the same as `createdClient`. imsOrgId: type: string title: Created client description: The organization ID to which the dataflow belongs. sandboxId: type: string title: Sandbox ID description: The ID of the sandbox in which the dataflow was created. Dataflows cannot be moved from a sandbox to another. sandboxName: type: string title: Created client description: The ID of the sandbox in which the dataflow was created. Dataflows cannot be moved from a sandbox to another. etag: type: string title: eTag description: The updated, unique eTag returned by the HTTP response. The eTag value updates with every successful update of a dataflow. state: type: string title: Flow state description: 'Represents the current flow state of the dataflow. A dataflow can be `enabled` or `disabled`. See [how to enable or disable a dataflow](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/update-destination-dataflows.html#enable-disable-dataflow). ' enum: - enabled - disabled sourceConnectionIds: type: array title: Source Connection Ids description: Array of strings pointing to the dataflow's source connections. Usually, a destination dataflow has only one source connection.
The source connection enables the connection to your Experience Platform data. See the step [Connect to your Experience Platform data](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/connect-activate-batch-destinations.html#connect-to-your-experience-platform-data) in the Activate batch destinations API tutorial for more information about the source connection ID. items: type: string title: Individual Source Connection Id. example: - sourceConnectionId1 - sourceConnectionId2 targetConnectionIds: type: array title: Target Connection Ids description: Array of strings pointing to the dataflow's target connections. Usually, a destination dataflow has only one target connection.
The target connection enables the connection to your batch destination. See the step [Connect to your batch destination](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/connect-activate-batch-destinations.html#connect-to-batch-destination) in the Activate batch destinations API tutorial for more information about the target connection ID. items: type: string title: Individual Target Connection Id. example: - targetConnectionId1 - targetConnectionId2 inheritedAttributes: type: object title: Inherited attributes description: Attributes inherited from the source and target connections used when creating the destination dataflow. properties: properties: type: object title: Properties description: Properties specific to the dataflow. properties: isDestinationFlow: type: boolean title: Is Destination Flow description: Indicates whether this is a destination dataflow. This parameter is useful when querying the endpoint, to filter out non-destination dataflows. sourceConnections: type: object title: Source Connections description: Information about the source connections used when creating this dataflow. properties: id: type: string title: Source Connection ID description: The ID of the source connection used when creating this dataflow. connectionSpec: type: string title: Type description: The connection spec used for the source connection. properties: id: type: string title: Id description: Connection spec ID. Each destination connector has a unique connection spec ID, which must be used when establishing base, source, or target connections for that specific destination. version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. typeInfo: type: object title: Type information description: Information about the data that is being exported. properties: id: type: string title: Id description: ID of the data store from where data is exported. This value is always `ups`, which stands for the Unified Profile Store in Experience Platform. enum: - ups type: type: string title: Type description: The data type that is being exported. enum: - ProfileFragments targetConnections: type: object title: Source Connections description: Information about the target connections used when creating this dataflow. properties: id: type: string title: Target Connection ID description: The ID of the target connection used when creating this dataflow. connectionSpec: type: string title: Type description: The connection spec used for the target connection. properties: id: type: string title: Id description: Connection spec ID. Each destination connector has a unique connection spec ID, which must be used when establishing base, source, or target connections for that specific destination. version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. baseConnection: type: string title: Inherited base connection ID description: ID of the base connection used when creating the target connection. properties: id: type: string title: Base Connection ID description: The ID of the base connection used when creating the target connection. connectionSpec: type: string title: Type description: The connection spec used for the base connection. properties: id: type: string title: Id description: Connection spec ID. Each destination connector has a unique connection spec ID, which must be used when establishing base, source, or target connections for that specific destination. version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. StreamingFlowItem: allOf: - $ref: '#/components/schemas/BaseFlowItem' - $ref: '#/components/schemas/StreamingTransformations' MandatoryFields_V2: type: array title: (Beta) Mandatory Fields description: "Indicates the mandatory attribute fields included in the destination dataflow.
A mandatory attribute is a user-enabled property which ensures all profile records contain the selected attribute. For example: all exported profiles contain an email address.
You can mark attributes as mandatory to ensure that Platform exports only the profiles that include the specific attribute. As a result, it can be used as an additional form of filtering.
Read more about [mandatory attributes](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#mandatory-attributes). \n" items: type: string title: Mandatory Field String description: 'A valid profile union schema field for defining the mandatory attributes or identity namespace. ' Patch_Flow_Request: type: array title: Patch Flow Request description: API Request for a PATCH operation. items: $ref: '#/components/schemas/PatchFlowItem' Create_Batch_Destination_Flow_Request: type: object title: Create Batch Destination Flow Request. description: Model for defining request body for create flow API. required: - name - flowSpec - sourceConnectionIds - targetConnectionIds - transformations properties: name: type: string title: Flow Name description: The name of the destination dataflow to be created. description: type: string title: Flow Description description: The description provides information and details regarding the dataflow to be created. flowSpec: $ref: '#/components/schemas/FlowSpec' sourceConnectionIds: $ref: '#/components/schemas/SourceConnectionIds' targetConnectionIds: $ref: '#/components/schemas/TargetConnectionIds' transformations: type: array title: Transformations description: Transformation object to define the base structure for a destination dataflow. When creating a destination dataflow, leave the `profileSelectors`and `segmentSelectors` empty. You will add relevant values for them when using the `PATCH` request later. items: type: object title: Transformation Object. properties: name: type: string title: Transformation Name description: A hardcoded string. Use the value `General Transform`. enum: - General Transform params: type: object properties: segmentSelectors: type: object properties: selectors: type: array title: Segment Selector Objects description: 'An empty array needs to be passed while creating the destination dataflow. For a detailed selector object, refer to the values documented for Segment selector in the section [Update a destination dataflow](https://developer.adobe.com/experience-platform-apis/references/destinations/#operation/patchFlowById). ' items: type: string profileSelectors: type: object properties: selectors: type: array title: Profile Selector Objects description: 'An empty array needs to be passed while creating the destination dataflow. For a detailed selector object, refer to the values documented for Profile selector in the section [Update a destination dataflow](https://developer.adobe.com/experience-platform-apis/references/destinations/#operation/patchFlowById). ' items: type: string ErrorResponse: type: object PrimaryFields_V2: type: array title: (Beta) Primary Fields (Deduplication Keys) description: "A deduplication key is a user-defined primary key which determines the identity by which users want their profiles to be deduplicated.
Deduplication keys eliminate the possibility of having multiple records of the same profile in one export file.
Read more about [deduplication keys](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#deduplication-keys) and see several [examples of how to use deduplication keys](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#deduplication-example). \n" items: oneOf: - type: object title: Attribute Primary Field properties: fieldType: type: string title: Field Type description: Indicates that the primary field is an attribute. enum: - ATTRIBUTE attributePath: type: string title: Attribute Path description: Indicates the path to the profile attribute field that serves as deduplication key. required: - fieldType - attributePath - type: object title: Identity Primary Field properties: fieldType: type: string title: Field Type description: Indicates that the primary field is an identity. enum: - IDENTITY identityNamespace: type: string title: Identity Namespace description: Indicates the identity namespace that serves as deduplication key. required: - fieldType - identityNamespace BatchTransformation: type: object properties: name: type: string title: Name description: Name of the transformation object. This is the hardcoded value `GeneralTransform`. enum: - GeneralTransform params: oneOf: - $ref: '#/components/schemas/LegacyTransformationParams' - $ref: '#/components/schemas/TransformationParams_V2' BaseSegmentSelectorValue_EnrichmentInfo: type: object title: Segment Selector Value Object description: 'Contains the relevant fields for audience activation, including export schedule, export mode, and more. ' properties: id: type: string title: Segment ID description: The ID of the audience you are adding to the dataflow. systemSegmentId: type: string title: System Segment ID description: An identifier used for externally generated audiences brought into Experience Platform. namespace: type: string title: Namespace description: Indicates the origin of the audience. An external origin describes external audiences brought into Experience Platform, while an internal origin describes audiences created in Experience Platform through the Segmentation Service. name: type: string title: Audience Name description: The name of the audience you are adding to the dataflow. This field is optional. description: type: string title: Description description: The description of the audience you are adding to the dataflow. This field is optional. exportMode: type: string title: Export Mode description: "For more information about the two options, refer to [export full files](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#export-full-files) and [export incremental files](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#export-incremental-files) in the batch destinations activation tutorial. \n" enum: - DAILY_FULL_EXPORT - FIRST_FULL_THEN_INCREMENTAL createTime: type: string title: Create Time description: System-generated Unix time, indicating the moment when the audience was first activated to the destination. example: '1658344069' updateTime: type: string title: Update Time description: System-generated Unix time, indicating the moment when the audience activation details were modified. example: '1658427026' schedule: type: object description: Indicates various settings related to the export schedule of an audience to your destination. properties: frequency: type: string title: Export Frequency description: Indicates the frequency with which files are exported from Experience Platform to your destination. The options `EVERY_3_HOURS`, `EVERY_6_HOURS`, `EVERY_8_HOURS`, `EVERY_12_HOURS` are supported for incremental file exports only. enum: - ONCE - DAILY - EVERY_3_HOURS - EVERY_6_HOURS - EVERY_8_HOURS - EVERY_12_HOURS triggerType: type: string title: Trigger Type description: 'This field is required only when selecting the `DAILY_FULL_EXPORT` mode in the frequency selector. Supported frequency types are `ONCE` and `DAILY`.
Select `AFTER_SEGMENT_EVAL` to have the activation job run immediately after the daily Platform batch segmentation job completes. This ensures that when the activation job runs, the most up-to-date profiles are exported to your destination.
Select `SCHEDULED` to have the activation job run at a fixed time. This ensures that Experience Platform profile data is exported at the same time each day, but the profiles you export may not be the most up-to -date, depending on whether the batch segmentation job has completed before the activation job starts. When selecting this option, you must also add a `startTime` to indicate at which time in UTC the daily exports should occur. ' enum: - SCHEDULED - AFTER_SEGMENT_EVAL startDate: type: string title: Start Date description: The date when the segment should start exporting profiles to your destination.
The correct format is `YYYY-MM-DD`. example: '2022-07-20' endDate: type: string title: End Date description: 'Not applicable when selecting `"exportMode":"DAILY_FULL_EXPORT"` and `"frequency":"ONCE"`. Sets the date when segment members stop being exported to the destination.
The correct format is `YYYY-MM-DD`. ' example: '2022-07-29' startTime: type: string title: Start Time description: 'A 24-hour format to represent when files containing members of the segment should be generated and exported to your destination. Note: This field is not applicable when you define `"exportMode":"DAILY_FULL_EXPORT"` and `"triggerType"="AFTER_SEGMENT_EVAL"`.
The correct format is `HH:MM`. Minutes must be `00`. ' example: '20:00' enrichmentInfo: type: object description: Contains configuration information for enrichment attribute activation. properties: enabled: type: boolean title: Enrichment Attributes Enabled description: Indicates if enrichment attributes are enabled for the dataflow. default: true sourceType: type: string title: Source Type description: Indicates the source type example: AUDIENCE_DATASET mappingSet: type: object title: Mapping Set description: Contains the mapping set ID and version. properties: id: type: string title: Mapping set ID description: Mapping set ID. Each destination connector has a unique connection spec ID, which must be used when establishing base, source, or target connections for that specific destination. version: type: integer title: Version description: The version of the mapping set BatchFlowItem: description: Batch dataflow parameters allOf: - $ref: '#/components/schemas/BaseFlowItem' - $ref: '#/components/schemas/BatchTransformations' - type: object properties: scheduleParams: $ref: '#/components/schemas/DatasetScheduleParams_V2' FlowSpec: type: object title: Flow Spec description: Model to capture the flow specification. Each destination has a specific flow spec ID in Experience Platform. properties: id: type: string title: Flow Spec ID. description: 'The flow spec ID of the destination that you are looking to connect and activate segments to. To retrieve the flow spec ID, perform a `GET` operation on the `flowspecs` endpoint, as shown in the [flow specs API reference documentation](https://developer.adobe.com/experience-platform-apis/references/flow-service/#operation/retrieveFlowSpec).
For your reference, see below the flow spec IDs for commonly used batch destinations:
' Create_Batch_Destination_Flow_Request_V2: type: object title: (Beta) Create Batch Destination Flow Request description: Model for defining the request body to create a dataflow. oneOf: - $ref: '#/components/schemas/Create_Batch_Destination_Flow_Request_Segment_V2' - $ref: '#/components/schemas/Create_Batch_Destination_Flow_Request_Dataset_V2' Batch_Flow: type: object title: Batch destination dataflow response properties: items: type: array items: $ref: '#/components/schemas/BatchFlowItem' BatchSegmentSelectors_V2: type: object title: (Beta) Segment Selectors description: Information about the **segments** that are being exported in the dataflow to the destination. properties: selectors: type: array title: Segment Selector Paths items: $ref: '#/components/schemas/BatchSegmentSelector_V2' TargetConnectionIds: type: array title: Target Connection IDs description: 'Add one target connection ID, which enables the connection to your batch destination. Follow the step [Connect to your batch destination](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/connect-activate-batch-destinations.html#connect-to-batch-destination) to learn how to obtain a target connection ID. ' items: type: string Create_Batch_Destination_Flow_Request_Segment_V2: title: (Beta) Create Batch Destination Flow Request for Segments type: object allOf: - $ref: '#/components/schemas/Create_Batch_Destination_Flow_Request_Base_V2' - type: object properties: transformations: type: array title: Transformations description: Transformation object to define the base structure for a destination dataflow. When creating a destination dataflow, leave the `mandatoryFields`, `primaryFields`, `profileMapping` and `segmentSelectors` empty. You will add relevant values for them when using the `PATCH` request later. items: type: object title: Transformation Object. properties: name: type: string title: Transformation Name description: A hardcoded string. Use the value `General Transform`. enum: - General Transform params: type: object properties: mandatoryFields: type: array title: Mandatory Fields description: 'An empty array needs to be passed while creating the destination dataflow. For additional details about this property, refer to the values documented for Mandatory Fields in the section [Update a destination dataflow](https://developer.adobe.com/experience-platform-apis/references/destinations/#operation/patchFlowById). ' items: type: string primaryFields: type: array title: Primary Fields description: 'An empty array needs to be passed while creating the destination dataflow. For additional details about this property, refer to the values documented for Primary Fields in the section [Update a destination dataflow](https://developer.adobe.com/experience-platform-apis/references/destinations/#operation/patchFlowById). ' items: type: string profileMapping: type: object title: Profile Mapping description: 'An empty object needs to be passed while creating the destination dataflow. For additional details about this property, refer to the values documented for Profile Mapping in the section [Update a destination dataflow](https://developer.adobe.com/experience-platform-apis/references/destinations/#operation/patchFlowById). ' segmentSelectors: type: object properties: selectors: type: array title: Segment Selector Objects description: 'An empty array needs to be passed while creating the destination dataflow. For a detailed selector object, refer to the values documented for Segment selector in the section [Update a destination dataflow](https://developer.adobe.com/experience-platform-apis/references/destinations/#operation/patchFlowById). ' items: type: string required: - transformations Create_Batch_Destination_Flow_Request_Dataset_V2: title: (Beta) Create Batch Destination Flow Request for Datasets type: object allOf: - $ref: '#/components/schemas/Create_Batch_Destination_Flow_Request_Base_V2' - type: object properties: scheduleParams: $ref: '#/components/schemas/DatasetScheduleParams_V2' required: - scheduleParams BatchProfileSelector: type: object title: Profile Selector description: 'A profile selector object to define a field for activation. For detailed explanation of each field kindly refer to documentation link: https://experienceleague.adobe.com/docs/experience-platform/destinations/api/connect-activate-batch-destinations.html#activate-data. ' properties: type: type: string title: Profile Selector Type description: 'Describes the enum for the profile selector object. Currently, this is the hardcoded value `JSON_PATH` ' enum: - JSON_PATH value: type: object title: Profile Selector Value Object description: 'Includes different attributes relevant for exporting a profile attribute field to your destination. For example, when mapping a source attribute from Experience Platform to a target attribute in the destination, this object can include the source and target schema paths and other fields. ' properties: path: type: string operator: type: string title: Profile Selector Operator description: 'Describes the enum for the profile selector operator. Currently, this is the hardcoded value `EXISTS` ' enum: - EXISTS mapping: type: object properties: sourceType: type: string description: The hardcoded value `text/x.schema-path` indicates that the source attribute is an XDM path in Experience Platform, such as `person.name.lastName`, `personalEmail.address`, or `identityMap.email` (for identity attributes). source: type: string description: Indicates the source XDM path of the attribute. For batch destination exports, the destination path is the same as the source path. destination: type: string description: Indicates the destination XDM path of the attribute. For batch destination exports, the destination path is the same as the source path. identity: type: boolean description: Indicates if this attribute is an identity field, such as Email, Phone number, IDFA or GAID identifiers, and more. Read about [identity fields](https://experienceleague.adobe.com/docs/experience-platform/identity/namespaces.html#standard) and use the identity service API to [retrieve available identity namespaces](https://experienceleague.adobe.com/docs/experience-platform/identity/api/list-namespaces.html). primaryIdentity: type: boolean description: Indicates if at the time of data ingestion into Experience Platform this identity was set as a primary identity functionVersion: type: integer description: This is a hardcoded `0` value. sourceAttribute: type: string description: Indicates the source XDM path of the attribute. destinationXdmPath: type: string description: Indicates the destination XDM path of the attribute. For batch destination exports, the destination path is the same as the source path. BatchSegmentSelector_EnrichmentInfo_V2: type: object title: Enrichment Attribute Audience Selector description: 'An audience selector object which defines the audiences to be activated. For detailed explanation of each field, refer to the documentation link: https://experienceleague.adobe.com/docs/experience-platform/destinations/api/connect-activate-batch-destinations.html#activate-data. ' properties: type: type: string title: Segment Type description: Use the hardcoded value `PLATFORM_SEGMENT`. enum: - PLATFORM_SEGMENT value: allOf: - $ref: '#/components/schemas/BaseSegmentSelectorValue_EnrichmentInfo' - type: object properties: fileNameTemplate: type: string title: (Beta) File Name Template description: 'This field determines the file name format of the files that are exported to your destination. Several macros are available to use, as listed below:

' example: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' BatchSegmentSelectors: type: object description: Information about the **segments** that are being exported in the dataflow to the destination. properties: selectors: type: array title: Segment Selector Paths items: $ref: '#/components/schemas/BatchSegmentSelector' Create_Batch_Destination_Flow_Request_Base_V2: type: object title: (Beta) Create Batch Destination Flow Request description: Model for defining the request body to create a dataflow. required: - name - flowSpec - sourceConnectionIds - targetConnectionIds properties: name: type: string title: Flow Name description: The name of the destination dataflow to be created. description: type: string title: Flow Description description: The description provides information and details regarding the dataflow to be created. flowSpec: $ref: '#/components/schemas/FlowSpec_V2' sourceConnectionIds: type: array title: Source Connection IDs description: 'Add one source connection ID, which enables the connection to your Experience Platform data. ' items: type: string targetConnectionIds: type: array title: Target Connection IDs description: 'Add one target connection ID, which enables the connection to your batch destination. ' items: type: string BatchProfileSelectors: type: object description: Information about the **profile attributes** that are being exported in the dataflow to the destination. properties: selectors: type: array title: Segment Selector Paths items: $ref: '#/components/schemas/BatchProfileSelector' mandatoryFields: type: array title: Mandatory Fields description: "Indicates the mandatory attribute fields included in the destination dataflow.
A mandatory attribute is a user-enabled property which ensures all profile records contain the selected attribute. For example: all exported profiles contain an email address.
You can mark attributes as mandatory to ensure that Platform exports only the profiles that include the specific attribute. As a result, it can be used as an additional form of filtering.
Read more about [mandatory attributes](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#mandatory-attributes). \n" items: type: string title: Mandatory String Field description: A valid profile union schema field for defining the mandatory attributes. primaryFields: type: array title: Primary Fields (Deduplication Keys) description: "A deduplication key is a user-defined primary key which determines the identity by which users want their profiles to be deduplicated.
Deduplication keys eliminate the possibility of having multiple records of the same profile in one export file.
Read more about [deduplication keys](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#deduplication-keys) and see several [examples of how to use deduplication keys](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/activate-batch-profile-destinations.html#deduplication-example). \n" items: type: object title: Primary Field Object properties: fieldType: type: string title: Field Type description: Currently, this is the hardcoded value `ATTRIBUTE` enum: - ATTRIBUTE attributePath: type: string title: Attribute Path description: 'Indicates the path to the profile attribute field that serves as deduplication key. ' TransformationParams_V2: type: object title: (Beta) Transformation Params description: Parameters include information about the segments activated to the destination, as well as the profile attributes that are being exported. properties: segmentSelectors: $ref: '#/components/schemas/BatchSegmentSelectors_V2' profileMapping: $ref: '#/components/schemas/ProfileMapping_V2' primaryFields: $ref: '#/components/schemas/PrimaryFields_V2' mandatoryFields: $ref: '#/components/schemas/MandatoryFields_V2' LegacyTransformationParams: type: object title: Transformation Params description: Parameters include information about the segments activated to the destination, as well as the profile attributes that are being exported. properties: profileSelectors: $ref: '#/components/schemas/BatchProfileSelectors' segmentSelectors: $ref: '#/components/schemas/BatchSegmentSelectors' PatchFlowItem: type: object title: Patch Command description: A json patch command as per the RFC - https://datatracker.ietf.org/doc/html/rfc6902 required: - op - path - value properties: op: type: string title: PATCH operation description: The operation that you are performing on the destination dataflow. You can add, replace, or remove items from destination dataflows. enum: - add - replace - remove path: type: string title: Path description: A json xpath where the value has to be added, updated, or removed. value: description: ' ' oneOf: - $ref: '#/components/schemas/BatchSegmentSelector' - $ref: '#/components/schemas/BatchProfileSelector' - $ref: '#/components/schemas/BatchSegmentSelector_V2' - $ref: '#/components/schemas/BatchSegmentSelector_EnrichmentInfo_V2' - $ref: '#/components/schemas/DatasetScheduleParams_V2' - $ref: '#/components/schemas/ProfileMapping_V2' - $ref: '#/components/schemas/PrimaryFields_V2' - $ref: '#/components/schemas/MandatoryFields_V2' BatchSegmentSelector: type: object title: Segment Selector description: 'A segment selector object to define a segment for activation. For detailed explanation of each field, refer to the documentation link: https://experienceleague.adobe.com/docs/experience-platform/destinations/api/connect-activate-batch-destinations.html#activate-data. ' properties: type: type: string title: Segment Type description: Use the hardcoded value `PLATFORM_SEGMENT`. enum: - PLATFORM_SEGMENT value: allOf: - $ref: '#/components/schemas/BaseSegmentSelectorValue' - type: object properties: fileNameTemplate: type: string title: File Name Template description: 'This field determines the file name format of the files that are exported to your destination. Several macros are available to use, as listed below:

' example: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' ProfileMapping_V2: type: object title: (Beta) Profile Mapping description: A Data Prep Service [mapping set](https://developer.adobe.com/experience-platform-apis/references/data-prep/#tag/Mapping-sets/operation/createMappingSet) to describe which profile attributes and identities to export to your destination. required: - mappingId - mappingVersion properties: mappingId: title: Mapping set ID description: The ID of the mapping set type: string mappingVersion: title: Mapping set version description: The version of the mapping set type: integer Streaming_Flow: type: object title: Streaming destination dataflow response properties: items: type: array items: $ref: '#/components/schemas/StreamingFlowItem' parameters: XApiKey: in: header name: x-api-key description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en). schema: type: string required: true if-match: in: header name: if-match description: A header containing the eTag value of the entity to be updated (destination dataflow, base or target connection, etc.). Perform a GET request to return the latest eTag version of the entity. Note that you always need to wrap this header in double quotes when using it. schema: type: string required: true orderby: in: query name: orderby description: Sort response by specified fields separated by `,` and/or prefix field with `-` for descending order. required: false schema: type: string Accept: in: header name: Accept description: An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API. schema: type: string default: application/json; version=1 required: false continuationToken: in: query name: continuationToken description: A token for fetching records for next page. This is a system-generated token. required: false schema: type: string count: in: query name: count description: A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`). required: false schema: type: boolean Content-type: in: header name: Content-type description: The type of content being sent in the body of the request. Should be 'application/json'. schema: type: string default: application/json required: true XSandboxId: in: header name: x-sandbox-name description: All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. schema: type: string required: true Authorization: in: header name: Authorization description: The access token which can be copied from your Experience Platform integration, prefixed with 'Bearer '. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en). schema: type: string required: true limit: in: query name: limit description: Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`. required: false schema: type: integer maximum: 100 XImsOrgId: in: header name: x-gw-ims-org-id description: The organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en). schema: type: string required: true examples: Patch_Dataset_Schedule_Params: summary: Update dataset dataflow export schedule value: - op: replace path: /scheduleParams value: interval: 3 timeUnit: hour startTime: 1668470400 endTime: 1668479500 Batch_Flow_Daily_Full_Once_Chained: summary: Batch Destination (mode=Daily Full, frequency=Once, trigger=chained) value: items: - id: ca5c6e9a-8559-4a08-97a5-f15b756da600 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556585B77F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 71471eba-b620-49e4-90fd-23f1fa0174d8 version: '1.0' state: enabled version: '"04001b6d-0000-0200-0000-62d9a2ec0000"' etag: '"04001b6d-0000-0200-0000-62d9a2ec0000"' sourceConnectionIds: - f3a5e232-eba3-428b-aa69-921d122d5db5 targetConnectionIds: - 54d575d8-43c9-4d3d-aec5-b033e4189f4a inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: f3a5e232-eba3-428b-aa69-921d122d5db5 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: a9ae9a98-950d-468f-ac28-bc42bcd55d78 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: 54d575d8-43c9-4d3d-aec5-b033e4189f4a connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' baseConnection: id: 459779de-6f0a-46dd-9b64-10121316a8d9 connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' transformations: - name: GeneralTransform params: profileSelectors: selectors: - type: JSON_PATH value: path: person.name.firstName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.firstName destination: person.name.firstName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.firstName destinationXdmPath: person.name.firstName - type: JSON_PATH value: path: person.name.lastName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.lastName destination: person.name.lastName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.lastName destinationXdmPath: person.name.lastName - type: JSON_PATH value: path: personalEmail.address operator: EXISTS mapping: sourceType: text/x.schema-path source: personalEmail.address destination: personalEmail.address identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: personalEmail.address destinationXdmPath: personalEmail.address - type: JSON_PATH value: path: segmentMembership.status operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status destination: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: segmentMembership.status destinationXdmPath: segmentMembership.status mandatoryFields: - person.name.firstName - person.name.lastName primaryFields: - fieldType: ATTRIBUTE attributePath: personalEmail.address segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: d47e9c03-ef9a-491c-be24-7a985c0e221d name: Chaining Segment May 23 - 1 description: test Chaining Segment May 23 - 1 filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: frequency: ONCE triggerType: AFTER_SEGMENT_EVAL startDate: '2022-07-21' createTime: '1658344069' updateTime: '1658427026' runs: /runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600 lastOperation: started: 1658427025696 updated: 1658427031832 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: d47e9c03-ef9a-491c-be24-7a985c0e221d name: Chaining Segment May 23 - 1 description: test Chaining Segment May 23 - 1 filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: startDate: '2022-07-21' frequency: ONCE triggerType: AFTER_SEGMENT_EVAL operation: update lastRunDetails: id: daa87aaa-6969-458d-bc41-609c52ebc2b1 state: success startedAtUTC: 1658430155398 completedAtUTC: 1658430160403 Create_Flow_Response: summary: Create Flow Response value: id: ca5c6e9a-8559-4a08-97a5-f15b756da600 etag: '"04000e7f-0000-0200-0000-62d9bca40000"' Batch_Flow_First_Full_Then_Incremental_DAILY: summary: Batch Destination (mode=First Full Then Incremental, frequency=Daily) value: items: - id: ca5c6e9a-8559-4a08-97a5-f15b756da600 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556585B77F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 71471eba-b620-49e4-90fd-23f1fa0174d8 version: '1.0' state: enabled version: '"04001b6d-0000-0200-0000-62d9a2ec0000"' etag: '"04001b6d-0000-0200-0000-62d9a2ec0000"' sourceConnectionIds: - f3a5e232-eba3-428b-aa69-921d122d5db5 targetConnectionIds: - 54d575d8-43c9-4d3d-aec5-b033e4189f4a inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: f3a5e232-eba3-428b-aa69-921d122d5db5 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: a9ae9a98-950d-468f-ac28-bc42bcd55d78 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: 54d575d8-43c9-4d3d-aec5-b033e4189f4a connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' baseConnection: id: 459779de-6f0a-46dd-9b64-10121316a8d9 connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' transformations: - name: GeneralTransform params: profileSelectors: selectors: - type: JSON_PATH value: path: person.name.firstName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.firstName destination: person.name.firstName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.firstName destinationXdmPath: person.name.firstName - type: JSON_PATH value: path: person.name.lastName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.lastName destination: person.name.lastName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.lastName destinationXdmPath: person.name.lastName - type: JSON_PATH value: path: personalEmail.address operator: EXISTS mapping: sourceType: text/x.schema-path source: personalEmail.address destination: personalEmail.address identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: personalEmail.address destinationXdmPath: personalEmail.address - type: JSON_PATH value: path: segmentMembership.status operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status destination: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: segmentMembership.status destinationXdmPath: segmentMembership.status mandatoryFields: - person.name.firstName - person.name.lastName primaryFields: - fieldType: ATTRIBUTE attributePath: personalEmail.address segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: 4afb50cb-3fb0-4c06-bc90-d3b66cb7f5af name: Batch Monitoring Testing Segment description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: frequency: DAILY triggerType: SCHEDULED startDate: '2022-07-20' endDate: '2022-07-29' startTime: '20:00' createTime: '1658344069' updateTime: '1658427026' runs: /runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600 lastOperation: started: 1658427025696 updated: 1658427031832 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: 4afb50cb-3fb0-4c06-bc90-d3b66cb7f5af name: Batch Monitoring Testing Segment description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: startDate: '2022-07-20' frequency: DAILY endDate: '2022-07-29' startTime: '20:00' triggerType: SCHEDULED operation: update lastRunDetails: id: daa87aaa-6969-458d-bc41-609c52ebc2b1 state: success startedAtUTC: 1658430155398 completedAtUTC: 1658430160403 Patch_Source_Connection: summary: Update Source Connection of dataflow value: - op: replace path: /sourceConnectionIds value: - 436da0bf-d0c6-4767-8649-e8cdd21c28b7 Create_Batch_Destination_Flow: summary: Create dataflow to a batch destination value: name: Activate segments to a batch destination description: This operation creates a dataflow which we will later use to activate segments to a batch destination (e.g. Amazon S3 or Adobe Campaign) flowSpec: id: '{FLOW_SPEC_ID}' version: '1.0' sourceConnectionIds: - '{SOURCE_CONNECTION_ID}' targetConnectionIds: - '{TARGET_CONNECTION_ID}' transformations: - name: GeneralTransform params: segmentSelectors: selectors: [] profileSelectors: selectors: [] Patch_Batch_Flow_Daily_Full_Once_Chained: summary: Add segment to a batch destination dataflow (mode=Daily Full, frequency=Once, trigger=chained) value: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: 979558ae-a8ba-4e6e-b6ba-95c0a523b44a name: Combined First and Last Name Segment description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: startDate: '2022-07-22' frequency: CHAINED startTime: '23:00' triggerType: SCHEDULED Patch_Batch_Flow_External_Audience_Daily_Full_Once_Scheduled: summary: Add external audience to a batch destination dataflow (mode=Daily Full, frequency=Once, trigger=Scheduled) value: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: extaud9001 systemSegmentId: 979558ae-a8ba-4e6e-b6ba-95c0a523b44a namespace: aamSegments name: Combined First and Last Name Segment description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: startDate: '2022-07-22' frequency: ONCE startTime: '23:00' triggerType: SCHEDULED Batch_Flow_External_Audience_Profile_Mapping_And_Identities: summary: External audience export dataflow with audiences, profile mappings, primary and mandatory fields. value: items: - id: d8ce03ea-d55c-4add-a56e-6e1c313e4250 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556587477F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 1a0514a6-33d4-4c7f-aff8-594799c47549 version: '1.0' state: enabled version: '"0503aab5-0000-0200-0000-63756cd10000"' etag: '"0503aab5-0000-0200-0000-63756cd10000"' sourceConnectionIds: - aacb95f5-e451-4db6-bd72-de9845f9b1d0 targetConnectionIds: - e609bd68-ef20-41f8-910d-7a8a4b177954 inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: aacb95f5-e451-4db6-bd72-de9845f9b1d0 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: be3e2d03-6134-4566-9865-c40e0df8b718 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: e609bd68-ef20-41f8-910d-7a8a4b177954 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' baseConnection: id: 104c0cd4-31a8-4879-b913-96b609dad2c1 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' transformations: - name: GeneralTransform params: mandatoryFields: - ECID primaryFields: - identityNamespace: ECID fieldType: IDENTITY profileMapping: mappingId: 5d21b87871df4f5ea93b436c5e8da224 mappingVersion: 0 segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: extaud9001 systemSegmentId: 979558ae-a8ba-4e6e-b6ba-95c0a523b44a namespace: aamSegments name: Audience Imported from Audience Manager description: '' filenameTemplate: '%DESTINATION%_%SEGMENT_ID%_%SEGMENT_NAME%_%DESTINATION_INSTANCE_ID%_%DESTINATION_INSTANCE_NAME%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: frequency: EVERY_3_HOURS triggerType: SCHEDULED startDate: '2022-11-15' endDate: '2022-11-23' startTime: '22:00' createTime: '1668548786' updateTime: '1668614587' runs: /runs?property=flowId==d8ce03ea-d55c-4add-a56e-6e1c313e4250 lastOperation: started: 1668614587286 updated: 1668614594602 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: replace path: /transformations/0/params/segmentSelectors/selectors/0 value: type: PLATFORM_SEGMENT value: id: 25768be6-ebd5-45cc-8913-12fb3f348613 name: Interested in Mountain Biking description: '' filenameTemplate: '%DESTINATION%_%SEGMENT_ID%_%SEGMENT_NAME%_%DESTINATION_INSTANCE_ID%_%DESTINATION_INSTANCE_NAME%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: startDate: '2022-11-15' frequency: EVERY_3_HOURS endDate: '2022-11-23' startTime: '22:00' triggerType: SCHEDULED operation: update lastRunDetails: id: a18222fe-b5ef-48d5-acb5-835f25e6a7bb state: success startedAtUTC: 1668639937828 completedAtUTC: 1668639937836 Patch_Primary_Fields: summary: (Beta) Patch a primary field value: - op: add path: /transformations/0/params/primaryFields value: - identityNamespace: GAID fieldType: IDENTITY Batch_Flow_Daily_Full_Chained: summary: Batch Destination (mode=Daily Full, frequency=Daily, trigger=Chained) value: items: - id: ca5c6e9a-8559-4a08-97a5-f15b756da600 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556585B77F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 71471eba-b620-49e4-90fd-23f1fa0174d8 version: '1.0' state: enabled version: '"04001b6d-0000-0200-0000-62d9a2ec0000"' etag: '"04001b6d-0000-0200-0000-62d9a2ec0000"' sourceConnectionIds: - f3a5e232-eba3-428b-aa69-921d122d5db5 targetConnectionIds: - 54d575d8-43c9-4d3d-aec5-b033e4189f4a inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: f3a5e232-eba3-428b-aa69-921d122d5db5 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: a9ae9a98-950d-468f-ac28-bc42bcd55d78 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: 54d575d8-43c9-4d3d-aec5-b033e4189f4a connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' baseConnection: id: 459779de-6f0a-46dd-9b64-10121316a8d9 connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' transformations: - name: GeneralTransform params: profileSelectors: selectors: - type: JSON_PATH value: path: person.name.firstName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.firstName destination: person.name.firstName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.firstName destinationXdmPath: person.name.firstName - type: JSON_PATH value: path: person.name.lastName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.lastName destination: person.name.lastName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.lastName destinationXdmPath: person.name.lastName - type: JSON_PATH value: path: personalEmail.address operator: EXISTS mapping: sourceType: text/x.schema-path source: personalEmail.address destination: personalEmail.address identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: personalEmail.address destinationXdmPath: personalEmail.address - type: JSON_PATH value: path: segmentMembership.status operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status destination: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: segmentMembership.status destinationXdmPath: segmentMembership.status mandatoryFields: - person.name.firstName - person.name.lastName primaryFields: - fieldType: ATTRIBUTE attributePath: personalEmail.address segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: eda67d3d-89a4-4947-9d02-2f8c0a5a8223 name: Combined Segment - Hello World description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: frequency: DAILY triggerType: AFTER_SEGMENT_EVAL startDate: '2022-07-20' endDate: '2022-07-30' createTime: '1658344069' updateTime: '1658427026' runs: /runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600 lastOperation: started: 1658427025696 updated: 1658427031832 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: eda67d3d-89a4-4947-9d02-2f8c0a5a8223 name: Combined Segment - Hello World description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: startDate: '2022-07-20' frequency: DAILY endDate: '2022-07-30' triggerType: AFTER_SEGMENT_EVAL operation: update lastRunDetails: id: daa87aaa-6969-458d-bc41-609c52ebc2b1 state: success startedAtUTC: 1658430155398 completedAtUTC: 1658430160403 Batch_Flow_First_Full_Then_Incremental_EVERY_3_HOURS: summary: Batch Destination (mode=First Full Then Incremental, frequency=3 Hour) value: items: - id: ca5c6e9a-8559-4a08-97a5-f15b756da600 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556585B77F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 71471eba-b620-49e4-90fd-23f1fa0174d8 version: '1.0' state: enabled version: '"04001b6d-0000-0200-0000-62d9a2ec0000"' etag: '"04001b6d-0000-0200-0000-62d9a2ec0000"' sourceConnectionIds: - f3a5e232-eba3-428b-aa69-921d122d5db5 targetConnectionIds: - 54d575d8-43c9-4d3d-aec5-b033e4189f4a inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: f3a5e232-eba3-428b-aa69-921d122d5db5 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: a9ae9a98-950d-468f-ac28-bc42bcd55d78 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: 54d575d8-43c9-4d3d-aec5-b033e4189f4a connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' baseConnection: id: 459779de-6f0a-46dd-9b64-10121316a8d9 connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' transformations: - name: GeneralTransform params: profileSelectors: selectors: - type: JSON_PATH value: path: person.name.firstName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.firstName destination: person.name.firstName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.firstName destinationXdmPath: person.name.firstName - type: JSON_PATH value: path: person.name.lastName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.lastName destination: person.name.lastName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.lastName destinationXdmPath: person.name.lastName - type: JSON_PATH value: path: personalEmail.address operator: EXISTS mapping: sourceType: text/x.schema-path source: personalEmail.address destination: personalEmail.address identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: personalEmail.address destinationXdmPath: personalEmail.address - type: JSON_PATH value: path: segmentMembership.status operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status destination: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: segmentMembership.status destinationXdmPath: segmentMembership.status mandatoryFields: - person.name.firstName - person.name.lastName primaryFields: - fieldType: ATTRIBUTE attributePath: personalEmail.address segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: 42794d4a-a95e-432e-9cbf-7f61cc14ae2e name: Chaining Segment 1 description: Chaining Segment 1 filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: frequency: EVERY_3_HOURS triggerType: SCHEDULED startDate: '2022-07-20' endDate: '2022-07-27' startTime: '20:00' createTime: '1658344069' updateTime: '1658427026' runs: /runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600 lastOperation: started: 1658427025696 updated: 1658427031832 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: 42794d4a-a95e-432e-9cbf-7f61cc14ae2e name: Chaining Segment 1 description: Chaining Segment 1 filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: startDate: '2022-07-20' frequency: EVERY_3_HOURS endDate: '2022-07-27' startTime: '20:00' triggerType: SCHEDULED operation: update lastRunDetails: id: daa87aaa-6969-458d-bc41-609c52ebc2b1 state: success startedAtUTC: 1658430155398 completedAtUTC: 1658430160403 Batch_Flows: summary: List of Destinations value: items: - id: ca5c6e9a-8559-4a08-97a5-f198756da601 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556585B77F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 71471eba-b620-49e4-90fd-23f1fa0174d8 version: '1.0' state: enabled version: '"04001b6d-0000-0200-0000-62d9a2ec0000"' etag: '"04001b6d-0000-0200-0000-62d9a2ec0000"' sourceConnectionIds: - f3a5e232-eba3-428b-aa69-921d122d5db5 targetConnectionIds: - 54d575d8-43c9-4d3d-aec5-b033e4189f4a inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: f3a5e232-eba3-428b-aa69-921d122d5db5 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: a9ae9a98-950d-468f-ac28-bc42bcd55d78 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: 54d575d8-43c9-4d3d-aec5-b033e4189f4a connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' baseConnection: id: 459779de-6f0a-46dd-9b64-10121316a8d9 connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' transformations: - name: GeneralTransform params: profileSelectors: selectors: - type: JSON_PATH value: path: person.name.firstName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.firstName destination: person.name.firstName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.firstName destinationXdmPath: person.name.firstName - type: JSON_PATH value: path: person.name.lastName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.lastName destination: person.name.lastName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.lastName destinationXdmPath: person.name.lastName - type: JSON_PATH value: path: personalEmail.address operator: EXISTS mapping: sourceType: text/x.schema-path source: personalEmail.address destination: personalEmail.address identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: personalEmail.address destinationXdmPath: personalEmail.address - type: JSON_PATH value: path: segmentMembership.status operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status destination: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: segmentMembership.status destinationXdmPath: segmentMembership.status mandatoryFields: - person.name.firstName - person.name.lastName primaryFields: - fieldType: ATTRIBUTE attributePath: personalEmail.address segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: 4afb50cb-3fb0-4c06-bc90-d3b66cb7f5af name: Batch Monitoring Testing Segment description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: frequency: DAILY triggerType: SCHEDULED startDate: '2022-07-20' endDate: '2022-07-29' startTime: '20:00' createTime: '1658344069' updateTime: '1658427026' runs: /runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600 lastOperation: started: 1658427025696 updated: 1658427031832 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: 4afb50cb-3fb0-4c06-bc90-d3b66cb7f5af name: Batch Monitoring Testing Segment description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: startDate: '2022-07-20' frequency: DAILY endDate: '2022-07-29' startTime: '20:00' triggerType: SCHEDULED operation: update lastRunDetails: id: daa87aaa-6969-458d-bc41-609c52ebc2b1 state: success startedAtUTC: 1658430155398 completedAtUTC: 1658430160403 - id: ca5c6e9a-8559-4a08-97a5-f15b756da600 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556585B77F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 71471eba-b620-49e4-90fd-23f1fa0174d8 version: '1.0' state: enabled version: '"04001b6d-0000-0200-0000-62d9a2ec0000"' etag: '"04001b6d-0000-0200-0000-62d9a2ec0000"' sourceConnectionIds: - f3a5e232-eba3-428b-aa69-921d122d5db5 targetConnectionIds: - 54d575d8-43c9-4d3d-aec5-b033e4189f4a inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: f3a5e232-eba3-428b-aa69-921d122d5db5 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: a9ae9a98-950d-468f-ac28-bc42bcd55d78 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: 54d575d8-43c9-4d3d-aec5-b033e4189f4a connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' baseConnection: id: 459779de-6f0a-46dd-9b64-10121316a8d9 connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' transformations: - name: GeneralTransform params: profileSelectors: selectors: - type: JSON_PATH value: path: person.name.firstName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.firstName destination: person.name.firstName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.firstName destinationXdmPath: person.name.firstName - type: JSON_PATH value: path: person.name.lastName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.lastName destination: person.name.lastName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.lastName destinationXdmPath: person.name.lastName - type: JSON_PATH value: path: personalEmail.address operator: EXISTS mapping: sourceType: text/x.schema-path source: personalEmail.address destination: personalEmail.address identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: personalEmail.address destinationXdmPath: personalEmail.address - type: JSON_PATH value: path: segmentMembership.status operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status destination: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: segmentMembership.status destinationXdmPath: segmentMembership.status mandatoryFields: - person.name.firstName - person.name.lastName primaryFields: - fieldType: ATTRIBUTE attributePath: personalEmail.address segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: 42794d4a-a95e-432e-9cbf-7f61cc14ae2e name: Chaining Segment 1 description: Chaining Segment 1 filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: frequency: EVERY_3_HOURS triggerType: SCHEDULED startDate: '2022-07-20' endDate: '2022-07-27' startTime: '20:00' createTime: '1658344069' updateTime: '1658427026' runs: /runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600 lastOperation: started: 1658427025696 updated: 1658427031832 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: 42794d4a-a95e-432e-9cbf-7f61cc14ae2e name: Chaining Segment 1 description: Chaining Segment 1 filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: startDate: '2022-07-20' frequency: EVERY_3_HOURS endDate: '2022-07-27' startTime: '20:00' triggerType: SCHEDULED operation: update lastRunDetails: id: daa87aaa-6969-458d-bc41-609c52ebc2b1 state: success startedAtUTC: 1658430155398 completedAtUTC: 1658430160403 - id: d8ce03ea-d55c-4add-a56e-6e1c313e4250 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556587477F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: (Beta) S3 Segment Destination description: (Beta) S3 Segment Destination flowSpec: id: 1a0514a6-33d4-4c7f-aff8-594799c47549 version: '1.0' state: enabled version: '"0503aab5-0000-0200-0000-63756cd10000"' etag: '"0503aab5-0000-0200-0000-63756cd10000"' sourceConnectionIds: - aacb95f5-e451-4db6-bd72-de9845f9b1d0 targetConnectionIds: - e609bd68-ef20-41f8-910d-7a8a4b177954 inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: aacb95f5-e451-4db6-bd72-de9845f9b1d0 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: be3e2d03-6134-4566-9865-c40e0df8b718 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: e609bd68-ef20-41f8-910d-7a8a4b177954 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' baseConnection: id: 104c0cd4-31a8-4879-b913-96b609dad2c1 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' transformations: - name: GeneralTransform params: mandatoryFields: - ECID primaryFields: - identityNamespace: ECID fieldType: IDENTITY profileMapping: mappingId: 5d21b87871df4f5ea93b436c5e8da224 mappingVersion: 0 segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: 25768be6-ebd5-45cc-8913-12fb3f348613 name: Interested in Mountain Biking description: '' filenameTemplate: '%DESTINATION%_%SEGMENT_ID%_%SEGMENT_NAME%_%DESTINATION_INSTANCE_ID%_%DESTINATION_INSTANCE_NAME%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: frequency: EVERY_3_HOURS triggerType: SCHEDULED startDate: '2022-11-15' endDate: '2022-11-23' startTime: '22:00' createTime: '1668548786' updateTime: '1668614587' runs: /runs?property=flowId==d8ce03ea-d55c-4add-a56e-6e1c313e4250 lastOperation: started: 1668614587286 updated: 1668614594602 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: replace path: /transformations/0/params/segmentSelectors/selectors/0 value: type: PLATFORM_SEGMENT value: id: 25768be6-ebd5-45cc-8913-12fb3f348613 name: Interested in Mountain Biking description: '' filenameTemplate: '%DESTINATION%_%SEGMENT_ID%_%SEGMENT_NAME%_%DESTINATION_INSTANCE_ID%_%DESTINATION_INSTANCE_NAME%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: startDate: '2022-11-15' frequency: EVERY_3_HOURS endDate: '2022-11-23' startTime: '22:00' triggerType: SCHEDULED operation: update lastRunDetails: id: a18222fe-b5ef-48d5-acb5-835f25e6a7bb state: success startedAtUTC: 1668639937828 completedAtUTC: 1668639937836 - id: 7a6e996c-afcc-48ff-ab14-594321147cdd createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556585B77F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: (Beta) S3 Dataset Destination description: (Beta) S3 Dataset Destination flowSpec: id: 269ba276-16fc-47db-92b0-c1049a3c131f version: '1.0' state: enabled version: '"050315a3-0000-0200-0000-63756c4d0000"' etag: '"050315a3-0000-0200-0000-63756c4d0000"' sourceConnectionIds: - 8191fc9c-1e12-44c2-8d9a-bc40f5d81c9b targetConnectionIds: - f1d67830-7e4a-4e8a-8564-603542d5c596 inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: 8191fc9c-1e12-44c2-8d9a-bc40f5d81c9b connectionSpec: id: 23598e46-f560-407b-88d5-ea6207e49db0 version: '1.0' targetConnections: - id: f1d67830-7e4a-4e8a-8564-603542d5c596 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' baseConnection: id: 6893882d-ea98-4a12-b053-2a352852a8c9 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' scheduleParams: interval: 3 timeUnit: hour startTime: 1668474000 transformations: [] runs: /runs?property=flowId==7a6e996c-afcc-48ff-ab14-594321147cdd lastOperation: started: 1668539534731 updated: 1668539536003 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: replace path: /sourceConnectionIds value: - 8191fc9c-1e12-44c2-8d9a-bc40f5d81c9b - op: replace path: /scheduleParams value: interval: 3 timeUnit: hour startTime: 1668474000 operation: update lastRunDetails: id: b4de770e-c350-4b29-b2a2-8e48213d21eb state: success startedAtUTC: 1668639801888 completedAtUTC: 1668639806906 Batch_Flow_Profile_Mapping_And_Identities_V2: summary: (Beta) Segment export dataflow with segments, profile mappings, primary and mandatory fields value: items: - id: d8ce03ea-d55c-4add-a56e-6e1c313e4250 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556587477F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 1a0514a6-33d4-4c7f-aff8-594799c47549 version: '1.0' state: enabled version: '"0503aab5-0000-0200-0000-63756cd10000"' etag: '"0503aab5-0000-0200-0000-63756cd10000"' sourceConnectionIds: - aacb95f5-e451-4db6-bd72-de9845f9b1d0 targetConnectionIds: - e609bd68-ef20-41f8-910d-7a8a4b177954 inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: aacb95f5-e451-4db6-bd72-de9845f9b1d0 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: be3e2d03-6134-4566-9865-c40e0df8b718 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: e609bd68-ef20-41f8-910d-7a8a4b177954 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' baseConnection: id: 104c0cd4-31a8-4879-b913-96b609dad2c1 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' transformations: - name: GeneralTransform params: mandatoryFields: - ECID primaryFields: - identityNamespace: ECID fieldType: IDENTITY profileMapping: mappingId: 5d21b87871df4f5ea93b436c5e8da224 mappingVersion: 0 segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: 25768be6-ebd5-45cc-8913-12fb3f348613 name: Interested in Mountain Biking description: '' filenameTemplate: '%DESTINATION%_%SEGMENT_ID%_%SEGMENT_NAME%_%DESTINATION_INSTANCE_ID%_%DESTINATION_INSTANCE_NAME%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: frequency: EVERY_3_HOURS triggerType: SCHEDULED startDate: '2022-11-15' endDate: '2022-11-23' startTime: '22:00' createTime: '1668548786' updateTime: '1668614587' runs: /runs?property=flowId==d8ce03ea-d55c-4add-a56e-6e1c313e4250 lastOperation: started: 1668614587286 updated: 1668614594602 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: replace path: /transformations/0/params/segmentSelectors/selectors/0 value: type: PLATFORM_SEGMENT value: id: 25768be6-ebd5-45cc-8913-12fb3f348613 name: Interested in Mountain Biking description: '' filenameTemplate: '%DESTINATION%_%SEGMENT_ID%_%SEGMENT_NAME%_%DESTINATION_INSTANCE_ID%_%DESTINATION_INSTANCE_NAME%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: FIRST_FULL_THEN_INCREMENTAL schedule: startDate: '2022-11-15' frequency: EVERY_3_HOURS endDate: '2022-11-23' startTime: '22:00' triggerType: SCHEDULED operation: update lastRunDetails: id: a18222fe-b5ef-48d5-acb5-835f25e6a7bb state: success startedAtUTC: 1668639937828 completedAtUTC: 1668639937836 Create_Batch_Destination_Flow_Dataset_V2: summary: (Beta) Create dataset dataflow to a batch destination value: name: Activate datasets to a batch destination description: This operation creates a dataflow which will be used to activate datasets to a batch destination (e.g. Amazon S3) flowSpec: id: '{FLOW_SPEC_ID}' version: '1.0' sourceConnectionIds: - '{SOURCE_CONNECTION_ID}' targetConnectionIds: - '{TARGET_CONNECTION_ID}' transformations: [] Batch_Flow_Dataset_Schedule_V2: summary: Dataset export dataflow with schedule parameters value: items: - id: 7a6e996c-afcc-48ff-ab14-594321147cdd createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556585B77F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 269ba276-16fc-47db-92b0-c1049a3c131f version: '1.0' state: enabled version: '"050315a3-0000-0200-0000-63756c4d0000"' etag: '"050315a3-0000-0200-0000-63756c4d0000"' sourceConnectionIds: - 8191fc9c-1e12-44c2-8d9a-bc40f5d81c9b targetConnectionIds: - f1d67830-7e4a-4e8a-8564-603542d5c596 inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: 8191fc9c-1e12-44c2-8d9a-bc40f5d81c9b connectionSpec: id: 23598e46-f560-407b-88d5-ea6207e49db0 version: '1.0' targetConnections: - id: f1d67830-7e4a-4e8a-8564-603542d5c596 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' baseConnection: id: 6893882d-ea98-4a12-b053-2a352852a8c9 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' scheduleParams: interval: 3 timeUnit: hour startTime: 1668474000 transformations: [] runs: /runs?property=flowId==7a6e996c-afcc-48ff-ab14-594321147cdd lastOperation: started: 1668539534731 updated: 1668539536003 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: replace path: /sourceConnectionIds value: - 8191fc9c-1e12-44c2-8d9a-bc40f5d81c9b - op: replace path: /scheduleParams value: interval: 3 timeUnit: hour startTime: 1668474000 operation: update lastRunDetails: id: b4de770e-c350-4b29-b2a2-8e48213d21eb state: success startedAtUTC: 1668639801888 completedAtUTC: 1668639806906 Patch_Profile_Mapping: summary: (Beta) Patch a profile mapping set value: - op: add path: /transformations/0/params/profileMapping value: mappingId: 7acb0b72008d4ca1982970041834d40e mappingVersion: 0 Batch_Flow_Daily_Full_Once_Scheduled: summary: Batch Destination (mode=Daily Full, frequency=Once, trigger=Scheduled) value: items: - id: ca5c6e9a-8559-4a08-97a5-f15b756da600 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556585B77F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 71471eba-b620-49e4-90fd-23f1fa0174d8 version: '1.0' state: enabled version: '"04001b6d-0000-0200-0000-62d9a2ec0000"' etag: '"04001b6d-0000-0200-0000-62d9a2ec0000"' sourceConnectionIds: - f3a5e232-eba3-428b-aa69-921d122d5db5 targetConnectionIds: - 54d575d8-43c9-4d3d-aec5-b033e4189f4a inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: f3a5e232-eba3-428b-aa69-921d122d5db5 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: a9ae9a98-950d-468f-ac28-bc42bcd55d78 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: 54d575d8-43c9-4d3d-aec5-b033e4189f4a connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' baseConnection: id: 459779de-6f0a-46dd-9b64-10121316a8d9 connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' transformations: - name: GeneralTransform params: profileSelectors: selectors: - type: JSON_PATH value: path: person.name.firstName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.firstName destination: person.name.firstName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.firstName destinationXdmPath: person.name.firstName - type: JSON_PATH value: path: person.name.lastName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.lastName destination: person.name.lastName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.lastName destinationXdmPath: person.name.lastName - type: JSON_PATH value: path: personalEmail.address operator: EXISTS mapping: sourceType: text/x.schema-path source: personalEmail.address destination: personalEmail.address identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: personalEmail.address destinationXdmPath: personalEmail.address - type: JSON_PATH value: path: segmentMembership.status operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status destination: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: segmentMembership.status destinationXdmPath: segmentMembership.status mandatoryFields: - person.name.firstName - person.name.lastName primaryFields: - fieldType: ATTRIBUTE attributePath: personalEmail.address segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: 979558ae-a8ba-4e6e-b6ba-95c0a523b44a name: Combined First and Last Name Segment description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: frequency: ONCE triggerType: SCHEDULED startDate: '2022-07-22' startTime: '23:00' createTime: '1658344069' updateTime: '1658427026' runs: /runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600 lastOperation: started: 1658427025696 updated: 1658427031832 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: 979558ae-a8ba-4e6e-b6ba-95c0a523b44a name: Combined First and Last Name Segment description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: startDate: '2022-07-22' frequency: ONCE startTime: '23:00' triggerType: SCHEDULED operation: update lastRunDetails: id: daa87aaa-6969-458d-bc41-609c52ebc2b1 state: success startedAtUTC: 1658430155398 completedAtUTC: 1658430160403 Patch_Batch_Flow_Enrichment_Info_Daily_Full_Once_Scheduled: summary: Add enrichment attributes to a batch destination dataflow (mode=Daily Full, frequency=Once, trigger=Scheduled) value: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: extaud9001 systemSegmentId: 979558ae-a8ba-4e6e-b6ba-95c0a523b44a namespace: aamSegments name: Combined First and Last Name Segment description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: startDate: '2022-07-22' frequency: ONCE startTime: '23:00' triggerType: SCHEDULED enrichmentInfo: enabled: true sourceType: AUDIENCE_DATASET mappingSet: id: 1111-1111-1111-1111 version: 0 Patch_Batch_Flow_Daily_Full_Once_Scheduled: summary: Add segment to a batch destination dataflow (mode=Daily Full, frequency=Once, trigger=Scheduled) value: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: 979558ae-a8ba-4e6e-b6ba-95c0a523b44a name: Combined First and Last Name Segment description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: startDate: '2022-07-22' frequency: ONCE startTime: '23:00' triggerType: SCHEDULED Patch_Flow_Response: summary: Patch Flow Response value: id: ca5c6e9a-8559-4a08-97a5-f15b756da600 etag: '"04000e7f-0000-0200-0000-62d9bca40000"' Patch_Mandatory_Fields: summary: (Beta) Patch a mandatory field value: - op: add path: /transformations/0/params/mandatoryFields value: - GAID Patch_Profile_Selectors: summary: Add, update, or remove profile attributes from your destination value: - op: add path: /transformations/0/params/profileSelectors/selectors/- value: type: JSON_PATH value: path: person.name.firstName operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.firstName destinationXdmPath: person.name.firstName - op: add path: /transformations/0/params/profileSelectors/selectors/- value: type: JSON_PATH value: path: person.name.lastName operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.lastName destinationXdmPath: person.name.lastName - op: remove path: /transformations/0/params/profileSelectors/selectors/0 value: type: JSON_PATH value: path: loyalty.points operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: loyalty.points destinationXdmPath: loyalty.points Create_Batch_Destination_Flow_Segment_V2: summary: (Beta) Create segment dataflow to a batch destination value: name: Activate segments to a batch destination description: This operation creates a dataflow which we will later use to activate segments to a batch destination (e.g. Amazon S3 or Adobe Campaign) flowSpec: id: '{FLOW_SPEC_ID}' version: '1.0' sourceConnectionIds: - '{SOURCE_CONNECTION_ID}' targetConnectionIds: - '{TARGET_CONNECTION_ID}' transformations: - name: GeneralTransform params: mandatoryFields: [] primaryFields: [] profileMapping: {} segmentSelectors: selectors: [] Batch_Flow_Daily_Full_Scheduled: summary: Batch Destination (mode=Daily Full, frequency=Daily, trigger=Scheduled) value: items: - id: ca5c6e9a-8559-4a08-97a5-f15b756da600 createdAt: 1658340453699 updatedAt: 1658430188496 createdBy: 0A4334FA556585B77F000101@AdobeID updatedBy: acp_foundation_connectors@AdobeID createdClient: exc_app updatedClient: acp_foundation_connectors sandboxId: 6ef74723-3ee7-46a4-b747-233ee7a6a41a sandboxName: sample-platform-sandbox imsOrgId: 5555467B5D8013E50A494220@AdobeOrg name: Documentation S3 Destination description: Documentation S3 Destination flowSpec: id: 71471eba-b620-49e4-90fd-23f1fa0174d8 version: '1.0' state: enabled version: '"04001b6d-0000-0200-0000-62d9a2ec0000"' etag: '"04001b6d-0000-0200-0000-62d9a2ec0000"' sourceConnectionIds: - f3a5e232-eba3-428b-aa69-921d122d5db5 targetConnectionIds: - 54d575d8-43c9-4d3d-aec5-b033e4189f4a inheritedAttributes: properties: isDestinationFlow: true sourceConnections: - id: f3a5e232-eba3-428b-aa69-921d122d5db5 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' baseConnection: id: a9ae9a98-950d-468f-ac28-bc42bcd55d78 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: ProfileFragments id: ups targetConnections: - id: 54d575d8-43c9-4d3d-aec5-b033e4189f4a connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' baseConnection: id: 459779de-6f0a-46dd-9b64-10121316a8d9 connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' transformations: - name: GeneralTransform params: profileSelectors: selectors: - type: JSON_PATH value: path: person.name.firstName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.firstName destination: person.name.firstName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.firstName destinationXdmPath: person.name.firstName - type: JSON_PATH value: path: person.name.lastName operator: EXISTS mapping: sourceType: text/x.schema-path source: person.name.lastName destination: person.name.lastName identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: person.name.lastName destinationXdmPath: person.name.lastName - type: JSON_PATH value: path: personalEmail.address operator: EXISTS mapping: sourceType: text/x.schema-path source: personalEmail.address destination: personalEmail.address identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: personalEmail.address destinationXdmPath: personalEmail.address - type: JSON_PATH value: path: segmentMembership.status operator: EXISTS mapping: sourceType: text/x.schema-path source: segmentMembership.status destination: segmentMembership.status identity: false primaryIdentity: false functionVersion: 0 sourceAttribute: segmentMembership.status destinationXdmPath: segmentMembership.status mandatoryFields: - person.name.firstName - person.name.lastName primaryFields: - fieldType: ATTRIBUTE attributePath: personalEmail.address segmentSelectors: selectors: - type: PLATFORM_SEGMENT value: id: 6eeafdd5-e6db-485a-af30-e663c9b26bff name: Female profile description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: frequency: DAILY triggerType: SCHEDULED startDate: '2022-07-20' endDate: '2022-07-30' startTime: '21:00' createTime: '1658344069' updateTime: '1658427026' runs: /runs?property=flowId==ca5c6e9a-8559-4a08-97a5-f15b756da600 lastOperation: started: 1658427025696 updated: 1658427031832 percentCompleted: 100 status: value: completed properties: null errors: [] ops: - op: add path: /transformations/0/params/segmentSelectors/selectors/- value: type: PLATFORM_SEGMENT value: id: 6eeafdd5-e6db-485a-af30-e663c9b26bff name: Female profile description: '' filenameTemplate: '%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%' exportMode: DAILY_FULL_EXPORT schedule: startDate: '2022-07-20' frequency: DAILY endDate: '2022-07-30' startTime: '21:00' triggerType: SCHEDULED operation: update lastRunDetails: id: daa87aaa-6969-458d-bc41-609c52ebc2b1 state: success startedAtUTC: 1658430155398 completedAtUTC: 1658430160403