openapi: 3.0.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. >**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. - **Related documentation**: - [Destinations overview](http://www.adobe.com/go/destinations-overview-en) - [Activate data to file-based destinations - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/activate-segments-file-based-destinations.html) - [Activate data to streaming destinations - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/streaming-destinations.html) - [Update destination dataflows - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/update-destination-dataflows.html) - [Export datasets - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/export-datasets.html) - **API paths**: - PLATFORM Gateway URL: https://platform.adobe.io/ - Base path for this API: /data/foundation/flowservice - Example of a complete path: https://platform.adobe.io/data/foundation/flowservice/flows - **Required headers**: - 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). - 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. - 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`. - **API error handling**: - 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. - **Sorting and filtering responses**: - 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 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: Changelog # description: This section includes the changes introduced to the Flow Service - Destinations API. # # # # #
Release dateParameter or method updateBreaking change (Yes/No)Description
09/07/2022`isDestinationFlow` parameterNoThis parameter is returned in API responses for destination dataflows only.
Use it when calling the Retrieve a list of destination dataflows GET endpoint with the query parameter `property=inheritedAttributes.properties.isDestinationFlow==true` to return destination dataflows only.
09/07/2022Published Destinations Flow Service - API referenceNoInitial publish of the API reference documentation to the Adobe Experience Platform developer website.
- name: (NEW) Interactive API documentation description: You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your [authentication credentials](https://www.adobe.com/go/platform-api-get-credentials-en) and use the **Try it** functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes. - name: Glossary description: This section describes the terms that you will be encountering in this API documentation. For a complete reference of Experience Platform API terms, read the [Adobe Experience Platform glossary](https://experienceleague.adobe.com/docs/experience-platform/landing/glossary.html).
TermDescription
Base connectionBase connections retain authentication information regarding how to connect to a target destination. You must set up a base connection before you can create a target connection.
Source connectionSource connections create and manage a connection to the internal source from where data is exported. For destination connections, the source connection can be either the Experience Platform Profile Store when exporting segments or Experience Platform Data Lake, when [exporting datasets](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/export-datasets.html).
Target connectionTarget connections create and manage a destination connection to any location where exported data will land. Target connections contain information regarding data destination, data format, and the target connection ID needed to create a destination dataflow.
DataflowA dataflow is a virtual pipeline of data that flows into Platform from a source and out to a destination. This API reference focuses on destination dataflows.
Dataflow runA dataflow run is an execution instance of a dataflow that lands in Experience Platform based on a user-specified schedule OR that is exported from Experience Platform to a destination of your choice, also based on a user-specified schedule and other criteria. This API reference focuses on dataflow runs to destinations.
- name: Base connections description: > Base connections retain information regarding how to connect to a source or target. For destinations, the source that you are connecting to is Experience Platform data and the target is the desired destination. The base connection configuration always includes a unique `connectionSpec ID`, which is necessary in order to successfully access Experience Platform data and authorize a connection to the target destination. - name: Source connections description: Source connections create and manage a connection to the internal source from where data is exported. For destination connections, the source connection can be either the Experience Platform Profile Store or the Experience Platform Data Lake. Source connections contain information like data source, data format, and the source connection ID needed to create a dataflow. A source connection instance is specific to a tenant and organization. - name: Target connections description: Target connections create and manage a destination connection to any location where exported data will land. Target connections contain information regarding data destination, data format, and the target connection ID needed to create a destination dataflow. A target connection instance is specific to a tenant and organization.

Before you create a target connection, you must create a base connection. - 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. - name: Dataflow runs description: Dataflow runs represent an instance of a dataflow execution, which exports data to your destination. A dataflow run is specific to a dataflow and a segment for which the data export occurred. Furthermore, a run instance is specific to a tenant and organization. - name: Configurations description: Configurations provide additional information that is necessary when setting up a dataset export. paths: /connections: get: tags: - Base connections summary: Retrieve a list of destination base connections description: > You can retrieve a list of all destination base connections for your organization by making a GET request to the `/connections` endpoint. You can use query parameters to return only the base connections for a specific destination type. To do this, pass in the `connectionSpec.id` of the desired destination by using the `property` query parameter, as shown further below. >**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 base connections that are most relevant to you. operationId: getConnections 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==f2d1a98b-6b8c-420b-80a1-696c3f192eb2,b6730e09-7da6-40e2-b5cf-289545056dc3,49d17eff-9fa7-4e92-b84e-ab65fcb4730a`. required: false schema: type: string examples: filterS3Connection: summary: Filter to return connections for Amazon S3 destinations only. value: "connectionSpec.id==4fce964d-3f37-408f-9778-e597338a21ee" filterSftpConnection: summary: Filter to return connections for SFTP destinations only. value: "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 base connections that match the request parameters. x-summary: "List of Base Connections Retrieved" content: application/json: schema: $ref: '#/components/schemas/ConnectionItem' examples: Connections: $ref: '#/components/examples/ConnectionsResponse' '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: - Base connections summary: Create a target base connection description: > A target base connection authorizes the connection to your desired destination type. The required authorization parameters vary based on the destination that you are looking to connect to. operationId: postTargetBaseConnection 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_S3_Base_Connection_Request' - $ref: '#/components/schemas/Create_SFTP_Base_Connection_Request' - $ref: '#/components/schemas/Create_S3_Base_Connection_Request_V2' - $ref: '#/components/schemas/Create_SFTP_Base_Connection_Request_V2' examples: Create_S3_Base_Connection: $ref: '#/components/examples/Create_S3_Base_Connection' Create_SFTP_With_Password_Connection: $ref: '#/components/examples/Create_SFTP_With_Password_Base_Connection' Create_SFTP_With_SSH_Key_Connection: $ref: '#/components/examples/Create_SFTP_With_SSH_Key_Base_Connection' responses: '201': description: A new base connection was successfully created. The response contains the unique identifier (ID) and the etag value of the base connection. x-summary: "Base Connection Created Successfully" content: application/json: schema: $ref: '#/components/schemas/Create_Base_Connection_Response' examples: Create_Base_Connection_Response: $ref: '#/components/examples/Create_Base_Connection_Response' '400': description: Bad request. A valid connection spec ID is required. x-summary: "Bad Request - Invalid Connection Spec ID" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: message: "Please provide a valid spec id" '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' '422': description: connectionSpec.version 'version' is required for spec info. Make sure to include the version parameter alongside the connectionSpec. version is usually "1.0". x-summary: "Unprocessable Entity - Missing Required Version Parameter" 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' /connections/{id}: get: tags: - Base connections summary: Retrieve the details of a base connection description: > You can retrieve detailed information about a specific base connection by making a GET request to the `/connections` endpoint and providing the ID of the connection you want to inspect. operationId: getConnectionById parameters: - name: id in: path description: "The ID of the connection 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 base connection was successfully retrieved. x-summary: "Base Connection Details Retrieved" content: application/json: schema: $ref: '#/components/schemas/ConnectionItem' examples: Amazon_S3_Connection: $ref: '#/components/examples/Amazon_S3_Connection' SFTP_Connection: $ref: '#/components/examples/SFTP_Connection' Amazon_S3_Connection_V2: $ref: '#/components/examples/Amazon_S3_Connection_V2' SFTP_Connection_V2: $ref: '#/components/examples/SFTP_Connection_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 base connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: "Not Found - Base Connection ID Not Found" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: "connections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]" errorDetails: "connections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]" '500': description: An Internal error occurred. x-summary: "Internal Server Error" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ patch: tags: - Base connections summary: Update a base connection description: > You can update a base connection by making a PATCH request to the `/connections` endpoint and providing the ID of the base connection you want to update. In the body of the request, provide the updated configuration of the connection. operationId: patchConnectionById parameters: - name: id in: path description: "The ID of the connection 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/PatchConnectionItem' examples: Patch_Connection_Remove_Auth_Params: $ref: '#/components/examples/Patch_Connection_Remove_Auth_Params' Patch_Connection_Add_S3_Auth_Params: $ref: '#/components/examples/Patch_Connection_Add_S3_Auth_Params' Patch_Connection_Replace_Auth_Params: $ref: '#/components/examples/Patch_Connection_Replace_Auth_Params' responses: '200': description: Details of your newly updated base connection are returned. x-summary: "Base Connection Updated Successfully" content: application/json: schema: $ref: '#/components/schemas/Patch_Connection_Response' examples: Patch_Connection_Response: $ref: '#/components/examples/Patch_Connection_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 base connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: "Not Found - Base Connection ID Not Found" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: "connections not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]" errorDetails: "connections 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 or if the supplied eTag is not correctly wrapped in double quotes. 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, while ensuring the eTag is wrapped in double quotes "". 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' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ delete: tags: - Base connections summary: Delete a base connection description: > You can delete the specified base connection by making a DELETE request to the `/connections` endpoint and providing the ID of the connection that you wish to delete in the request path. operationId: deleteConnectionById parameters: - name: id in: path description: "The ID of the connection 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 connection. The API will return an HTTP 404 (Not Found) error, indicating that the connection has been deleted. x-summary: "Deletion Request Accepted" '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 base connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: "Not Found - Base Connection ID Not Found" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: "connections not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]" errorDetails: "connections 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' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ /sourceConnections: get: tags: - Source connections summary: Retrieve a list of source connections for destinations description: > You can retrieve a list of all source connections for destinations in your organization by making a GET request to the `/sourceConnections` endpoint.
You can use query parameters to return only the base connections for a specific destination type. To do this, pass in the `connectionSpec.id` of the desired destination by using the `property` query parameter, as shown further below. operationId: getSourceConnections 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==f2d1a98b-6b8c-420b-80a1-696c3f192eb2,b6730e09-7da6-40e2-b5cf-289545056dc3,49d17eff-9fa7-4e92-b84e-ab65fcb4730a`. required: false schema: type: string examples: filterProfileSourceConnection: summary: Filter source connection to the Experience Platform Profile Store value: "connectionSpec.id==8a9c3494-9708-43d7-ae3f-cda01e5030e1" filterProfileSourceConnectionByDate: summary: Filter all source connections to the Experience Platform Profile Store created after August 7th, 2022 value: "createdAt>=1659907304000&property=connectionSpec.id==8a9c3494-9708-43d7-ae3f-cda01e5030e1" - $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 source connections that match the request parameters. x-summary: "List of Source Connections Retrieved" content: application/json: schema: $ref: '#/components/schemas/SourceConnectionItem' examples: Connections: $ref: '#/components/examples/SourceConnectionsResponse' '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: - Source connections summary: Create a source connection description: > A source connection for destinations establishes the connection to the Experience Platform Profile Store or Experience Platform Data Lake. The `sourceConnection ID` returned in a successful response must be used when creating a dataflow to your desired destination. operationId: postSourceConnection 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_Source_Connection_Request' - $ref: '#/components/schemas/Create_Data_Lake_Source_Connection_Request' examples: Create_Source_Connection_Profile_Store: $ref: '#/components/examples/Create_Source_Connection_Profile_Store' Create_Source_Connection_Data_Lake: $ref: "#/components/examples/Create_Source_Connection_Data_Lake" responses: '201': description: A new source connection was successfully created. The response contains the unique identifier (ID) and the etag value of the source connection. x-summary: Source connection created successfully content: application/json: schema: $ref: '#/components/schemas/Create_Source_Connection_Response' examples: Create_Source_Connection_Response: $ref: '#/components/examples/Create_Source_Connection_Response' '401': description: The token provided in the Authorization header is invalid. x-summary: Invalid authentication 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: Unauthorized access content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: connectionSpec.version 'version' is required for spec info x-summary: Missing required field 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' /sourceConnections/{id}: get: tags: - Source connections summary: Retrieve the details of a source connection description: > You can retrieve detailed information about a specific source connection by making a GET request to the `/sourceConnections` endpoint and providing the ID of the connection you want to inspect. operationId: getSourceConnectionById parameters: - name: id in: path description: "The ID of the source connection 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 source connection was successfully retrieved. x-summary: "Source Connection Details Retrieved" content: application/json: schema: $ref: '#/components/schemas/SourceConnectionItem' examples: SourceConnectionsResponseUPS: $ref: '#/components/examples/SourceConnectionsResponseUPS' SourceConnectionsResponseDataLake: $ref: '#/components/examples/SourceConnectionsResponseDataLake_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 source connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: "Not Found - Source Connection ID Missing" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: "sourceConnections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]" errorDetails: "sourceConnections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]" '500': description: An Internal error occurred. x-summary: "Internal Server Error" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ delete: tags: - Source connections summary: Delete a source connection description: > You can delete the specified source connection by making a DELETE request to the `/sourceConnections` endpoint and providing the ID of the source connection that you wish to delete in the request path. operationId: deleteSourceConnectionById parameters: - name: id in: path description: "The ID of the source connection 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 source connection. The API will return an HTTP 404 (Not Found) error, indicating that the source connection has been deleted. x-summary: "Deletion Accepted - Source Connection 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 source connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: "Not Found - Source Connection ID Not Found" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: "sourceConnections not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]" errorDetails: "sourceConnections 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' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ /targetConnections: get: tags: - Target connections summary: Retrieve a list of destination target connections description: > You can retrieve a list of all destination target connections for your organization by making a GET request to the `/targetConnections` endpoint. You can use query parameters to return only the target connections for a specific destination type. To do this, pass in the `connectionSpec.id` of the desired destination by using the `property` query parameter, as shown further below. >**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 target connections that are most relevant to you. operationId: getTargetConnections 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==f2d1a98b-6b8c-420b-80a1-696c3f192eb2,b6730e09-7da6-40e2-b5cf-289545056dc3,49d17eff-9fa7-4e92-b84e-ab65fcb4730a`. required: false schema: type: string examples: filterS3Connection: summary: Filter connection for Amazon S3 destination value: "connectionSpec.id==4fce964d-3f37-408f-9778-e597338a21ee" filterSftpConnection: summary: Filter connection for SFTP destination value: "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: The specified target connection was successfully retrieved. x-summary: "Target Connection Details Retrieved" content: application/json: schema: $ref: '#/components/schemas/TargetConnectionItem' examples: Amazon_S3_Target_Connection: $ref: '#/components/examples/Amazon_S3_Target_Connection' SFTP_Target_Connection: $ref: '#/components/examples/SFTP_Target_Connection' Amazon_S3_Target_Connection_Segment_V2: $ref: '#/components/examples/Amazon_S3_Target_Connection_Segment_V2' Amazon_S3_Target_Connection_Dataset_V2: $ref: '#/components/examples/Amazon_S3_Target_Connection_Dataset_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 target connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: "Not Found - Target Connection ID Missing" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: "targetConnections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]" errorDetails: "targetConnections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]" '500': description: An Internal error occurred. x-summary: "Internal Server Error" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' post: tags: - Target connections summary: Create a target connection description: > Create a target connection to manage a destination connection to any location where exported data will land. In the request payload, specify information regarding the data destination and data format. The HTTP response returns the target connection ID, which you'll later need to create a destination dataflow. operationId: postTargetConnection 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_S3_Target_Connection_Request' - $ref: '#/components/schemas/Create_SFTP_Target_Connection_Request' - $ref: '#/components/schemas/Create_S3_Target_Connection_Request_V2' - $ref: '#/components/schemas/Create_SFTP_Target_Connection_Request_V2' examples: Create_SFTP_Target_Connection: $ref: '#/components/examples/Create_SFTP_Target_Connection' Create_S3_Target_Connection_Dataset: $ref: "#/components/examples/Create_S3_Target_Connection_Dataset" Create_S3_Target_Connection_Segment: $ref: "#/components/examples/Create_S3_Target_Connection_Segment" responses: '201': description: A new target connection was successfully created. The response contains the unique identifier (ID) and the etag value of the target connection. x-summary: "Target Connection Created Successfully" content: application/json: schema: $ref: '#/components/schemas/Create_Base_Connection_Response' examples: Create_Base_Connection_Response: $ref: '#/components/examples/Create_Base_Connection_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' '422': description: connectionSpec.version 'version' is required for spec info. Make sure to include the version parameter alongside the connectionSpec. version is usually "1.0". x-summary: "Unprocessable Entity - Version Parameter Missing" 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' /targetConnections/{id}: get: tags: - Target connections summary: Retrieve the details of a target connection description: > You can retrieve detailed information about a specific target connection by making a GET request to the `/targetConnections` endpoint and providing the ID of the target connection you want to inspect. operationId: getTargetConnectionById parameters: - name: id in: path description: "The ID of the target connection 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 target connection was successfully retrieved. x-summary: "Target Connection Details Retrieved" content: application/json: schema: $ref: '#/components/schemas/TargetConnectionItem' examples: Amazon_S3_Target_Connection: $ref: '#/components/examples/Amazon_S3_Target_Connection' SFTP_Target_Connection: $ref: '#/components/examples/SFTP_Target_Connection' Amazon_S3_Target_Connection_Segment_V2: $ref: '#/components/examples/Amazon_S3_Target_Connection_Segment_V2' Amazon_S3_Target_Connection_Dataset_V2: $ref: '#/components/examples/Amazon_S3_Target_Connection_Dataset_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 target connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: "Not Found - Target Connection ID Missing" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: "targetConnections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]" errorDetails: "targetConnections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]" '500': description: An Internal error occurred. x-summary: "Internal Server Error" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ delete: tags: - Target connections summary: Delete a target connection description: > You can delete the specified source connection by making a DELETE request to the `/targetConnections` endpoint and providing the ID of the target connection that you wish to delete in the request path. operationId: deleteTargetConnectionById parameters: - name: id in: path description: "The ID of the target connection 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 target connection. The API will return an HTTP 404 (Not Found) error, indicating that the target connection has been deleted. x-summary: "Deletion Accepted - Target Connection 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 target connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly. x-summary: "Not Found - Target Connection ID Missing" content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: errorMessage: "targetConnections not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]" errorDetails: "targetConnections 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' /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' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ 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' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ 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' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ 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' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ /runs: get: tags: - Dataflow runs summary: Retrieve a list of destination dataflow runs description: > You can retrieve a list of all destination dataflow runs for your organization by making a GET request to the `/runs` 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).

For example, you can use query parameters to return only the dataflows runs for a particular segment ID or for a combination of segment ID and export status (`Success`, `Processing`, `Waiting`, `Failed`). To do this, use the `property` query parameter, as shown below. >**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 dataflow runs that are most relevant to you. operationId: getFlowRuns 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. Multiple property parameters can be passed to filter on more than one property. Refer examples below. schema: type: string examples: filterBySegmentId: summary: Filter dataflow runs based on a particular segment ID. value: > metrics.recordSummary.sourceSummaries[].id== filterBySegmentIdAndStatus: summary: Filter dataflow runs based on a particular segment ID and status. value: > metrics.recordSummary.sourceSummaries[].id==& metrics.statusSummary.status==success required: false - in: query name: limit description: "Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`." schema: type: integer required: false - 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 - 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 - in: query name: continuationToken description: "A token for fetching records for next page. This is a system-generated token." required: false schema: type: string responses: '200': description: Successful operation. A successful response returns a list of dataflow runs that match the request parameters. x-summary: "List of Dataflow Runs Retrieved" content: application/json: schema: $ref: '#/components/schemas/Flow_Runs' examples: Batch_Flow_Run: $ref: '#/components/examples/Batch_Flow_Run_Success' Batch_Flow_Run_Failure: $ref: '#/components/examples/Batch_Flow_Run_Failure' '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' # externalDocs: # description: Learn more about user operations provided by this API. # url: http://api.example.com/docs/user-operations/ /connectionSpecs/{id}/configs: get: tags: - Configurations summary: Retrieve a list of datasets for activation description: > You can use this endpoint to retrieve destinations-related configurations and metadata associated with a connection spec and are needed to successfully configure a dataset export. For example, when configuring dataset exports, this endpoint can return a list of activation-eligible datasets for your organization, along with metadata about the datasets. operationId: getDatasets parameters: - $ref: "#/components/parameters/Authorization" - $ref: "#/components/parameters/XApiKey" - $ref: "#/components/parameters/XImsOrgId" - $ref: "#/components/parameters/XSandboxId" - in: path name: id description: The ID of the connection spec. To return a list of dataset IDs eligible for export, use Experience Platform Data Lake source connection spec id, `23598e46-f560-407b-88d5-ea6207e49db0`. required: true schema: type: string - in: query name: outputType description: The type of configurations you want to retrieve. To return a list of dataset IDs eligible for export, use the value `activationDatasets`. schema: type: string required: true - in: query name: outputField description: The output field where configuration values will be saved. To return a list of dataset IDs eligible for export, use the value `datasets`. schema: type: string required: true - in: query name: start description: Specify the offset for the list of datasets. required: false schema: type: integer minimum: 0 default: 0 - in: query name: limit description: Specify the maximum number of datasets to be included in the response. required: false schema: type: integer minimum: 1 maximum: 100 default: 20 responses: "200": description: Successful operation. A successful response returns a list of datasets that match the request parameters and are eligible for activation. See [Catalog Service API documentation](https://developer.adobe.com/experience-platform-apis/references/catalog/#tag/Datasets/operation/retrieveDataset) for more details about individual dataset structure. x-summary: "List of Eligible Datasets Retrieved" content: application/json: examples: Destination_Dataset_Response: $ref: "#/components/examples/Destination_Dataset_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" components: schemas: Create_S3_Base_Connection_Request: type: object title: Amazon S3 Base Connection Request description: > API request to authorize the connection to an Amazon S3 instance. allOf: - $ref: '#/components/schemas/GenericBaseConnectionRequest' - $ref: '#/components/schemas/AmazonS3SecretAndAccessKeyBaseConnectionRequest' Create_S3_Base_Connection_Request_V2: type: object title: (Beta) Amazon S3 Base Connection Request description: > API request to authorize the connection to an Amazon S3 instance. allOf: - $ref: '#/components/schemas/GenericBaseConnectionRequest' - $ref: '#/components/schemas/AmazonS3SecretAndAccessKeyBaseConnectionRequest_V2' Create_SFTP_Base_Connection_Request: type: object title: SFTP Base Connection Request description: > API request to authorize the connection to an SFTP instance that uses password or SSH Key authorization. allOf: - $ref: '#/components/schemas/GenericBaseConnectionRequest' - $ref: '#/components/schemas/SFTPBaseConnectionRequest' Create_SFTP_Base_Connection_Request_V2: type: object title: (Beta) SFTP Base Connection Request description: > API request to authorize the connection to an SFTP instance that uses password or SSH Key authorization. allOf: - $ref: '#/components/schemas/GenericBaseConnectionRequest' - $ref: '#/components/schemas/SFTPBaseConnectionRequest_V2' Create_S3_Target_Connection_Request: type: object title: Amazon S3 Target Connection Request description: > API request to create a target connection to an Amazon S3 instance, specifying data export format and storage location details. allOf: - $ref: '#/components/schemas/GenericTargetConnectionRequest' - $ref: '#/components/schemas/AmazonS3TargetConnectionRequest' Create_SFTP_Target_Connection_Request: type: object title: SFTP Target Connection Request description: > API request to create a target connection to an SFTP instance, specifying data export format and storage location details. allOf: - $ref: '#/components/schemas/GenericTargetConnectionRequest' - $ref: '#/components/schemas/SFTPTargetConnectionRequest' Create_S3_Target_Connection_Request_V2: type: object title: (Beta) Amazon S3 Target Connection Request description: > API request to create a target connection to an Amazon S3 instance, specifying data export format and storage location details for activating either segments or datasets. allOf: - $ref: "#/components/schemas/GenericTargetConnectionRequest" - $ref: "#/components/schemas/AmazonS3TargetConnectionRequest_V2" Create_SFTP_Target_Connection_Request_V2: type: object title: (Beta) SFTP Target Connection Request description: > API request to create a target connection to an SFTP instance, specifying data export format and storage location details. allOf: - $ref: '#/components/schemas/GenericTargetConnectionRequest' - $ref: '#/components/schemas/SFTPTargetConnectionRequest_V2' Create_Source_Connection_Request: type: object title: Create Profile Store Source Connection Request description: > API request to create a source connection to the Experience Platform Profile Store. In the request payload, always use the hardcoded value `connectionSpec.id=8a9c3494-9708-43d7-ae3f-cda01e5030e1`. required: - name - connectionSpec properties: name: type: string title: Name description: The name of the source connection. description: type: string title: Description description: An optional description for the source connection. connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. required: - id - version 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. For connections to the Experience Platform Profile Store, the connection spec ID is always `8a9c3494-9708-43d7-ae3f-cda01e5030e1`. version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. # data: # type: object # title: Data # description: Indicates the format in which data should be exported out of the Experience Platform Profile Store. # properties: # format: # type: string # title: Format # description: Indicates the format in which data should be exported our of the Experience Platform Profile Store. # enum: [CSV] # schema: # type: string # title: Schema # description: Indicates the schema for data export out of the Experience Platform Profile Store. Create_Data_Lake_Source_Connection_Request: type: object title: (Beta) Create Data Lake Source Connection Request description: > API request to create a source connection to the Experience Platform Data Lake. In the request payload, always use the hardcoded value `connectionSpec.id=23598e46-f560-407b-88d5-ea6207e49db0`. required: - name - connectionSpec properties: name: type: string title: Name description: The name of the source connection. description: type: string title: Description description: A description for the source connection. connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. required: - id - version 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. For connections to the Experience Platform Data Lake, the connection spec ID is always `23598e46-f560-407b-88d5-ea6207e49db0`. enum: - "23598e46-f560-407b-88d5-ea6207e49db0" version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. params: type: object title: Params description: Source Connection params. properties: datasets: type: array title: Datasets description: List of datasets to export. See the `Configurations` section on how to access the list of datasets available for your organization. Please note that once a Source Connection is created, its datasets cannot be modified. If you need to add or remove datasets, create a new Source Connection with the updated values. Also, the Source Connection must be linked to a destination dataflow in order for its datasets to be exported. See the `Dataflows` section on how to configure a dataflow with a Source Connection. items: type: object properties: dataSetId: type: string title: Dataset ID description: ID of the dataset. name: title: Name description: Name of the dataset. type: string required: - dataSetId - name GenericBaseConnectionRequest: type: object title: Base Connection Request description: > A base model that outlines the common request properties across all base connection requests. required: - name properties: name: type: string title: Name description: The name of the base connection. description: type: string title: Description description: An optional description for the base connection. AmazonS3SecretAndAccessKeyBaseConnectionRequest: type: object title: Amazon S3 authorization parameters. description: > The parameters in the base connection payload which are required to authorize a connection to an Amazon S3 instance. required: - auth - connectionSpec properties: auth: $ref: '#/components/schemas/AmazonS3AuthParameters' connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. required: - id - version 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. enum: [4890fc95-5a1f-4983-94bb-e060c08e3f81] version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. AmazonS3SecretAndAccessKeyBaseConnectionRequest_V2: type: object title: (Beta) Amazon S3 authorization parameters. description: > The parameters in the base connection payload which are required to authorize a connection to an Amazon S3 instance. required: - auth - connectionSpec properties: auth: $ref: '#/components/schemas/AmazonS3AuthParameters' connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. required: - id - version 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. enum: [4fce964d-3f37-408f-9778-e597338a21ee] version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. AmazonS3AuthParameters: type: object title: Authentication Parameters description: > The parameters in the base connection payload which are required to authorize a connection to an Amazon S3 instance. properties: specName: type: string title: Spec Name description: > Support authentication scheme for connecting to Amazon S3. Currently only a single type of key-based scheme is supported. enum: [ "Access Key" ] params: type: object description: Authentication parameters for an Amazon S3 instance. required: - s3SecretKey - s3AccessKey properties: s3SecretKey: type: string title: Secret Key. description: The secret key that grants access to your Amazon S3 instance. pattern: "^[A-Za-z0-9\\/\\+]{40}$" s3AccessKey: type: string title: Access Key. description: The access key that grants access to your Amazon S3 instance. pattern: "^[A-Z2-7]{20}$" SFTPBaseConnectionRequest: type: object title: SFTP authorization parameters description: > The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password or SSH key authorization. required: - auth - connectionSpec properties: auth: description: Authentication parameters to authorize the connection to an SFTP instance. oneOf: - $ref: '#/components/schemas/SFTPWithPasswordBaseConnectionAuthParameters' - $ref: '#/components/schemas/SFTPWithSSHKeyBaseConnectionAuthParameters' connectionSpec: type: object title: Connection Spec description: Request model for connection spec information. required: - id - version 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. enum: [64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0] version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. SFTPBaseConnectionRequest_V2: type: object title: SFTP authorization parameters description: > The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password or SSH key authorization. required: - auth - connectionSpec properties: auth: description: Authentication parameters to authorize the connection to an SFTP instance. oneOf: - $ref: '#/components/schemas/SFTPWithPasswordBaseConnectionAuthParameters_V2' - $ref: '#/components/schemas/SFTPWithSSHKeyBaseConnectionAuthParameters_V2' connectionSpec: type: object title: (Beta) Connection Spec description: Request model for connection spec information. required: - id - version 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. enum: [36965a81-b1c6-401b-99f8-22508f1e6a26] version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. SFTPWithPasswordBaseConnectionAuthParameters: type: object title: Authentication Parameters for SFTP with password authorization description: The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password authorization. properties: specName: type: string title: Spec Name description: > The supported authentication scheme for connecting to an SFTP instance with password authorization. enum: [ "Basic Authentication for sftp" ] params: type: object description: The authentication parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password authorization. required: - domain - host - username - password properties: domain: type: string title: Domain description: The IP address or the domain name of your SFTP account. host: type: string title: Host description: The address of your SFTP storage location. username: type: string title: Username description: The username used to access the SFTP location. password: type: string title: Password description: The password used to access the SFTP location. SFTPWithPasswordBaseConnectionAuthParameters_V2: type: object title: (Beta) Authentication Parameters for SFTP with password authorization description: > The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password authorization. properties: specName: type: string title: Spec Name description: > The supported authentication scheme for connecting to an SFTP instance with password authorization. enum: [ "SFTP with Password" ] params: type: object description: The authentication parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password authorization. required: - domain - username - password properties: domain: type: string title: Domain description: The IP address or the domain name of your SFTP account. example: yourcompany.sftplocation.com username: type: string title: Username description: The username used to access the SFTP location. password: type: string title: Password description: The password used to access the SFTP location. SFTPWithSSHKeyBaseConnectionAuthParameters: type: object title: Authentication Parameters for SFTP with SSH Key authorization description: The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses SSH key authorization. properties: specName: type: string title: Spec Name description: > The supported authentication scheme for connecting to an SFTP instance with SSH Key authorization. enum: [ "SFTP with SSH Key" ] params: type: object description: The authentication parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses SSH Key authorization. required: - domain - host - username - sshKey - port properties: domain: type: string title: Domain description: The IP address or the domain name of your SFTP account. host: type: string title: Host description: The address of your SFTP storage location. username: type: string title: Username description: The username used to access the SFTP location. sshKey: type: string title: SSH Key description: The SSH Key used to access the SFTP location. port: type: integer title: Port description: The port used to access the SFTP location. SFTPWithSSHKeyBaseConnectionAuthParameters_V2: type: object title: (Beta) Authentication Parameters for SFTP with SSH Key authorization description: > The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses SSH key authorization. properties: specName: type: string title: Spec Name description: > The supported authentication scheme for connecting to an SFTP instance with SSH Key authorization. enum: [ "SFTP with SSH Key" ] params: type: object description: The authentication parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses SSH Key authorization. required: - domain - username - sshKey properties: domain: type: string title: Domain description: The IP address or the domain name of your SFTP account. example: yourcompany.sftplocation.com username: type: string title: Username description: The username used to access the SFTP location. sshKey: type: string title: SSH Key description: The SSH Key used to access the SFTP location. GenericTargetConnectionRequest: type: object title: Target Connection Request description: > A base model that outlines the common request properties across all target connection requests. required: - name - baseConnectionId properties: name: type: string title: Name description: The name of the target connection. description: type: string title: Description description: An optional description for the target connection. baseConnectionId: type: string title: Base Connection ID description: The ID of the base connection that specifies authentication details for the destination. Each target connection *must* have an associated base connection. AmazonS3TargetConnectionRequest: type: object title: Amazon S3 target connection parameters description: > The parameters in the base connection payload which are required to authorize a connection to an Amazon S3 instance. required: - params - connectionSpec properties: params: type: object required: - bucketName - path title: Target connection parameters description: Request model to capture target connection details for Amazon S3. properties: bucketName: type: string title: Amazon S3 bucket name description: The name of your Amazon S3 bucket, where the data will be exported. pattern: "(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)" path: type: string title: Path description: The path to the folder location in your Amazon S3 storage where the exported files will be deposited. connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. required: - id - version 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. enum: [4890fc95-5a1f-4983-94bb-e060c08e3f81] version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. SFTPTargetConnectionRequest: type: object title: SFTP target connection parameters description: > The parameters in the base connection payload which are required to authorize a connection to an SFTP instance. required: - params - connectionSpec properties: params: type: object required: - remotePath title: Target connection parameters description: Request model to capture target connection details for SFTP destination connections. properties: remotePath: type: string title: Remote Path description: The path in your SFTP location where the data will be exported. connectionSpec: type: object title: Connection Spec description: Request model for connection spec information. required: - id - version 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. enum: [64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0] version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. # base target connection params shared by profiles and datasets for Amazon S3 v2 target connection BaseTargetConnectionParams_V2: type: object title: (Beta) Base Target Connection Parameters required: - compression properties: compression: type: string title: Compression format description: Apply compression on the file before exporting to your destination. enum: - NONE - GZIP DatasetTargetConnectionParams_V2: title: Dataset specific target connection parameters type: object required: - datasetFileType properties: datasetFileType: type: string title: Dataset File Type description: File format to export datasets. enum: - JSON - PARQUET SegmentTargetConnectionParams_V2: title: (Beta) Segment specific target connection parameters type: object required: - fileType properties: fileType: type: string title: File Type description: File format to export profiles. enum: - CSV - JSON - PARQUET csvOptions: title: CSV Options description: > Configurations for CSV files (applicable only if `fileType = CSV`). For more details about these options, please refer to documentation: https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/batch-destinations-file-formatting-options.html type: object properties: delimiter: title: Delimiter description: CSV file delimiter type: string enum: - "," - "\t" - "|" - ";" - ":" default: "," quote: title: Quote Character description: Quote character. Use a JSON empty string(`""`) to specify Null character(`\u0000`) as the quote character. type: string enum: - '"' - "" default: '"' escape: title: Escape Character description: Escape character type: string enum: - "\\" - "'" default: "\\" nullValue: title: Null Value description: The output value of `null` fields. type: string enum: - "null" - '""' - "" default: "null" emptyValue: title: Empty Value description: The output value of blank fields. type: string enum: - "null" - '""' - "" default: "" BaseAmazonS3TargetConnectionParams_V2: type: object title: (Beta) Amazon S3 Base Target Connection Parameters required: - bucketName - path properties: bucketName: type: string title: Amazon S3 bucket name description: The name of your Amazon S3 bucket, where the data will be exported. pattern: "(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)" path: type: string title: Path description: The path to the folder location in your Amazon S3 storage where the exported files will be deposited. BaseSFTPTargetConnectionParams_V2: type: object title: (Beta) SFTP Base Target Connection Parameters required: - remotePath properties: remotePath: type: string title: Folder Path description: The path to the folder location in your SFTP server where the exported files will be deposited. AmazonS3TargetConnectionParams_V2: type: object title: (Beta) Amazon S3 Target Connection Parameters oneOf: - title: (Beta) Amazon S3 Target Connection Parameters for Datasets allOf: - $ref: "#/components/schemas/BaseAmazonS3TargetConnectionParams_V2" - $ref: "#/components/schemas/BaseTargetConnectionParams_V2" - $ref: "#/components/schemas/DatasetTargetConnectionParams_V2" - title: (Beta) Amazon S3 Target Connection Parameters for Segments allOf: - $ref: "#/components/schemas/BaseAmazonS3TargetConnectionParams_V2" - $ref: "#/components/schemas/BaseTargetConnectionParams_V2" - $ref: "#/components/schemas/SegmentTargetConnectionParams_V2" SFTPTargetConnectionParams_V2: type: object title: (Beta) SFTP Target Connection Parameters oneOf: - title: (Beta) SFTP Target Connection Parameters for Datasets allOf: - $ref: "#/components/schemas/BaseTargetConnectionParams_V2" - $ref: "#/components/schemas/DatasetTargetConnectionParams_V2" - $ref: "#/components/schemas/BaseSFTPTargetConnectionParams_V2" - title: (Beta) SFTP Target Connection Parameters for Segments allOf: - $ref: "#/components/schemas/BaseTargetConnectionParams_V2" - $ref: "#/components/schemas/SegmentTargetConnectionParams_V2" - $ref: "#/components/schemas/BaseSFTPTargetConnectionParams_V2" # Target Connection request for both datasets and segment exports AmazonS3TargetConnectionRequest_V2: type: object title: (Beta) Amazon Target Connection Request description: > The parameters in the target connection payload which are required to export data to an Amazon S3 instance. required: - params - connectionSpec properties: params: $ref: "#/components/schemas/AmazonS3TargetConnectionParams_V2" connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. required: - id - version 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. enum: [4fce964d-3f37-408f-9778-e597338a21ee] version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. SFTPTargetConnectionRequest_V2: type: object title: (Beta) Amazon Target Connection Request description: > The parameters in the target connection payload which are required to export data to an Amazon S3 instance. required: - params - connectionSpec properties: params: $ref: "#/components/schemas/SFTPTargetConnectionParams_V2" connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. required: - id - version 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. enum: [36965a81-b1c6-401b-99f8-22508f1e6a26] version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. Create_Base_Connection_Response: title: Create Base Connection Response description : API response for a successful create base connection operation. allOf: - $ref: '#/components/schemas/GenericEntityCreationResponse' Create_Source_Connection_Response: title: Create Source Connection Response description : API response for a successful create source connection operation. allOf: - $ref: '#/components/schemas/GenericEntityCreationResponse' GenericEntityCreationResponse: type: object title: Flow Creation Response description: API response for a successful create 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. Batch_Flow: type: object title: Batch destination dataflow response properties: items: type: array items: $ref: '#/components/schemas/BatchFlowItem' Streaming_Flow: type: object title: Streaming destination dataflow response properties: items: type: array items: $ref: '#/components/schemas/StreamingFlowItem' BatchFlowItem: description: Batch dataflow parameters allOf: - $ref: '#/components/schemas/BaseFlowItem' - $ref: '#/components/schemas/BatchTransformations' - type: 'object' properties: scheduleParams: $ref: '#/components/schemas/DatasetScheduleParams_V2' StreamingFlowItem: allOf: - $ref: '#/components/schemas/BaseFlowItem' - $ref: '#/components/schemas/StreamingTransformations' 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' 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' 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' 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' 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). 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). 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. 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. 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' 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' BatchSegmentSelectors_EnrichmentInfo_V2: type: object title: Enrichment Info Audience Selectors description: Information about the audiences that are being exported to the destination. properties: selectors: type: array title: Segment Selector Paths items: $ref: '#/components/schemas/BatchSegmentSelector_EnrichmentInfo_V2' 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. 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. 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" 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. 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 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:

  • `%DESTINATION_NAME%`: Required. The exported files contain the destination name.
  • `%SEGMENT_ID%`: Required. The exported files contain the ID of the exported segment.
  • `%SEGMENT_NAME%`: Optional. The exported files contain the name of the exported segment.
  • `%DATETIME(YYYYMMdd_HHmmss)%` or `%TIMESTAMP%`: Optional. Select one of these two options for your files to include the time when they are generated by Experience Platform.
  • `%custom-text%`: Optional. Replace this placeholder with any custom text that you would like to append at the end of your file names.
example: "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%" 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:

  • `%DESTINATION%`: Optional. The exported files contain the destination name.
  • `%SEGMENT_ID%`: Optional. The exported files contain the ID of the exported segment.
  • `%SEGMENT_NAME%`: Optional. The exported files contain the name of the exported segment.
  • `%DESTINATION_INSTANCE_ID%`: Optional. The exported files contain the id of the destination dataflow.
  • `%DESTINATION_INSTANCE_NAME%`: Optional. The exported files contain the name of the destination dataflow.
  • `%ORGANIZATION_NAME%`: Optional. The exported files contain the name of your organization within Experience Platform.
  • `%SANDBOX_NAME%`: Optional. The exported files contain the id of the sandbox where destination dataflow was created.
  • `%DATETIME(YYYYMMdd_HHmmss)%` or `%TIMESTAMP%`: Optional. Select one of these two options for your files to include the time when they are generated by Experience Platform.
  • `%custom-text%`: Optional. Replace this placeholder with any custom text that you would like to append at the end of your file names.
example: "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%" 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:

  • `%DESTINATION%`: Optional. The exported files contain the destination name.
  • `%SEGMENT_ID%`: Optional. The exported files contain the ID of the exported audience.
  • `%SEGMENT_NAME%`: Optional. The exported files contain the name of the exported audience.
  • `%DESTINATION_INSTANCE_ID%`: Optional. The exported files contain the ID of the destination dataflow.
  • `%DESTINATION_INSTANCE_NAME%`: Optional. The exported files contain the name of the destination dataflow.
  • `%ORGANIZATION_NAME%`: Optional. The exported files contain the name of your organization within Experience Platform.
  • `%SANDBOX_NAME%`: Optional. The exported files contain the ID of the sandbox where the destination dataflow was created.
  • `%DATETIME(YYYYMMdd_HHmmss)%` or `%TIMESTAMP%`: Optional. Select one of these two options for your files to include the time when they are generated by Experience Platform.
  • `%custom-text%`: Optional. Replace this placeholder with any custom text that you would like to append at the end of your file names.
example: "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%" StreamingTransformations: type: object 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"] # baseConnection: # type: string # title: Inherited base connection ID # description: ID of the base connection used when creating the source connection. # properties: # id: # type: string # title: Base Connection ID # description: The ID of the base connection used when creating the source 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. 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. 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 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). 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' 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). items: type: string title: Mandatory Field String description: > A valid profile union schema field for defining the mandatory attributes or identity namespace. 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.

  • `%DESTINATION%`: The export folder contains the destination name.
  • `%DATASET_NAME%`: The export folder contains the name of the exported dataset.
  • `%DATASET_ID%`: The export folder contains the ID of the exported dataset.
  • `%DESTINATION_INSTANCE_ID%`: The export folder contains the ID of the exported dataset.
  • `%DESTINATION_INSTANCE_NAME%`: The export folder contains the ID of the exported dataset.
  • `%SANDBOX_NAME%`: The name of the sandbox environment.
  • `%DATETIME(YYYYMMdd_HHmmss)%` or `%EXPORT_TIME%`: Select one of these two options for your export folder to include the time when the datasets are exported out of Experience Platform.
example: "%DESTINATION_NAME%_%DATASET_ID%_%DATASET_NAME%_%DATETIME(YYYYMMdd_HHmmss)%" 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 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 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 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' 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' 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:
  • All cloud storage destinations (Amazon S3, SFTP, Azure Blob) and Oracle Eloqua: `71471eba-b620-49e4-90fd-23f1fa0174d8`
  • Oracle Responsys: `51d675ce-e270-408d-91fc-22717bdf2148`
  • Salesforce Marketing Cloud: `493b2bd6-26e4-4167-ab3b-5e910bba44f0`
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.

Flow Spec ID: * `1a0514a6-33d4-4c7f-aff8-594799c47549`: (Beta) Amazon S3 - Segment * `269ba276-16fc-47db-92b0-c1049a3c131f`: (Beta) Amazon S3 - Dataset * `fd36aaa4-bf2b-43fb-9387-43785eeeb799`: (Beta) SFTP - Segment * `354d6aad-4754-46e4-a576-1b384561c440`: (Beta) SFTP - Dataset * `752d422f-b16f-4f0d-b1c6-26e448e3b388`: (Beta) Azure Blob Storage - Segment * `95bd8965-fc8a-4119-b9c3-944c2c2df6d2`: (Beta) Azure Blob Storage - Dataset * `976d663b-80b4-4193-be6b-2d0487516623`: (Beta) Google Cloud Storage - Segment * `585c15c4-6cbf-4126-8f87-e26bff78b657`: (Beta) Google Cloud Storage - Dataset * `7e635b9f-e59b-4546-8ba8-fce6496693c8`: (Beta) Data Landing Zone - Segment * `cd2fc47e-e838-4f38-a581-8fff2f99b63a`: (Beta) Data Landing Zone - Dataset * `db060570-a155-418a-a6d3-b4d97698e5dc`: (Beta) Azure Data Lake Gen2 - Segment * `17be2013-2549-41ce-96e7-a70363bec293`: (Beta) Azure Data Lake Gen2 - Dataset 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 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 Patch_Flow_Request: type: array title: Patch Flow Request description: API Request for a PATCH operation. items: $ref: '#/components/schemas/PatchFlowItem' 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: >
  • Use the segment or profile selector to display the fields relevant to adding, updating, or removing segments or profile attributes in a destination dataflow.
  • For Dataset dataflows, use the Schedule Params to control the dataset export schedule.
  • For (Beta) segment dataflows, use the Segment Selectors to manage segments, Profile Mapping Set with Primary Fields and Mandatory Fields to manage profile attributes.
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' 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. ErrorResponse: type: object Flow_Runs: type: object properties: items: type: array items: $ref: '#/components/schemas/Flow_Run' Flow_Run: type: object title: Batch Dataflow Run description: A data model representing a dataflow run entity. required: - id - flowId - createdClient - updatedClient - createdBy - updatedBy - imsOrgId - sandboxId - sandboxName - metrics properties: id: type: string title: Flow Run Id description: The ID of the dataflow run you are inspecting. flowId: type: string title: Flow Id description: The ID of the dataflow that the dataflow run belongs to. createdClient: type: string title: Created client description: The Adobe Identity Management System (IMS) client who created the dataflow run. 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 run. 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 run. 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 run. 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 run belongs. sandboxId: type: string title: Sandbox ID description: The ID of the sandbox in which the dataflow run occurred. sandboxName: type: string title: Created client description: The ID of the sandbox in which the dataflow run occurred. metrics: $ref: '#/components/schemas/FlowRunMetrics' FlowRunMetrics: type: object description: Various metrics for the dataflow run. properties: durationSummary: $ref: '#/components/schemas/DurationSummary' latencySummary: $ref: '#/components/schemas/LatencySummary' sizeSummary: $ref: '#/components/schemas/SizeSummary' recordSummary: $ref: '#/components/schemas/RecordSummary' fileSummary: $ref: '#/components/schemas/FileSummary' statusSummary: $ref: '#/components/schemas/StatusSummary' DurationSummary: type: object description: Model for capturing metrics related to the duration of the dataflow run. title: Duration Summary properties: startedAtUTC: type: integer description: Epoch in milliseconds when the dataflow run started. title: Started Time UTC stoppedAtUTC: type: integer description: Epoch in milliseconds when the dataflow run stopped. title: Stopped Time UTC extensions: $ref: '#/components/schemas/Extensions' Extensions: type: object description: Generic property bag for details. title: Extensions additionalProperties: type: object maxProperties: 20 FileSummary: type: object description: Model for capturing file metrics. title: File Summary properties: inputFileCount: type: integer description: Total number of input files. title: Input File Count outputFileCount: type: integer description: Total number of output files. title: Output File Count skippedFileCount: type: integer description: Total number of skipped files. title: Skipped File Count failedFileCount: type: integer description: Total number of failed files. title: Failed File Count extensions: $ref: '#/components/schemas/Extensions' Info: type: object description: Model to capture details for a particular error or warning that occurred within the dataflow run. For example, this can include failed records, skipped records and more. title: Info properties: code: type: string description: Standardized platform code. title: Info Code pattern: ([A-Z]{3,6})-([0-9]{3,6})-([1-5]{1}[0-9]{2}) message: type: string description: Detailed description of the encountered error or warning. title: Error Message count: type: integer description: Number of occurrences for current info code. title: Info Count type: type: string description: Error type enum: - Error - Warning LatencySummary: type: object description: Model for capturing latency metrics. title: Latency Summary properties: minMs: type: integer description: Minimum latency observed in milliseconds title: Minimum latency maxMs: type: integer description: Maximum latency observed in milliseconds title: Maximum latency avgMs: type: integer description: Average latency observed in milliseconds title: Average latency extensions: $ref: '#/components/schemas/Extensions' RecordSummary: type: object description: Model for capturing record metrics. title: Record Summary properties: inputRecordCount: type: integer description: Total records in input. title: Input Record Count createdRecordCount: type: integer description: Total records created. title: Created Record Count updatedRecordCount: type: integer description: Total records updated. title: Updated Record Count deletedRecordCount: type: integer description: Total records deleted. title: Deleted Record Count skippedRecordCount: type: integer description: Total records skipped. title: Skipped Record Count failedRecordCount: type: integer description: Total records failed. title: Failed Record Count warningRecordCount: type: integer description: Total records that triggered warnings. title: Warning Record Count failedInfo: type: array description: Additional information about failed records. title: Failed Info items: $ref: '#/components/schemas/Info' skippedInfo: type: array description: Additional information about skipped records. title: Failed Info items: $ref: '#/components/schemas/Info' warningInfo: type: array description: Additional information about records that triggered a warning. title: Warning Info items: $ref: '#/components/schemas/Info' extensions: $ref: '#/components/schemas/Extensions' SizeSummary: type: object description: Model for capturing data size metrics. title: Size Summary properties: inputBytes: type: integer description: Total bytes in input. title: Input Bytes outputBytes: type: integer description: Total bytes in output. title: Output Bytes skippedBytes: type: integer description: Total bytes which were skipped. title: Skipped Bytes failedBytes: type: integer description: Total bytes which failed. title: Failed Bytes extensions: $ref: '#/components/schemas/Extensions' StatusSummary: type: object description: Model for capturing details related to the status of the dataflow run. title: Status Summary properties: status: type: string description: Status representing the current state of the dataflow run. enum: - Success - Processing - Waiting - Failed errors: type: array description: Info about errors. title: Failed Info items: $ref: '#/components/schemas/Info' extensions: $ref: '#/components/schemas/Extensions' ConnectionItem: type: object title: Connection Items description: Parameters specific to connections. required: - id - createdAt - updatedAt - createdBy - updatedBy - createdClient - updatedClient - sandboxId - imsOrgId - name - connectionSpec - state - auth - version - etag properties: id: type: string title: Connection ID description: The ID of the base connection. createdAt: type: integer title: Connection creation time description: The epoch time in milliseconds when the base connection was created. updatedAt: type: integer title: Connection update time description: The epoch time in milliseconds when the base connection was last updated. createdBy: type: string title: Created User description: The Adobe ID of the Identity Management System (IMS) user who created the base connection. 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 base connection. In the case of service tokens, the value for `createdBy` is the same as `createdClient`. createdClient: type: string title: Created client description: The Adobe Identity Management System (IMS) client who created the base connection. This can be an application or a user. For example, the value `exc_app` represents base connections created in the Experience Platform UI. updatedClient: type: string title: Updated client description: The Adobe Identity Management System (IMS) client who last updated the base connection. This can be an application or a user. For example, the value `exc_app` represents base connections created in the Experience Platform UI. imsOrgId: type: string title: IMS org ID description: The organization ID to which the base connection belongs. sandboxId: type: string title: Sandbox ID description: The ID of the sandbox in which the base connection was created. sandboxName: type: string title: Sandbox Name description: The name of the sandbox in which the base connection was created. name: type: string title: Connection name description: The name of the base connection. 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 base connection. state: type: string title: Connection state description: > Represents the current state of the base connection. A base connection can be `enabled` or `disabled`. enum: [enabled, disabled] connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. 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. auth: description: Authentication parameters specific to the destination type. oneOf: - $ref: '#/components/schemas/AmazonS3Auth' - $ref: '#/components/schemas/SFTPWithPasswordBaseConnectionAuthParameters' - $ref: '#/components/schemas/SFTPWithSSHKeyBaseConnectionAuthParameters' - $ref: '#/components/schemas/SFTPWithPasswordBaseConnectionAuthParameters_V2' - $ref: '#/components/schemas/SFTPWithSSHKeyBaseConnectionAuthParameters_V2' TargetConnectionItem: type: object title: Target Connection Item description: Parameters specific to target connection. required: - id - createdAt - updatedAt - createdBy - updatedBy - createdClient - updatedClient - sandboxId - sandboxName - imsOrgId - name - baseConnectionId - connectionSpec - state - params - version - etag - inheritedAttributes properties: id: type: string title: Target Connection ID description: The ID of the target connection. createdAt: type: integer title: Connection creation time description: The epoch time in milliseconds when the target connection was created. updatedAt: type: integer title: Connection update time description: The epoch time in milliseconds when the target connection was last updated. createdBy: type: string title: Created User description: The Adobe ID of the Identity Management System (IMS) user who created the target connection. 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 target connection. In the case of service tokens, the value for `createdBy` is the same as `createdClient`. createdClient: type: string title: Created client description: The Adobe Identity Management System (IMS) client who created the target connection. 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 target connection. This can be an application or a user. For example, the value `exc_app` represents dataflows created in the Experience Platform UI. imsOrgId: type: string title: IMS org ID description: The organization ID to which the target connection belongs. sandboxId: type: string title: Sandbox ID description: The ID of the sandbox in which the target connection was created. sandboxName: type: string title: Sandbox name description: The name of the sandbox in which the target connection was created. name: type: string title: Connection name description: The name of the target connection. baseConnectionId: type: string title: Base connection ID description: The ID of the base connection used to create the target connection. 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 target connection. state: type: string title: Connection state description: > Represents the current state of the target connection. A target connection can be `enabled` or `disabled`. enum: [enabled, disabled] params: description: Parameters specific to the destination type. oneOf: - $ref: '#/components/schemas/AmazonS3TargetConnectionParams' - $ref: '#/components/schemas/SFTPTargetConnectionParams' - $ref: '#/components/schemas/AmazonS3TargetConnectionParams_V2' - $ref: '#/components/schemas/SFTPTargetConnectionParams_V2' inheritedAttributes: type: object title: Inherited attributes description: Attributes inherited from the base connection used when creating this connection. properties: baseConnection: type: string title: Inherited base connection ID description: ID of the base connection used when creating this 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. PatchConnectionItem: 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 connection. You can add, replace, or remove items from connections. 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: Select the relevant schema to update authentication parameters for your destination. oneOf: - $ref: '#/components/schemas/ConnectionS3DestinationAuthValues' - $ref: '#/components/schemas/ConnectionSFTPWithSSHKeyDestinationAuthValues' - $ref: '#/components/schemas/ConnectionSFTPWithPasswordDestinationAuthValues' Patch_Connection_Response: type: object title: Patch Connection Response description: API response for a successful PATCH operation. properties: id: type: string title: Connection ID description: The connection ID for which the API request was made. etag: type: string title: E-Tag description: An updated etag for the connection ID. ConnectionS3DestinationAuthValues: type: object title: Authentication parameters for Amazon S3 base connections description: > Contains the fields that are required to authorize the connection to an Amazon S3 instance. properties: value: type: object title: Connection Value Object description: > Contains the fields that are required to authorize the connection to an Amazon S3 instance. properties: accessId: type: string title: Access ID description: Specify the Access ID for your S3 Authentication. secretKey: type: string title: S3 Secret Key description: Specify the S3 server secret key for your S3 server authentication. ConnectionSFTPWithSSHKeyDestinationAuthValues: type: object title: Authentication parameters for SFTP With SSH Key base connections description: > Contains the fields that are required to authorize the connection to an SFTP instance, by using SSH key authentication. properties: value: type: object title: Connection Value Object description: > Contains the fields that are required to authorize the connection to an SFTP instance, by using SSH key authentication. properties: domain: type: string title: Domain description: Specify the domain for your SFTP server authentication. username: type: string title: Username description: Specify the username for your SFTP server authentication. sshKey: type: string title: SSH Key description: Specify the SSH Key for your SFTP server authentication. ConnectionSFTPWithPasswordDestinationAuthValues: type: object title: Authentication parameters for SFTP With Password base connections description: > Contains the fields that are required to authorize the connection to an SFTP instance, by using password authentication. properties: value: type: object title: Connection Value Object description: > Contains the fields that are required to authorize the connection to an SFTP instance, by using password authentication. properties: host: type: string title: Host description: Specify the host for your SFTP server authentication. username: type: string title: Username description: Specify the username for your SFTP server authentication. password: type: string title: Password. description: Specify the password for your SFTP server authentication. SourceConnectionItem: type: object title: Source Connection Items description: Parameters specific to source connections. required: - id - createdAt - updatedAt - createdBy - updatedBy - createdClient - updatedClient - sandboxId - imsOrgId - name - connectionSpec - state - typeInfo - version - etag - inheritedAttributes properties: id: type: string title: Connection ID description: The ID of the source connection. createdAt: type: integer title: Connection creation time description: The epoch time in milliseconds when the source connection was created. updatedAt: type: integer title: Connection update time description: The epoch time in milliseconds when the source connection was last updated. createdBy: type: string title: Created User description: The Adobe ID of the Identity Management System (IMS) user who created the source connection. 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 source connection. In the case of service tokens, the value for `createdBy` is the same as `createdClient`. createdClient: type: string title: Created client description: The Adobe Identity Management System (IMS) client who created the source connection. This can be an application or a user. For example, the value `exc_app` represents source connections created in the Experience Platform UI. updatedClient: type: string title: Updated client description: The Adobe Identity Management System (IMS) client who last updated the source connection. This can be an application or a user. For example, the value `exc_app` represents source connections created in the Experience Platform UI. imsOrgId: type: string title: IMS org ID description: The organization ID to which the source connection belongs. sandboxId: type: string title: Sandbox ID description: The ID of the sandbox in which the source connection was created. sandboxName: type: string title: Created client description: The ID of the sandbox in which the source connection was created. name: type: string title: Connection name description: The name of the source connection. 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 source connection. state: type: string title: Connection state description: > Represents the current state of the source connection. A source connection can be `enabled` or `disabled`. enum: [enabled, disabled] connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. 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. For connections to the Experience Platform Profile Store, the connection spec ID is always `8a9c3494-9708-43d7-ae3f-cda01e5030e1`. For connections to the Experience Platform Data Lake, the connection spec ID is always `23598e46-f560-407b-88d5-ea6207e49db0`. 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"] inheritedAttributes: type: object title: Inherited attributes description: Attributes inherited from the base connection used when creating this connection. properties: baseConnection: type: string title: Inherited base connection ID description: ID of the base connection used when creating this source 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. params: type: object title: Params description: Source Connection params. properties: datasets: type: array title: Datasets description: List of datasets. Applicable only to Dataset destinations. items: type: object properties: dataSetId: type: string title: Dataset ID description: ID of the dataset. name: title: Name description: Name of the dataset. type: string AmazonS3Auth: type: object title: Authentication Parameters description: Request model to capture authentication details for Amazon S3 connections. properties: specName: type: string title: Spec Name description: > Supported authentication scheme for connecting to Amazon S3. Currently, only a single type of key based scheme (access key authentication) is supported. enum: [ "Access Key" ] params: type: object description: Required and optional parameters to authorize a connection to an Amazon S3 instance. required: - s3SecretKey - s3AccessKey properties: s3SecretKey: type: string title: Secret Key. description: The secret key that grants access to your Amazon S3 instance. pattern: "^[A-Za-z0-9\\/\\+]{40}$" s3AccessKey: type: string title: Access Key. description: The access key that grants access to your Amazon S3 instance. pattern: "^[A-Z2-7]{20}$" AmazonS3TargetConnectionParams: type: object title: Amazon S3 target connection parameters description: Specific parameters to establish a target connection to an Amazon S3 instance. properties: connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. properties: id: type: string title: Id description: Connection spec ID. For Amazon S3 destinations, use the connection spec ID `4890fc95-5a1f-4983-94bb-e060c08e3f81`. version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. params: type: object description: Specific parameters to establish a target connection to an Amazon S3 instance required: - bucketName - path properties: bucketName: type: string title: Amazon S3 bucket name description: The name of your Amazon S3 bucket, where the data will be exported. pattern: "(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)" path: type: string title: Path description: The path to the folder location in your Amazon S3 storage where the exported files will be deposited. SFTPTargetConnectionParams: type: object title: SFTP target connection parameters description: Specific parameters to establish a target connection to an SFTP instance. properties: connectionSpec: type: object title: Connection Spec. description: Request model for connection spec information. properties: id: type: string title: Id description: Connection spec ID. For SFTP destinations, use the connection spec ID `64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0`. version: type: string title: Version description: Connection spec version. This value is `1.0` unless clearly specified otherwise. params: type: object description: Specific parameters to establish a target connection to an SFTP instance required: - remotePath properties: remotePath: type: string title: Remote Path description: The path in your SFTP location where the data will be exported. examples: Create_Source_Connection_Profile_Store: summary: Establish a connection to the Experience Platform Profile Store value: name: Connecting to Profile Store description: Optional # data: # format: CSV # schema: null connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' # params: null Create_Source_Connection_Data_Lake: summary: Establish a connection to the Experience Platform Data Lake value: name: Connecting to Data Lake description: Data Lake source connection to export datasets connectionSpec: id: 23598e46-f560-407b-88d5-ea6207e49db0 version: "1.0" params: datasets: - dataSetId: "616d53e0a6de2719486fb024" name: "Company Dataset" - dataSetId: "972a43e0n3fe2419923bb037" name: "Employee Dataset" Create_S3_Base_Connection: summary: Authorize the connection to an Amazon S3 instance with access key authentication value: name: Amazon S3 Base Connection auth: specName: Access Key params: s3SecretKey: '' s3AccessKey: '' connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' Create_SFTP_With_Password_Base_Connection: summary: Authorize the connection to an SFTP instance with password authentication value: name: SFTP with Password Base Connection auth: specName: Basic Authentication for sftp params: domain: "{DOMAIN}" host: "{HOST}" username: "{USERNAME}" password: "{PASSWORD}" connectionSpec: id: 36965a81-b1c6-401b-99f8-22508f1e6a26 version: '1.0' Create_SFTP_With_SSH_Key_Base_Connection: summary: Authorize the connection to an SFTP instance with SSH Key authentication value: name: SFTP with SSH Key Base Connection auth: specName: SSH PublicKey Authentication for sftp params: domain: "{DOMAIN}" host: "{HOST}" username: "{USERNAME}" sshKey: "{SSH_KEY}" port: 22 connectionSpec: id: 36965a81-b1c6-401b-99f8-22508f1e6a26 version: '1.0' Create_SFTP_Target_Connection: summary: Specify data format and storage location information to export files to an SFTP instance value: name: SFTP Target Connection baseConnectionId: be3e2d03-6134-4566-9865-c40e0df8b718 params: remotePath: path-to-storage-location connectionSpec: id: 64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0 version: '1.0' Create_S3_Target_Connection_Dataset: summary: Datasets - Specify data format and storage location information to export files to an Amazon S3 instance value: name: Amazon S3 Beta Target Connection baseConnectionId: be3e2d03-6134-4566-9865-c40e0df8b718 params: mode: Server-to-server bucketName: your-bucket-name path: folder/subfolder compression: GZIP datasetFileType: JSON connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: "1.0" Create_S3_Target_Connection_Segment: summary: Specify advanced data format and storage location information to export profile files to an Amazon S3 instance value: name: Amazon S3 Beta Target Connection baseConnectionId: be3e2d03-6134-4566-9865-c40e0df8b718 params: mode: Server-to-server bucketName: your-bucket-name path: folder/subfolder compression: GZIP fileType: CSV csvOptions: nullValue: "null" emptyValue: "" escape: "\\" quote: "" delimiter: "," connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: "1.0" Create_Base_Connection_Response: summary: Base Connection Response value: id: 77eeb629-f08a-48e2-8c7b-e345e246ff45 etag: '"ac00c7db-0000-0200-0000-62eabd5c0000"' Create_Source_Connection_Response: summary: Source Connection Response value: id: 77eeb629-f08a-48e2-8c7b-e345e246ff45 etag: '"ac00c7db-0000-0200-0000-62eabd5c0000"' 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 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 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 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_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 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_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: 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 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: 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 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: 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_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: 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: 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 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: [] 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: [] 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: [] 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_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 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_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_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 Patch_Dataset_Schedule_Params: summary: Update dataset dataflow export schedule value: - op: replace path: /scheduleParams value: interval: 3 timeUnit: hour startTime: 1668470400 endTime: 1668479500 Patch_Profile_Mapping: summary: (Beta) Patch a profile mapping set value: - op: add path: /transformations/0/params/profileMapping value: mappingId: 7acb0b72008d4ca1982970041834d40e mappingVersion: 0 Patch_Primary_Fields: summary: (Beta) Patch a primary field value: - op: add path: /transformations/0/params/primaryFields value: - identityNamespace: GAID fieldType: IDENTITY Patch_Mandatory_Fields: summary: (Beta) Patch a mandatory field value: - op: add path: /transformations/0/params/mandatoryFields value: - GAID Patch_Source_Connection: summary: Update Source Connection of dataflow value: - op: replace path: /sourceConnectionIds value: - 436da0bf-d0c6-4767-8649-e8cdd21c28b7 Create_Flow_Response: summary: Create Flow Response value: id: ca5c6e9a-8559-4a08-97a5-f15b756da600 etag: '"04000e7f-0000-0200-0000-62d9bca40000"' Patch_Flow_Response: summary: Patch Flow Response value: id: ca5c6e9a-8559-4a08-97a5-f15b756da600 etag: '"04000e7f-0000-0200-0000-62d9bca40000"' Batch_Flow_Run_Success: summary: Batch Dataflow Run Success Example. value: items: - id: e80e24c1-82de-48de-8352-b2d0fca1c392 createdAt: 1659018528378 updatedAt: 1659019046995 createdBy: example_id@AdobeID updatedBy: example_id@AdobeID createdClient: exampleClient updatedClient: example_client sandboxId: d9df072c-2d5c-4247-9f07-2c2d5cd247b6 sandboxName: prod imsOrgId: F0935E09512D2C270A490D4D@AdobeOrg flowId: df8d079d-11eb-466a-9731-6b5948a009e4 flowSpec: id: 71471eba-b620-49e4-90fd-23f1fa0174d8 version: '1.0' providerRefId: fd3319ed56fdf9417d63d364a07b0105 etag: '"b500a099-0000-0200-0000-62e29f270000"' metrics: durationSummary: startedAtUTC: 1659018529865 completedAtUTC: 1659018929923 sizeSummary: inputBytes: 855202780 outputBytes: 855202780 recordSummary: inputRecordCount: 7823447 createdRecordCount: 7808223 outputRecordCount: 7808223 skippedRecordCount: 15224 sourceSummaries: - id: 1d6b7dc0-6d54-464e-abb3-54fb9701cb29 inputRecordCount: 7823447 skippedRecordCount: 15224 entitySummaries: - id: segment:b1cbaff7-e7c6-417e-ab54-71d302595785 inputRecordCount: 7823447 skippedRecordCount: 15224 targetSummaries: - id: f876fe0d-4f6d-42e4-954c-bee1baa323eb createdRecordCount: 7808223 outputRecordCount: 7808223 entitySummaries: - id: segment:b1cbaff7-e7c6-417e-ab54-71d302595785 createdRecordCount: 7808223 outputRecordCount: 7808223 skippedInfo: - code: ACTIVATION_BATCH-0000-SKIP message: Records didn't match attribute filter. count: 15224 fileSummary: inputFileCount: 2 outputFileCount: 2 statusSummary: status: success activityRefs: - c4f238e3-7334-4933-8b56-64d7ea43ea54 activities: - id: c4f238e3-7334-4933-8b56-64d7ea43ea54 name: Activation Batch XdmProcessor Activity updatedAtUTC: 0 durationSummary: startedAtUTC: 1659018529865 completedAtUTC: 1659018760787 latencySummary: {} sizeSummary: inputBytes: 855202780 outputBytes: 855202780 recordSummary: inputRecordCount: 7823447 createdRecordCount: 7808223 outputRecordCount: 7808223 skippedRecordCount: 15224 skippedInfo: - code: ACTIVATION_BATCH-0000-SKIP message: Records didn't match attribute filter. count: 15224 fileSummary: inputFileCount: 2 outputFileCount: 2 statusSummary: status: success extensions: incremental.batchId: 01G91S0ZGJ35TG4BQSAEA5VV5A,01G91R672VMKQWQS72BJ6PQJ3H snapshot.batchId: 01G91QNJWFWD2588D4G4GZP9G1 snapshot.datasetId: 605dbe4e89b61819495e4dff incremental.datasetId: 60ca216861dfad1948ecac24 - id: 51d82b36-6b8f-11eb-9439-0242ac130002 name: Activation Batch Publisher Activity updatedAtUTC: 0 durationSummary: startedAtUTC: 1659018767812 completedAtUTC: 1659018929923 latencySummary: {} sizeSummary: outputBytes: 855202780 recordSummary: inputRecordCount: 7808223 createdRecordCount: 7808223 outputRecordCount: 7808223 skippedRecordCount: 0 fileSummary: outputFileCount: 2 statusSummary: status: success extensions: {} Batch_Flow_Run_Failure: summary: Batch Dataflow Run Failed Example. value: items: - id: 850a3a02-ba0d-452a-aeb3-e9fcc8361342 createdAt: 1654785125699 updatedAt: 1654791389756 createdBy: exampleOrg@AdobeID updatedBy: example_org@AdobeID createdClient: example client updatedClient: example_client sandboxId: d9df072c-2d5c-4247-9f07-2c2d5cd247b6 sandboxName: prod imsOrgId: F0935E09512D2C270A490D4D@AdobeOrg flowId: df8d079d-11eb-466a-9731-6b5948a009e4 flowSpec: id: 71471eba-b620-49e4-90fd-23f1fa0174d8 version: '1.0' providerRefId: 65f8c71e5b58a54be7b97f93e11a8a8f etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' metrics: durationSummary: startedAtUTC: 1654785127582 completedAtUTC: 1654791033373 recordSummary: sourceSummaries: - id: 1d6b7dc0-6d54-464e-abb3-54fb9701cb29 inputRecordCount: 0 skippedRecordCount: 0 entitySummaries: - id: segment:cfa5dadb-fd73-4bab-a470-f88323c55ec7 inputRecordCount: 0 skippedRecordCount: 0 failedInfo: - code: ACTIVATION_BATCH-0000-FAILED message: Job aborted. statusSummary: status: failed errors: - code: ACTIVATION_BATCH-0000-FAILED message: Job aborted. activityRefs: - c4f238e3-7334-4933-8b56-64d7ea43ea54 activities: - id: c4f238e3-7334-4933-8b56-64d7ea43ea54 name: Activation Batch XdmProcessor Activity updatedAtUTC: 0 durationSummary: startedAtUTC: 1654785127582 completedAtUTC: 1654791033373 latencySummary: {} sizeSummary: {} recordSummary: failedInfo: - code: ACTIVATION_BATCH-0000-FAILED message: Job aborted. fileSummary: {} statusSummary: status: failed errors: - code: ACTIVATION_BATCH-0000-FAILED message: Job aborted. extensions: {} SourceConnectionsResponse: summary: Source connections response example value: items: - id: 23f73356-d5aa-49f4-b810-c69f12fb3edd createdAt: 1659993961499 updatedAt: 1659993961695 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: Sample source connection Profile Store connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: "ProfileFragments" id: "ups" state: enabled version: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' inheritedAttributes: baseConnection: id: be3e2d03-6134-4566-9865-c40e0df8b718 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' - id: 12333356-d5aa-49f4-b810-c69f12fb3edd createdAt: 1659993961493 updatedAt: 1659993961699 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: Another sample source connection to the Profile Store connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: "ProfileFragments" id: "ups" state: enabled version: '"0e0d95ae-0000-0200-0000-62a55cdd0000"' etag: '"0e0d95ae-0000-0200-0000-62a55cdd0000"' inheritedAttributes: baseConnection: id: be3e2d03-6134-4566-9865-c40e0df8b718 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' - id: dfe93ffd-4f87-49f4-b900-f57cd0dbab1a createdAt: 1659993961499 updatedAt: 1659993961695 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: "{SANDBOX_ID}" sandboxName: "{SANDBOX_NAME}" imsOrgId: destinationapi@AdobeOrg name: Data Lake Source Connection description: Data Lake Source Connection baseConnectionId: 3c7dc58e-a1ee-4e29-b3b2-a7757fb82044 state: enabled connectionSpec: id: 23598e46-f560-407b-88d5-ea6207e49db0 version: '1.0' params: datasets: - dataSetId: 616d53e0a6de2719486fb024 name: Company Dataset - dataSetId: 972a43e0n3fe2419923bb037 name: Employee Dataset version: '"24014573-0000-0200-0000-6372c91f0000"' etag: '"24014573-0000-0200-0000-6372c91f0000"' inheritedAttributes: baseConnection: id: 3c7dc58e-a1ee-4e29-b3b2-a7757fb82044 connectionSpec: id: 23598e46-f560-407b-88d5-ea6207e49db0 version: '1.0' SourceConnectionsResponseUPS: summary: Source connection to UPS response example value: items: - id: 097e3d72-921b-47f5-9e99-a4487cdbd1bd createdAt: 1660155681202 updatedAt: 1660155681587 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: Sample source connection to the Profile Store connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' typeInfo: type: "ProfileFragments" id: "ups" state: enabled version: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' inheritedAttributes: baseConnection: id: be3e2d03-6134-4566-9865-c40e0df8b718 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' SourceConnectionsResponseDataLake_V2: summary: (Beta) Source connection to Data Lake response example value: items: - id: dfe93ffd-4f87-49f4-b900-f57cd0dbab1a createdAt: 1659993961499 updatedAt: 1659993961695 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: "{SANDBOX_ID}" sandboxName: "{SANDBOX_NAME}" imsOrgId: destinationapi@AdobeOrg name: Data Lake Source Connection description: Data Lake Source Connection baseConnectionId: 3c7dc58e-a1ee-4e29-b3b2-a7757fb82044 state: enabled connectionSpec: id: 23598e46-f560-407b-88d5-ea6207e49db0 version: '1.0' params: datasets: - dataSetId: 616d53e0a6de2719486fb024 name: Company Dataset - dataSetId: 972a43e0n3fe2419923bb037 name: Employee Dataset version: '"24014573-0000-0200-0000-6372c91f0000"' etag: '"24014573-0000-0200-0000-6372c91f0000"' inheritedAttributes: baseConnection: id: 3c7dc58e-a1ee-4e29-b3b2-a7757fb82044 connectionSpec: id: 23598e46-f560-407b-88d5-ea6207e49db0 version: '1.0' ConnectionsResponse: summary: Connections response example. value: items: - id: 9d8159c6-9da6-4205-8507-d818d7ad7103 createdAt: 1654785125699 updatedAt: 1654791389756 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: amazon-s3 connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' auth: specName: Access Key params: authorizedDate: "2022-08-03" s3SecretKey: '{SECRET_KEY}' s3AccessKey: '{ACCESS_KEY}' state: enabled version: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' - id: e6f3a300-0bf7-4755-b7f8-308dc2a99133 createdAt: 1654785125699 updatedAt: 1654791389756 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: amazon-s3 connectionSpec: id: 64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0 version: '1.0' state: enabled auth: specName: Basic Authentication for sftp params: authorizedDate: "2022-08-03" password: 'testPassword' userName: 'testUser' host: 'ftp.test.com' version: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' - id: 340d288f-c020-435d-a41f-094520fa83eb createdAt: 1634785125699 updatedAt: 1644791389756 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: (Beta) Amazon S3 Connection connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' auth: specName: Access Key params: authorizedDate: "2022-11-03" s3SecretKey: '{SECRET_KEY}' s3AccessKey: '{ACCESS_KEY}' state: enabled version: '"26013a41-0000-0200-0000-6361687a0000"' etag: '"26013a41-0000-0200-0000-6361687a0000"' - id: 63e0b47b-94bd-4b20-a395-81ff6b496335 createdAt: 1674785125699 updatedAt: 1684791389756 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: (Beta) SFTP Connection connectionSpec: id: 36965a81-b1c6-401b-99f8-22508f1e6a26 version: '1.0' state: enabled auth: specName: SFTP with Password params: authorizedDate: "2022-08-03" username: 'testUser' password: 'testPassword' domain: 'ftp.test.com' version: '"56fda0d4-3858-4657-b679-adf65b9ddf9b"' etag: '"56fda0d4-3858-4657-b679-adf65b9ddf9b"' TargetConnectionsResponse: summary: Target Connections response example value: items: - id: 94c6fb2e-9431-42fd-aeee-c83e67c43578 createdAt: 1660922583694 updatedAt: 1660922584231 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: SFTP Target Connection baseConnectionId: be3e2d03-6134-4566-9865-c40e0df8b718 state: enabled connectionSpec: id: 64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0 version: '1.0' params: remotePath: path-to-storage-location format: CSV version: '"29020953-0000-0200-0000-62ffaad80000"' etag: '"29020953-0000-0200-0000-62ffaad80000"' inheritedAttributes: baseConnection: id: be3e2d03-6134-4566-9865-c40e0df8b718 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' - id: 49c15916-2d2e-4d79-86d0-ccbcc38e7de8 createdAt: 1660921033371 updatedAt: 1660921033676 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: Amazon S3 Target Connection baseConnectionId: be3e2d03-6134-4566-9865-c40e0df8b718 state: enabled connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' params: bucketName: your-bucket-name path: folder/subfolder version: '"2702bb8b-0000-0200-0000-62ffa4c90000"' etag: '"2702bb8b-0000-0200-0000-62ffa4c90000"' inheritedAttributes: baseConnection: id: be3e2d03-6134-4566-9865-c40e0df8b718 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' - id: e8ebfb80-5387-454d-812d-34202541f17f createdAt: 1660922583694 updatedAt: 1660922584231 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: "{SANDBOX_ID}" sandboxName: "{SANDBOX_NAME}" imsOrgId: destinationapi@AdobeOrg name: "(Beta) Amazon S3 Segment Target Connection" baseConnectionId: e95b83b3-ddf7-4b7d-9e21-e02e75d85036 state: enabled connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' params: mode: Server-to-server csvOptions: nullValue: 'null' emptyValue: '' escape: "\\" quote: '' delimiter: "," compression: NONE fileType: CSV path: dataexports bucketName: dataexportsbucket version: '"20087c1d-0000-0200-0000-6374086d0000"' etag: '"20087c1d-0000-0200-0000-6374086d0000"' inheritedAttributes: baseConnection: id: e95b83b3-ddf7-4b7d-9e21-e02e75d85036 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' - id: 7f7c4442-4a06-48e2-96d7-eefcda766762 createdAt: 1660922583694 updatedAt: 1660922584231 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: "{SANDBOX_ID}" sandboxName: "{SANDBOX_NAME}" imsOrgId: destinationapi@AdobeOrg name: "(Beta) Amazon S3 Dataset Target Connection" baseConnectionId: 7d354d3a-fd93-48c8-821e-c7c2d7e929da state: enabled connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' params: mode: Server-to-server compression: GZIP datasetFileType: JSON path: dataexports bucketName: dataexportsbucket version: '"5501abd7-4394-4930-b549-6aafbfd1aa77"' etag: '"5501abd7-4394-4930-b549-6aafbfd1aa77"' inheritedAttributes: baseConnection: id: 7d354d3a-fd93-48c8-821e-c7c2d7e929da connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' Amazon_S3_Connection: summary: Amazon S3 connection Example. value: items: - id: 9d8159c6-9da6-4205-8507-d818d7ad7103 createdAt: 1654785125699 updatedAt: 1654791389756 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: amazon-s3 connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' auth: specName: Access Key params: authorizedDate: "2022-08-03" s3SecretKey: '{SECRET_KEY}' s3AccessKey: '{ACCESS_KEY}' state: enabled version: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' SFTP_Connection: summary: SFTP connection Example. value: items: - id: e6f3a300-0bf7-4755-b7f8-308dc2a99133 createdAt: 1654785125699 updatedAt: 1654791389756 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: amazon-s3 connectionSpec: id: 64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0 version: '1.0' state: enabled auth: specName: Basic Authentication for sftp params: authorizedDate: "2022-08-03" password: 'testPassword' userName: 'testUser' host: 'ftp.test.com' version: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"' Amazon_S3_Connection_V2: summary: (Beta) Amazon S3 connection Example. value: items: - id: 340d288f-c020-435d-a41f-094520fa83eb createdAt: 1654785125699 updatedAt: 1654791389756 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: (Beta) Amazon S3 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' auth: specName: Access Key params: authorizedDate: "2022-11-03" s3SecretKey: '{SECRET_KEY}' s3AccessKey: '{ACCESS_KEY}' state: enabled version: '"26013a41-0000-0200-0000-6361687a0000"' etag: '"26013a41-0000-0200-0000-6361687a0000"' SFTP_Connection_V2: summary: (Beta) SFTP connection Example. value: items: - id: 63e0b47b-94bd-4b20-a395-81ff6b496335 createdAt: 1654785125699 updatedAt: 1654791389756 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: (Beta) SFTP Connection connectionSpec: id: 36965a81-b1c6-401b-99f8-22508f1e6a26 version: '1.0' state: enabled auth: specName: SFTP with Password params: authorizedDate: "2022-08-03" username: 'testUser' password: 'testPassword' domain: 'ftp.test.com' version: '"56fda0d4-3858-4657-b679-adf65b9ddf9b"' etag: '"56fda0d4-3858-4657-b679-adf65b9ddf9b"' Amazon_S3_Target_Connection: summary: Amazon S3 target connection example value: items: - id: 05672d6b-3cf5-47cd-9d8b-cff0ca9541c3 createdAt: 1660921644496 updatedAt: 1660921644729 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: Amazon S3 Target Connection++ baseConnectionId: be3e2d03-6134-4566-9865-c40e0df8b718 state: enabled connectionSpec: id: 4890fc95-5a1f-4983-94bb-e060c08e3f81 version: '1.0' params: bucketName: your-bucket-name path: folder/subfolder version: '"28029f1b-0000-0200-0000-62ffa72c0000"' etag: '"28029f1b-0000-0200-0000-62ffa72c0000"' inheritedAttributes: baseConnection: id: be3e2d03-6134-4566-9865-c40e0df8b718 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' SFTP_Target_Connection: summary: SFTP target connection example value: items: - id: 94c6fb2e-9431-42fd-aeee-c83e67c43578 createdAt: 1660922583694 updatedAt: 1660922584231 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: '{SANDBOX_ID}' sandboxName: '{SANDBOX_NAME}' imsOrgId: destinationapi@AdobeOrg name: SFTP Target Connection baseConnectionId: be3e2d03-6134-4566-9865-c40e0df8b718 state: enabled connectionSpec: id: 64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0 version: '1.0' params: remotePath: path-to-storage-location format: CSV version: '"29020953-0000-0200-0000-62ffaad80000"' etag: '"29020953-0000-0200-0000-62ffaad80000"' inheritedAttributes: baseConnection: id: be3e2d03-6134-4566-9865-c40e0df8b718 connectionSpec: id: 8a9c3494-9708-43d7-ae3f-cda01e5030e1 version: '1.0' Amazon_S3_Target_Connection_Segment_V2: summary: '(Beta) Amazon S3 Segment Target Connection' value: items: - id: e8ebfb80-5387-454d-812d-34202541f17f createdAt: 1660922583694 updatedAt: 1660922584231 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: "{SANDBOX_ID}" sandboxName: "{SANDBOX_NAME}" imsOrgId: destinationapi@AdobeOrg name: "(Beta) Amazon S3 Segment Target Connection" baseConnectionId: e95b83b3-ddf7-4b7d-9e21-e02e75d85036 state: enabled connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' params: mode: Server-to-server csvOptions: nullValue: 'null' emptyValue: '' escape: "\\" quote: '' delimiter: "," compression: NONE fileType: CSV path: dataexports bucketName: dataexportsbucket version: '"20087c1d-0000-0200-0000-6374086d0000"' etag: '"20087c1d-0000-0200-0000-6374086d0000"' inheritedAttributes: baseConnection: id: e95b83b3-ddf7-4b7d-9e21-e02e75d85036 connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' Amazon_S3_Target_Connection_Dataset_V2: summary: '(Beta) Amazon S3 Dataset Target Connection' value: items: - id: 7f7c4442-4a06-48e2-96d7-eefcda766762 createdAt: 1660922583694 updatedAt: 1660922584231 createdBy: example@AdobeID updatedBy: example@AdobeID createdClient: example_client updatedClient: example_updated client sandboxId: "{SANDBOX_ID}" sandboxName: "{SANDBOX_NAME}" imsOrgId: destinationapi@AdobeOrg name: "(Beta) Amazon S3 Dataset Target Connection" baseConnectionId: 7d354d3a-fd93-48c8-821e-c7c2d7e929da state: enabled connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' params: mode: Server-to-server compression: GZIP datasetFileType: JSON path: dataexports bucketName: dataexportsbucket version: '"5501abd7-4394-4930-b549-6aafbfd1aa77"' etag: '"5501abd7-4394-4930-b549-6aafbfd1aa77"' inheritedAttributes: baseConnection: id: 7d354d3a-fd93-48c8-821e-c7c2d7e929da connectionSpec: id: 4fce964d-3f37-408f-9778-e597338a21ee version: '1.0' Patch_Connection_Remove_Auth_Params: summary: Remove Auth params to your connection value: - op: remove path: /auth/params value: accessId: exampleAccessId secretKey: exampleSecretKey Patch_Connection_Add_S3_Auth_Params: summary: Add authentication parameters to your Amazon S3 connection. Once you add new params, this will override all prior auth params. value: - op: add path: /auth/params value: accessId: exampleAccessId secretKey: exampleSecretKey Patch_Connection_Replace_Auth_Params: summary: Add authentication parameters to your Amazon S3 connection. Once you add new params, this will override all prior auth params. value: - op: replace path: /auth/params value: accessId: replaceAccessId secretKey: replaceSecretKey Destination_Dataset_Response: summary: Dataset List Response value: items: - id: 635865d23b3f261ba5a8589b schemaRef: id: https://ns.adobe.com/activationcontrolplaneint/schemas/36fcb097f2f3f000a0cb7ab355e3f9c2a2aa922fb28a6795 contentType: application/vnd.adobe.xed-full+json;version=1 name: City Dataset description: A dataset of cities around the world tags: unifiedIdentity: - enabled:true fileDescription: persisted: false containerFormat: format: parquet aspect: production imsOrg: 5555467B5D8013E50A494220@AdobeOrg sandboxId: 02dd69f0-da73-11e9-9ea1-af59ce7c24e8 version: 1.0.7 created: 1666737618845 updated: 1666737967289 createdClient: exc_app createdUser: 433E0A015D7AB86C0A49402B@AdobeID updatedUser: acp_foundation_dataTracker@AdobeID viewId: 635865d23b3f261ba5a8589c basePath: abfss://gen1@datalakep1234356gn.dfs.core.windows.net/platform/635865d23b3f261ba5a8589b/datasetViewId=635865d23b3f261ba5a8589c files: "@/dataSetFiles?dataSetId=635865d23b3f261ba5a8589b" enableErrorDiagnostics: false lastBatchStatus: success lastBatchId: 01GG8N3TRVHC2Z7CQAY4YJ7Q2F lastSuccessfulBatch: 01GG8N3TRVHC2Z7CQAY4YJ7Q2F parameters: 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 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 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 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 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 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 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 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 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 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 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 # securitySchemes: # bearerAuth: # arbitrary name for the security scheme # type: http # scheme: bearer # bearerFormat: JWT # optional, arbitrary value for documentation purposes # Apply the security globally to all operations # security: # - bearerAuth: [] # use the same name as above