Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Platform APIs.

Flow Service API - Sources (1.0)

Download OpenAPI specification:Download

Adobe Experience Platform allows data to be ingested from external sources while providing you with the ability to structure, label, and enhance incoming data using Platform services. You can ingest data from a variety of sources such as Adobe applications, cloud-based storages, databases, and many others. The service provides a RESTful API from which all supported sources are connectable.

NOTE: Refer to Flow Service API - Destinations if you are looking for API documentation to perform operations on destinations in Experience Platform.

Related documentation:
- Sources documentation
Visualize API calls with Postman (a free, third-party software):
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/connections
Required headers:
- All 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.
- 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 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, API status codes, and request header errors. You can also view a list of common Flow Service error messages 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.

(NEW) Interactive API documentation

You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your authentication credentials 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.

Connections

Base connections retain information between your source and Adobe Experience Platform. They include metadata, a partial view of the credentials used to authenticate a given source, and the unique base connection ID that corresponds to the queried connection. The base connection ID is required to create a source connection. The base connection ID represents your authenticated connection and allows you to explore and inspect the type, structure, and contents of the data that you want to bring to Experience Platform. An instance of a base connection is specific to an organization.

List connections

Retrieve a list of base connections in your organization by making a GET request to the /connections endpoint.

Request

query Parameters

property	Array of strings A comma-separated list of top-level object properties to be returned in the response. This parameter is used to filter the response data based on the properties provided. For example, `property=lastRunDetails.startedAtUTC>=1670880253121` returns only the flows whos last run iterations were started during or after the specified epoch time in milliseconds. This parameter is also used to cut down the amount of data returned in the response body. For example, `property=state==enabled&orderby=createdAt` returns only base connections that have a status of `enabled` in the order of their creation, in ascending order.
limit	integer Restrict the maximum number of items returned for a given request. For example, adding a parameter of `limit=10` in a request to retrieve all base connections returns only a maximum of 10 base connections. When used to query the API, the returned response automatically includes a `continuationToken` that can be used to fetch records that were not returned due to the limits applied by the parameter.
orderby	string Sort the listed resources by specified fields. For example, `orderby=name` sorts results by name in ascending order (A-Z). Adding a dash (`-`) before the field name (`orderby=-name`) sorts the results in descending order (Z-A).
continuationToken	string An auto-generated string token that is appended to a returned response when there are more results to be read beyond the maximum count of items that can be returned.
count	boolean Default: false A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`)

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.

Responses

200

Success

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/connections

Response samples

application/json

{"items": [{"id": "69f188b6-af07-4587-8061-e94d34637b41",
"createdAt": 1668637963851,
"updatedAt": 1668637963851,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google BigQuery Base Connection",
"description": "A Google BigQuery base connection for sales data",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"state": "enabled",
"auth": {"specName": "Basic Authentication for google-cloud",
"params": {"accessKeyId": "GOOGMG1234ABCDEFGHIJKLMN",
"secretAccessKey": "xxxx"
}
},
"version": "\"6802064a-0000-0200-0000-6387c6b90000\"",
"etag": "\"6802064a-0000-0200-0000-6387c6b90000\""
}
]
}

Create a new connection

Create a new base connection by making a POST request to the /connections endpoint while providing a name for your base connection, your source's corresponding authentication parameters, and your source's unique connection specification ID.

Request

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
required

name - (Required) The name of your base connection. Ensure that the name of your base connection is descriptive as you can use this to look up information on your base connection.
description - An optional value that you can include to provide more information on your base connection.
auth - (Required) Contains information necessary to authenticate a base connection.
- specName - (Required) Specifies the name of the the type of authentication to be used with the base connection.
- params - (Required) Contains credentials and values necessary to authenticate and create a connection.
connectionSpec - (Required) Contains information regarding the source's connection specification ID.
- id - (Required) The specific connection specification ID associated with source.
- version - Specifies the version of the connection specification ID. Omitting this value will default to the most recent version

name	string The name of the base connection.
description	string An optional description that can be added to provide further context on the connection.
	object (AuthInfoDTO)
required	object (SpecInfoDTO)

Responses

201

Success - Connection Created

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

post/connections

Request samples

Payload

application/json

{"name": "Google Cloud Storage Base Connection",
"description": "Google Cloud Storage base connection for customer data",
"auth": {"specName": "Basic Authentication for google-cloud",
"params": {"accessKeyId": "GOOGMG1234ABCDEFGHIJKLMN",
"secretAccessKey": "xxxx"
}
},
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
}
}

Response samples

application/json

{"id": "69f188b6-af07-4587-8061-e94d34637b41",
"etag": "\"6802064a-0000-0200-0000-6387c6b90000\""
}

Retrieve a base connection

Use this endpoint to retrieve a single base connection.

Request

path Parameters

BASE_CONNECTION_ID

required

string

The ID of the base connection you want to retrieve.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Success

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/connections/{BASE_CONNECTION_ID}

Response samples

application/json

{"items": [{"id": "69f188b6-af07-4587-8061-e94d34637b41",
"createdAt": 1668637963851,
"updatedAt": 1668637963851,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google BigQuery Base Connection",
"description": "A Google BigQuery base connection for sales data",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"state": "enabled",
"auth": {"specName": "Basic Authentication for google-cloud",
"params": {"accessKeyId": "GOOGMG1234ABCDEFGHIJKLMN",
"secretAccessKey": "xxxx"
}
},
"version": "\"6802064a-0000-0200-0000-6387c6b90000\"",
"etag": "\"6802064a-0000-0200-0000-6387c6b90000\""
}
]
}

Test a base connection's connectivity

Use this endpoint to test the connectivity of an existing base connection.

Request

path Parameters

BASE_CONNECTION_ID

required

string

The ID of the base connection you want to test.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Connection Validity Checked

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/connections/{BASE_CONNECTION_ID}/test

Response samples

application/json

{"result": true
}

Explore a connection's contents

Use this endpoint to explore the data structure and contents of a base connection.

Request

path Parameters

BASE_CONNECTION_ID

required

string

The ID of the connection you want to explore.

query Parameters

objectType	string object Type Enum: "ROOT" "TABLE" "FILE" "FOLDER" "REST"
object	string Path or TableName
FileType	string object Type Enum: "Delimited" "JSON"
CompressionType	string The compression type used to compress the file.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

File Structure Retrieved

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/connections/{BASE_CONNECTION_ID}/explore

Response samples

application/json

[{"type": "folder",
"name": "acme-customers",
"path": "/acme-customers/",
"canPreview": false,
"canFetchSchema": false
}
]

Perform a state transition action on an existing connection.

Use this endpoint to update the state of an existing connection.

Request

path Parameters

BASE_CONNECTION_ID

required

string

The ID of the base connection.

query Parameters

op required	string The operation action to be performed against the base connection. Enum: "FINALIZE_UPDATE" "FINALIZE" "PUBLISH"
subOp required	Array of strings The sub-operation action to be performed against the base connection. Items Enum: "APPLY" "ROLLBACK" "PROGRESS"

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
optional

percentCompleted	number <double>
	object (StatusDTO)
	Array of objects (FlowRecordTypeDTO)

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

post/connections/{BASE_CONNECTION_ID}/action

Request samples

Payload

application/json

{"percentCompleted": 0,
"status": {"value": "IN_PROGRESS",
"properties": { },
"errors": [{"message": "string",
"code": "string",
"details": { }
}
]
},
"recordTypes": [{"type": "string",
"extensions": { }
}
]
}

Response samples

application/json

{"id": "69f188b6-af07-4587-8061-e94d34637b41",
"etag": "\"6802064a-0000-0200-0000-6387c6b90000\""
}

Delete an existing connection

Use this endpoint to delete a single base connection.

Request

path Parameters

BASE_CONNECTION_ID

required

string

The ID of the connection you want to delete.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

204

Connection Deleted

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

delete/connections/{BASE_CONNECTION_ID}/

Update an existing connection

Use this endpoint to update details of an existing base connection.

Request

path Parameters

BASE_CONNECTION_ID

required

string

The {BASE_CONNECTION_ID} you want to update.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.
if-match required	string A parameter required when updating a connection or a dataflow. When making a PUT or PATCH request, you must add an `if-match` header parameter and include the current version/etag of the resource that you want to update to complete the update.

Request Body schema: application/json
required

op - (Required) The operation call used to define the action needed to update the connection. Operations include add, replace, and remove. path - (Required) The path of the parameter to be updated. value - (Required) The new value you want to update your parameter with.

op required	string Enum: "ADD" "REPLACE" "REMOVE"
path required	string
required	object

Responses

200

Connection Updated

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

patch/connections/{BASE_CONNECTION_ID}/

Request samples

Payload

application/json

{"op": "ADD",
"path": "/auth/params",
"value": {"description": "A new description to provide further context on a specified connection or flow."
}
}

Response samples

application/json

{"id": "69f188b6-af07-4587-8061-e94d34637b41",
"etag": "\"6802064a-0000-0200-0000-6387c6b90000\""
}

Retrieve configs for the properties of a given connection.

Use this endpoint to retrieve the configs of a given connection.

Request

path Parameters

BASE_CONNECTION_ID

required

string

The ID of the base connection to query.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Success

400

The request is invalid.

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

get/connections/{BASE_CONNECTION_ID}/configs

Response samples

application/json

{"items": [{"columnName": "name",
"columnType": "string"
},
{"columnName": "address",
"columnType": "string"
},
{"columnName": "dob",
"columnType": "date"
},
{"columnName": "phone",
"columnType": "string"
}
]
}

Retrieve a list of connections based on a given filtering criteria.

Use this endpoint to retrieve a list of connections given a particular filtering criteria.

Request

query Parameters

continuationToken

string

An auto-generated string token that is appended to a returned response when there are more results to be read beyond the maximum count of items that can be returned.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
required

The filtering parameters to be applied to the query.

queryString	string
limit	integer <int32> <= 1000
orderby	string
count	boolean

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

post/connections/search

Request samples

Payload

application/json

{"queryString": "string",
"limit": 1000,
"orderby": "string",
"count": true
}

Response samples

application/json

{"items": [{"id": "69f188b6-af07-4587-8061-e94d34637b41",
"createdAt": 1668637963851,
"updatedAt": 1668637963851,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google BigQuery Base Connection",
"description": "A Google BigQuery base connection for sales data",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"state": "enabled",
"auth": {"specName": "Basic Authentication for google-cloud",
"params": {"accessKeyId": "GOOGMG1234ABCDEFGHIJKLMN",
"secretAccessKey": "xxxx"
}
},
"version": "\"6802064a-0000-0200-0000-6387c6b90000\"",
"etag": "\"6802064a-0000-0200-0000-6387c6b90000\""
}
]
}

Connection specs

Connection specifications retain the connector properties of a given source. A connection spec can be divided into three distinct sections, authentication specifications (authSpec), source specifications (sourceSpec), and explore specifications (exploreSpec). The authSpec defines the authentication type(s) that you can use to connect your source to Experience Platform. The sourceSpec consists of source connection parameters that a given source requires from a user. For example, the sourceSpec of a cloud storage source can require a user to provide values for path or recursive parameter. The sourceSpec also includes properties that are used when the source is displayed in the Platform UI catalog. The exploreSpec defines the structure of returned data when a source is queried against. Connection specs include a connection spec ID. This ID is fixed and each source on Experience Platform has its own fixed connection spec ID. This ID is required to create a base connection and a source connection. Connection specs are organization agnostic.

List connection specs

Use this endpoint to list all connection specs in your organization.

Request

query Parameters

property

Array of strings

A comma-separated list of top-level object properties to be returned in the response. This parameter is used to filter the response data based on the properties provided. For example, property=lastRunDetails.startedAtUTC>=1670880253121 returns only the flows whos last run iterations were started during or after the specified epoch time in milliseconds. This parameter is also used to cut down the amount of data returned in the response body. For example, property=state==enabled&orderby=createdAt returns only base connections that have a status of enabled in the order of their creation, in ascending order.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Connection Specifications Listed

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/connectionSpecs

Response samples

application/json

{"items": [{"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"name": "Google Cloud Storage",
"providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"version": "1.0",
"authSpec": [{"name": "Basic Authentication for google-cloud",
"type": "KeyBased",
"spec": {"accessKeyId": "GOOGMG1234ABCDEFGHIJKLMN",
"secretAccessKey": "xxxx"
}
}
],
"sourceSpec": {"name": "CloudStorage",
"type": "CloudStorage",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines params required when this connection is used as a source in flow.",
"path": {"type": "string",
"description": "The input path for copying files. This can be a folder path, a file path or a wildcard pattern."
},
"recursive": {"type": "boolean",
"default": "false",
"description": "The recursive property indicates recursive copy in case of folder or wild card path. The default value is false."
}
},
"attributes": {"uiAttributes": {"isSource": true,
"documentationLink": "http://www.adobe.com/go/sources-google-cloud-storage-en",
"category": "cloudStorage",
"icon": "google",
"description": "Create a live inbound connection to your Google Cloud Storage account to periodically ingest delimited data file into Experience Platform.",
"label": "Google Cloud Storage"
}
}
},
"exploreSpec": {"name": "FileSystem",
"type": "FileSystem",
"requestSpec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"responseSpec": {"root": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": { },
"name": { },
"path": { },
"canPreview": { },
"canFetchSchema": { }
}
}
},
"folder": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": { },
"name": { },
"path": { },
"canPreview": { },
"canFetchSchema": { }
}
}
},
"file": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": { },
"name": { },
"path": { },
"canPreview": { },
"canFetchSchema": { }
}
}
}
}
},
"attributes": {"category": "Cloud Storage",
"connectorName": "Google Cloud Storage",
"isSource": true,
"uiAttributes": {"apiFeatures": {"explorePaginationSupported": false
}
}
},
"permissionsInfo": {"manage": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
}
]
}

Creates a new connection spec.

Use this endpoint to create a new connection spec for your source.

Request

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
required

The following request creates a new connection spec for a new source.

name required	string
providerId required	string
version	string
type	string
	object
	object
	Array of objects (AuthenticationSpecDTO)
	Array of objects (EncryptionSpecDTO)
	object (SourceSpecDTO)
	object (TargetSpecDTO)
	object (ExploreSpecDTO)
	object
	Array of objects (EntitlementSpecDTO)
	object (PolicyItemDTO)

Responses

201

Connection Spec Created

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

post/connectionSpecs

Request samples

Payload

application/json

{"name": "string",
"providerId": "string",
"version": "string",
"type": "string",
"settings": {"property1": { },
"property2": { }
},
"attributes": {"property1": { },
"property2": { }
},
"authSpec": [{"name": "Basic Authentication for google-cloud",
"type": "KeyBased",
"spec": {"accessKeyId": "GOOGMG1234ABCDEFGHIJKLMN",
"secretAccessKey": "xxxx"
}
}
],
"encryptionSpecs": [{"name": "string",
"type": "string",
"spec": {"encryptionAlgo": {"type": "string",
"description": "string"
},
"publicKey": {"type": "string",
"contentEncoding": "string",
"description": "string"
}
}
}
],
"sourceSpec": {"name": "CloudStorage",
"type": "CloudStorage",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines params required when this connection is used as a source in flow.",
"path": {"type": "string",
"description": "The input path for copying files. This can be a folder path, a file path or a wildcard pattern."
},
"recursive": {"type": "boolean",
"default": "false",
"description": "The recursive property indicates recursive copy in case of folder or wild card path. The default value is false."
}
},
"attributes": {"uiAttributes": {"isSource": true,
"documentationLink": "http://www.adobe.com/go/sources-google-cloud-storage-en",
"category": "cloudStorage",
"icon": "google",
"description": "Create a live inbound connection to your Google Cloud Storage account to periodically ingest delimited data file into Experience Platform.",
"label": "Google Cloud Storage"
}
}
},
"targetSpec": {"name": "CloudStorage",
"type": "CloudStorage",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"dataSetId": "string"
},
"attributes": {"uiAttributes": {"isDestination": true,
"documentationLink": "http://www.adobe.com/go/sources-google-cloud-storage-en",
"category": "cloudStorage",
"icon": "google",
"description": "string",
"label": "string"
}
}
},
"exploreSpec": {"name": "FileSystem",
"type": "FileSystem",
"requestSpec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"responseSpec": {"root": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": {"type": "folder"
},
"name": {"name": "acme-customers"
},
"path": {"path": "sales"
},
"canPreview": {"canPreview": false
},
"canFetchSchema": {"canFetchSchema": false
}
}
}
},
"folder": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": {"type": "folder"
},
"name": {"name": "acme-customers"
},
"path": {"path": "sales"
},
"canPreview": {"canPreview": false
},
"canFetchSchema": {"canFetchSchema": false
}
}
}
},
"file": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": {"type": "folder"
},
"name": {"name": "acme-customers"
},
"path": {"path": "sales"
},
"canPreview": {"canPreview": false
},
"canFetchSchema": {"canFetchSchema": false
}
}
}
}
}
},
"permissionsInfo": {"property1": [{"manage": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
],
"property2": [{"manage": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
]
},
"entitlementInfo": [{"operation": "anyOf",
"entitlements": ["string"
]
}
],
"policy": {"duleLabels": ["string"
],
"enforcementRefs": ["string"
]
}
}

Response samples

application/json

{"id": "44c6e8ec-54e8-4813-a472-93c6cf29c3d7",
"createdAt": 1624299037286,
"updatedAt": 1624299037286,
"createdBy": "acp_foundation_connectors@AdobeID",
"updatedBy": "acp_foundation_connectors@AdobeID",
"createdClient": "acp_foundation_connectors",
"updatedClient": "acp_foundation_connectors",
"sandboxId": "6b36e130-c5d7-11e9-949c-0da8d50fcac1",
"sandboxName": "prod",
"imsOrgId": "7DC732555AECDB4C0A494036@AdobeOrg",
"name": "test1",
"providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"version": "1.0",
"authSpec": [{"name": "Basic Authentication for Dynamics-Online",
"type": "BasicAuthentication",
"spec": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "defines auth params required for connecting to dynamics-online",
"properties": {"serviceUri": {"type": "string",
"description": "The service URL of your Dynamics instance"
},
"username": {"type": "string",
"description": "User name for the user account"
},
"password": {"type": "string",
"description": "Password for the user account",
"format": "password"
}
},
"required": ["username",
"password",
"serviceUri"
]
}
}
],
"sourceSpec": {"spec": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines params required when dynamics-online connection is used as a source in flow.",
"properties": {"tableName": {"type": "string",
"description": "The input table from dynamics-online to pull data from."
},
"columns": {"type": "array",
"items": {"type": "object",
"properties": {"name": {"type": "string"
},
"type": {"type": "string"
},
"meta": {"type": "object",
"description": "Defines meta information for each column.",
"originalType": {"type": "string"
}
}
},
"required": ["name",
"type",
"meta"
]
}
}
},
"required": ["tableName",
"columns"
]
},
"attributes": {"uiAttributes": {"documentationLink": "http://www.adobe.com/go/sources-dynamics-en",
"isSource": true,
"category": {"key": "crm"
},
"icon": {"key": "msDynamics"
},
"description": {"key": "microsoftDynamicsDescription"
},
"label": {"key": "microsoftDynamicsLabel"
}
}
}
},
"attributes": {"category": "CRM",
"isSource": true,
"documentationLink": "http://www.adobe.com/go/data-connector-Microsoft-Dynamics-en",
"uiAttributes": {"apiFeatures": {"explorePaginationSupported": false
}
}
},
"permissionsInfo": {"manage": {"@type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
},
"view": {"@type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
}
}

Retrieve a connection spec

Use this endpoint to retrieve a single instance of a connection spec.

Request

path Parameters

CONNECTION_SPEC_ID

required

string

The ID of the connection specification that you want to retrieve.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Connection Specification Details Retrieved

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/connectionSpecs/{CONNECTION_SPEC_ID}

Response samples

application/json

{"items": [{"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"name": "Google Cloud Storage",
"providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"version": "1.0",
"authSpec": [{"name": "Basic Authentication for google-cloud",
"type": "KeyBased",
"spec": {"accessKeyId": "GOOGMG1234ABCDEFGHIJKLMN",
"secretAccessKey": "xxxx"
}
}
],
"sourceSpec": {"name": "CloudStorage",
"type": "CloudStorage",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines params required when this connection is used as a source in flow.",
"path": {"type": "string",
"description": "The input path for copying files. This can be a folder path, a file path or a wildcard pattern."
},
"recursive": {"type": "boolean",
"default": "false",
"description": "The recursive property indicates recursive copy in case of folder or wild card path. The default value is false."
}
},
"attributes": {"uiAttributes": {"isSource": true,
"documentationLink": "http://www.adobe.com/go/sources-google-cloud-storage-en",
"category": "cloudStorage",
"icon": "google",
"description": "Create a live inbound connection to your Google Cloud Storage account to periodically ingest delimited data file into Experience Platform.",
"label": "Google Cloud Storage"
}
}
},
"exploreSpec": {"name": "FileSystem",
"type": "FileSystem",
"requestSpec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"responseSpec": {"root": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": { },
"name": { },
"path": { },
"canPreview": { },
"canFetchSchema": { }
}
}
},
"folder": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": { },
"name": { },
"path": { },
"canPreview": { },
"canFetchSchema": { }
}
}
},
"file": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": { },
"name": { },
"path": { },
"canPreview": { },
"canFetchSchema": { }
}
}
}
}
},
"attributes": {"category": "Cloud Storage",
"connectorName": "Google Cloud Storage",
"isSource": true,
"uiAttributes": {"apiFeatures": {"explorePaginationSupported": false
}
}
},
"permissionsInfo": {"manage": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
}
]
}

Updates an existing connection spec.

Use this endpoint to update an existing connection spec.

Request

path Parameters

CONNECTION_SPEC_ID

required

string

The ID of the connection spec that you want to update.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
required

The following request updates the information of the queried connection spec ID.

name required	string
providerId required	string
version	string
type	string
	object
	object
	Array of objects (AuthenticationSpecDTO)
	Array of objects (EncryptionSpecDTO)
	object (SourceSpecDTO)
	object (TargetSpecDTO)
	object (ExploreSpecDTO)
	object
	Array of objects (EntitlementSpecDTO)
	object (PolicyItemDTO)

Responses

200

Success

400

The request is invalid.

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

put/connectionSpecs/{CONNECTION_SPEC_ID}

Request samples

Payload

application/json

{"name": "string",
"providerId": "string",
"version": "string",
"type": "string",
"settings": {"property1": { },
"property2": { }
},
"attributes": {"property1": { },
"property2": { }
},
"authSpec": [{"name": "Basic Authentication for google-cloud",
"type": "KeyBased",
"spec": {"accessKeyId": "GOOGMG1234ABCDEFGHIJKLMN",
"secretAccessKey": "xxxx"
}
}
],
"encryptionSpecs": [{"name": "string",
"type": "string",
"spec": {"encryptionAlgo": {"type": "string",
"description": "string"
},
"publicKey": {"type": "string",
"contentEncoding": "string",
"description": "string"
}
}
}
],
"sourceSpec": {"name": "CloudStorage",
"type": "CloudStorage",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines params required when this connection is used as a source in flow.",
"path": {"type": "string",
"description": "The input path for copying files. This can be a folder path, a file path or a wildcard pattern."
},
"recursive": {"type": "boolean",
"default": "false",
"description": "The recursive property indicates recursive copy in case of folder or wild card path. The default value is false."
}
},
"attributes": {"uiAttributes": {"isSource": true,
"documentationLink": "http://www.adobe.com/go/sources-google-cloud-storage-en",
"category": "cloudStorage",
"icon": "google",
"description": "Create a live inbound connection to your Google Cloud Storage account to periodically ingest delimited data file into Experience Platform.",
"label": "Google Cloud Storage"
}
}
},
"targetSpec": {"name": "CloudStorage",
"type": "CloudStorage",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"dataSetId": "string"
},
"attributes": {"uiAttributes": {"isDestination": true,
"documentationLink": "http://www.adobe.com/go/sources-google-cloud-storage-en",
"category": "cloudStorage",
"icon": "google",
"description": "string",
"label": "string"
}
}
},
"exploreSpec": {"name": "FileSystem",
"type": "FileSystem",
"requestSpec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object"
},
"responseSpec": {"root": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": {"type": "folder"
},
"name": {"name": "acme-customers"
},
"path": {"path": "sales"
},
"canPreview": {"canPreview": false
},
"canFetchSchema": {"canFetchSchema": false
}
}
}
},
"folder": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": {"type": "folder"
},
"name": {"name": "acme-customers"
},
"path": {"path": "sales"
},
"canPreview": {"canPreview": false
},
"canFetchSchema": {"canFetchSchema": false
}
}
}
},
"file": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "array",
"items": {"type": "object",
"properties": {"type": {"type": "folder"
},
"name": {"name": "acme-customers"
},
"path": {"path": "sales"
},
"canPreview": {"canPreview": false
},
"canFetchSchema": {"canFetchSchema": false
}
}
}
}
}
},
"permissionsInfo": {"property1": [{"manage": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
],
"property2": [{"manage": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
]
},
"entitlementInfo": [{"operation": "anyOf",
"entitlements": ["string"
]
}
],
"policy": {"duleLabels": ["string"
],
"enforcementRefs": ["string"
]
}
}

Response samples

application/json

{"id": "44c6e8ec-54e8-4813-a472-93c6cf29c3d7",
"createdAt": 1624299037286,
"updatedAt": 1624299037286,
"createdBy": "acp_foundation_connectors@AdobeID",
"updatedBy": "acp_foundation_connectors@AdobeID",
"createdClient": "acp_foundation_connectors",
"updatedClient": "acp_foundation_connectors",
"sandboxId": "6b36e130-c5d7-11e9-949c-0da8d50fcac1",
"sandboxName": "prod",
"imsOrgId": "7BA732555AECDB4C0A494036@AdobeOrg",
"name": "test1",
"providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"version": "1.0",
"authSpec": [{"name": "Basic Authentication for Dynamics-Online",
"type": "BasicAuthentication",
"spec": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines auth params required for connecting to dynamics-online.",
"properties": {"serviceUri": {"type": "string",
"description": "The service URL of your Dynamics instance"
},
"username": {"type": "string",
"description": "User name for the user account"
},
"password": {"type": "string",
"description": "Password for the user account",
"format": "password"
}
},
"required": ["username",
"password",
"serviceUri"
]
}
}
],
"sourceSpec": {"spec": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines params required when dynamics-online connection is used as a source in flow.",
"properties": {"tableName": {"type": "string",
"description": "The input table from dynamics-online to pull data from"
},
"columns": {"type": "array",
"items": {"type": "object",
"properties": {"name": {"type": "string"
},
"type": {"type": "string"
},
"meta": {"type": "object",
"description": "Defines meta information for each column.",
"originalType": {"type": "string"
}
}
},
"required": ["name",
"type",
"meta"
]
}
}
},
"required": ["tableName",
"columns"
]
},
"attributes": {"uiAttributes": {"documentationLink": "http://www.adobe.com/go/sources-dynamics-en",
"isSource": true,
"category": {"key": "crm"
},
"icon": {"key": "msDynamics"
},
"description": {"key": "microsoftDynamicsDescription"
},
"label": {"key": "microsoftDynamicsLabel"
}
}
}
},
"attributes": {"category": "CRM",
"isSource": true,
"documentationLink": "http://www.adobe.com/go/data-connector-Microsoft-Dynamics-en",
"uiAttributes": {"apiFeatures": {"explorePaginationSupported": false
}
}
},
"permissionsInfo": {"manage": {"@type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
},
"view": {"@type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
}
}

Explore objects of a connection spec.

Use this endpoint to explore the objects of a given connection spec.

Request

path Parameters

CONNECTION_SPEC_ID

required

string

The ID of the queried connection spec.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Success

400

The request is invalid.

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

get/connectionSpecs/{CONNECTION_SPEC_ID}/explore

Response samples

application/json

{"items": [{"columnName": "name",
"columnType": "string"
},
{"columnName": "address",
"columnType": "string"
},
{"columnName": "dob",
"columnType": "date"
},
{"columnName": "phone",
"columnType": "string"
}
]
}

Retrieve config options for a connection spec.

Use this endpoint to retrieve the available config options for a given connection spec.

Request

path Parameters

CONNECTION_SPEC_ID

required

string

The ID of the queried connection spec.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Success

400

The request is invalid.

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

get/connectionSpecs/{CONNECTION_SPEC_ID}/configs

Response samples

application/json

{"items": [{"columnName": "name",
"columnType": "string"
},
{"columnName": "address",
"columnType": "string"
},
{"columnName": "dob",
"columnType": "date"
},
{"columnName": "phone",
"columnType": "string"
}
]
}

Flows

Flows (or dataflows) represent the transfer of data between source and target. They include details on the transformations applied to your data, the current status of your flow, and details on the most recent run iteration of your flow. Flows also contain metadata, attributes inherited from the base, source, and target connections, as well as a unique flow ID. An instance of a flow is specific to an organization.

List flows

Retrieve a list of flows in your organization by making a GET request to the /flows endpoint.

Request

query Parameters

property	Array of strings A comma-separated list of top-level object properties to be returned in the response. This parameter is used to filter the response data based on the properties provided. For example, `property=lastRunDetails.startedAtUTC>=1670880253121` returns only the flows whos last run iterations were started during or after the specified epoch time in milliseconds. This parameter is also used to cut down the amount of data returned in the response body. For example, `property=state==enabled&orderby=createdAt` returns only base connections that have a status of `enabled` in the order of their creation, in ascending order.
limit	integer Restrict the maximum number of items returned for a given request. For example, adding a parameter of `limit=10` in a request to retrieve all base connections returns only a maximum of 10 base connections. When used to query the API, the returned response automatically includes a `continuationToken` that can be used to fetch records that were not returned due to the limits applied by the parameter.
orderby	string Sort the listed resources by specified fields. For example, `orderby=name` sorts results by name in ascending order (A-Z). Adding a dash (`-`) before the field name (`orderby=-name`) sorts the results in descending order (Z-A).
continuationToken	string An auto-generated string token that is appended to a returned response when there are more results to be read beyond the maximum count of items that can be returned.
count	boolean Default: false A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`)

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Flow List Retrieved

400

The request is invalid.

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

get/flows

Response samples

application/json

{"items": [{"id": "3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"createdAt": 1670284443204,
"updatedAt": 1670284532205,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google Cloud Storage Flow",
"description": "A Google Cloud Storage flow for ACME customer data",
"flowSpec": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"state": "enabled",
"version": "\"7e05f181-0000-0200-0000-638e84f40000\"",
"etag": "\"7e05f181-0000-0200-0000-638e84f40000\"",
"sourceConnectionIds": ["eb19c882-f19c-4d63-ad21-1d7ba9b21a85"
],
"targetConnectionIds": ["eea7eaf4-3fe5-4792-b59b-2ec24c3e8331"
],
"inheritedAttributes": {"sourceConnections": [{"id": "eb19c882-f19c-4d63-ad21-1d7ba9b21a85",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"baseConnection": {"id": "69f188b6-af07-4587-8061-e94d34637b41",
"connectionSpec": {"id": null,
"version": null
}
}
}
],
"targetConnections": [{"id": "eea7eaf4-3fe5-4792-b59b-2ec24c3e8331",
"connectionSpec": {"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}
]
},
"scheduleParams": {"startTime": 1590091157,
"frequency": "minute",
"interval": "15",
"backfill": true
},
"transformations": [{"name": "Mapping",
"params": {"mappingId": "97051e9e86184c7d88d6bf8104ad7765",
"mappingVersion": "0"
}
}
],
"runs": "/runs?property=flowId==3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"lastOperation": {"started": 1670284443413,
"updated": 0,
"operation": "create"
},
"lastRunDetails": {"id": "98fbed6e-f896-4b19-b279-b0d56d732d8d",
"state": "success",
"startedAtUTC": 1670284458833,
"completedAtUTC": 1670284518048
}
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 7
}

Create a flow

Use this endpoint to create a flow instance.

Request

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
required

name - (Required) The name of the flow to be created.
description - (Optional) The description provides information and details regarding the flow to be created.
flowSpec - (Required) The flowSpec contains information regarding flow specifications, including its flow specification ID and version.
- id - The specific flow specification ID used to create a flow.
- version - Specifies the version of the flow specification ID. Omitting this value will default to the most recent version.
sourceConnectionIds - (Required) The ID of the source connection generated using the source's base connection ID and connection specification IDs.
targetConnectionIds - (Required) The ID of the target connection. This ID is needed to manage a destination connection to Platform.
transformations - (Required) Contains various transformations that will be done as part of the flow.
- name - (Required) The name assigned to the transformation.
- params - (Required) Contains information about the transformation that will be completed. Sources categorized as either CRM or relational database require the use of the "deltaColumn" param. Other categories do not.
scheduleParams - (Required) Contains information regarding the ingestion scheduling of the flow.
- startTime - Designates the start time for flow in epoch time in seconds.
- frequency - Designates the scheduled frequency of ingestion for a flow. Valid values include once, minute, hour, day, week.
- interval - Designates the period between two consecutive flow runs. Its assigned value should be a non zero integer. Interval is not required when frequency is set as once, and should be set as equal or greater than 15 if frequency is set on a per minute basis. There are no constraints on interval for other frequency settings.
- backfill - A boolean value that determines what data is initially ingested. If backfill is enabled, all current files in the specified path will be ingested during the first scheduled ingestion. If backfill is disabled, only the files that are loaded in between the first run of ingestion and the Start time will be ingested. Files loaded prior to Start time will not be ingested.

name	string The name of the flow.
description	string An optional description used to add further information to a flow.
required	object
sourceConnectionIds	Array of strings
targetConnectionIds	Array of strings
	Array of objects (FlowTransformationDTO)
	object (ScheduleSpecDTO)

Responses

201

Flow Created

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

post/flows

Request samples

Payload

application/json

{"name": "Google Cloud Storage Flow",
"description": "A Google Cloud Storage flow for ACME customer data",
"flowSpec": {"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"version": "1.0"
},
"sourceConnectionIds": ["eb19c882-f19c-4d63-ad21-1d7ba9b21a85"
],
"targetConnectionIds": ["eea7eaf4-3fe5-4792-b59b-2ec24c3e8331"
],
"transformations": [{"name": "Mapping",
"params": {"mappingId": "97051e9e86184c7d88d6bf8104ad7765",
"mappingVersion": "0"
}
}
],
"scheduleParams": {"startTime": 1590091157,
"frequency": "minute",
"interval": "15",
"backfill": true
}
}

Response samples

application/json

{"id": "3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"etag": "\"7e05b480-0000-0200-0000-638e84a00000\""
}

Retrieve a flow's details

Use this endpoint to retrieve a single instance of an existing flow.

Request

path Parameters

FLOW_ID

required

string

The flow entity with the corresponding ID.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Flow Details Retrieved

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/flows/{FLOW_ID}

Response samples

application/json

{"items": [{"id": "3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"createdAt": 1670284443204,
"updatedAt": 1670284532205,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google Cloud Storage Flow",
"description": "A Google Cloud Storage flow for ACME customer data",
"flowSpec": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"state": "enabled",
"version": "\"7e05f181-0000-0200-0000-638e84f40000\"",
"etag": "\"7e05f181-0000-0200-0000-638e84f40000\"",
"sourceConnectionIds": ["eb19c882-f19c-4d63-ad21-1d7ba9b21a85"
],
"targetConnectionIds": ["eea7eaf4-3fe5-4792-b59b-2ec24c3e8331"
],
"inheritedAttributes": {"sourceConnections": [{"id": "eb19c882-f19c-4d63-ad21-1d7ba9b21a85",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"baseConnection": {"id": "69f188b6-af07-4587-8061-e94d34637b41",
"connectionSpec": {"id": null,
"version": null
}
}
}
],
"targetConnections": [{"id": "eea7eaf4-3fe5-4792-b59b-2ec24c3e8331",
"connectionSpec": {"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}
]
},
"scheduleParams": {"startTime": 1590091157,
"frequency": "minute",
"interval": "15",
"backfill": true
},
"transformations": [{"name": "Mapping",
"params": {"mappingId": "97051e9e86184c7d88d6bf8104ad7765",
"mappingVersion": "0"
}
}
],
"runs": "/runs?property=flowId==3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"lastOperation": {"started": 1670284443413,
"updated": 0,
"operation": "create"
},
"lastRunDetails": {"id": "98fbed6e-f896-4b19-b279-b0d56d732d8d",
"state": "success",
"startedAtUTC": 1670284458833,
"completedAtUTC": 1670284518048
}
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 7
}

Delete a flow

Use this endpoint to delete an instance of a flow.

Request

path Parameters

FLOW_ID

required

string

The ID of the flow you want to delete.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

204

Flow Deleted

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

delete/flows/{FLOW_ID}

Update a flow

Use this endpoint to update a flow.

Request

path Parameters

FLOW_ID

required

string

The ID of the flow you want to update.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.
if-match required	string A parameter required when updating a connection or a dataflow. When making a PUT or PATCH request, you must add an `if-match` header parameter and include the current version/etag of the resource that you want to update to complete the update.

Request Body schema: application/json
required

op - (Required) The operation call used to define the action needed to update the connection. Operations include add, replace, and remove.
path - (Optional) The path of the parameter to be updated.
value - (Required) The new value you want to update your parameter with.

Array

op required	string Enum: "ADD" "REPLACE" "REMOVE"
path required	string
required	object

Responses

200

Flow Updated

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

patch/flows/{FLOW_ID}

Request samples

Payload

application/json

[{"op": "ADD",
"path": "/auth/params",
"value": {"description": "A new description to provide further context on a specified connection or flow."
}
}
]

Response samples

application/json

{"id": "3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"etag": "\"7e05b480-0000-0200-0000-638e84a00000\""
}

Retrieves list of flows based on a given filtering criteria.

Use this endpoint to retrieve a list of flows given a particular set of filtering criteria.

Request

query Parameters

continuationToken

string

continuationToken

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.
x-active-sandbox-ids	string

Request Body schema: application/json
required

The filtering parameters to be applied to the query for a flow.

queryString	string
limit	integer <int32> <= 1000
orderby	string
count	boolean
projectionFields	string

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

post/flows/search

Request samples

Payload

application/json

{"queryString": "string",
"limit": 1000,
"orderby": "string",
"count": true,
"projectionFields": "string"
}

Response samples

application/json

{"items": [{"id": "3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"createdAt": 1670284443204,
"updatedAt": 1670284532205,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google Cloud Storage Flow",
"description": "A Google Cloud Storage flow for ACME customer data",
"flowSpec": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"state": "enabled",
"version": "\"7e05f181-0000-0200-0000-638e84f40000\"",
"etag": "\"7e05f181-0000-0200-0000-638e84f40000\"",
"sourceConnectionIds": ["eb19c882-f19c-4d63-ad21-1d7ba9b21a85"
],
"targetConnectionIds": ["eea7eaf4-3fe5-4792-b59b-2ec24c3e8331"
],
"inheritedAttributes": {"sourceConnections": [{"id": "eb19c882-f19c-4d63-ad21-1d7ba9b21a85",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"baseConnection": {"id": "69f188b6-af07-4587-8061-e94d34637b41",
"connectionSpec": {"id": null,
"version": null
}
}
}
],
"targetConnections": [{"id": "eea7eaf4-3fe5-4792-b59b-2ec24c3e8331",
"connectionSpec": {"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}
]
},
"scheduleParams": {"startTime": 1590091157,
"frequency": "minute",
"interval": "15",
"backfill": true
},
"transformations": [{"name": "Mapping",
"params": {"mappingId": "97051e9e86184c7d88d6bf8104ad7765",
"mappingVersion": "0"
}
}
],
"runs": "/runs?property=flowId==3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"lastOperation": {"started": 1670284443413,
"updated": 0,
"operation": "create"
},
"lastRunDetails": {"id": "98fbed6e-f896-4b19-b279-b0d56d732d8d",
"state": "success",
"startedAtUTC": 1670284458833,
"completedAtUTC": 1670284518048
}
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 7
}

Perform a state transition action given flow object.

Use this endpoint to perform a state transition action on a given flow object.

Request

path Parameters

FLOW_ID

required

string

The ID of the queried flow.

query Parameters

op required	string The operative action to be performed during the request. Enum: "ENABLE" "DISABLE" "FINALIZE_UPDATE" "FINALIZE" "PUBLISH"
subOp required	Array of strings The sub-operative action to be performed during the request. Items Enum: "APPLY" "ROLLBACK" "PROGRESS"

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.
If-Match	string If-Match

Request Body schema: application/json
optional

percentCompleted	number <double>
	object (StatusDTO)
	Array of objects (FlowRecordTypeDTO)

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

post/flows/{FLOW_ID}/action

Request samples

Payload

application/json

{"percentCompleted": 0,
"status": {"value": "IN_PROGRESS",
"properties": { },
"errors": [{"message": "string",
"code": "string",
"details": { }
}
]
},
"recordTypes": [{"type": "string",
"extensions": { }
}
]
}

Response samples

application/json

{"id": "3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"etag": "\"7e05b480-0000-0200-0000-638e84a00000\""
}

Flow specs

Flow specs retain information that define a flow. They include information on how a flow can be scheduled, whether a flow supports options like partial ingestion and error diagnostics, as well as the parameters required for different mappings from source to target. Flow specs also include information on how a flow run can be created and a list of connection spec IDs and target connection IDs that a given flow can support. Flow specs are organization agnostic.

List flow specifications

Retrieve a list of flow specifications by making a GET request to the /flowSpecs endpoint.

Request

query Parameters

property

Array of strings

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Flow Specifications Listed

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/flowSpecs

Response samples

application/json

{"items": [{"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"name": "CloudStorageToAEP",
"providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"version": "1.0",
"sourceConnectionSpecIds": [""
],
"targetConnectionSpecIds": ["c604ff05-7f1a-43c0-8e18-33bf874cb11c"
],
"optionSpec": {"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {"errorDiagnosticsEnabled": {"title": "Error diagnostics",
"description": "Flag to enable detailed and sample error diagnostics summary.",
"type": "boolean",
"default": false
},
"partialIngestionPercent": {"title": "Partial ingestion threshold",
"description": "Percentage which defines the threshold of errors allowed before the run is marked as failed.",
"type": "number",
"exclusiveMinimum": 0
}
}
}
},
"transformationSpecs": {"name": "Mapping",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines various params required for different mapping from source to target",
"properties": {"mappingId": {"type": "string"
},
"mappingVersion": {"type": "string"
}
}
}
},
"scheduleSpec": {"name": "PeriodicSchedule",
"type": "Periodic",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {"startTime": {"description": "epoch time",
"type": "integer"
},
"frequency": {"type": "string",
"enum": ["once",
"minute",
"hour",
"day",
"week"
]
},
"interval": {"type": "integer"
},
"backfill": {"type": "boolean",
"default": true
}
},
"required": ["startTime",
"frequency"
],
"if": {"properties": {"frequency": {"const": null
}
}
},
"then": {"allOf": [{"not": {"required": ["interval"
]
}
},
{"not": {"required": ["backfill"
]
}
}
]
},
"else": {"required": ["interval"
],
"if": {"properties": {"frequency": { }
}
},
"then": {"properties": {"interval": { }
}
},
"else": {"properties": {"interval": { }
}
}
}
}
},
"attributes": {"isSourceFlow": true,
"flacValidationSupported": true,
"frequency": "batch",
"notification": {"category": "sources",
"flowRun": {"enabled": true
}
}
},
"permissionsInfo": {"manage": [{"type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
}
]
}

Create a new flow spec.

Use this endpoint to create a new flow spec.

Request

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
required

The following request creates a new flow spec.

	Array of objects (TransformationSpecDTO)
name required	string
providerId required	string
version	string
type	string
	object
	object (OptionSpecDTO)
	object (ScheduleSpecDTO)
	object (RunSpecDTO) Defines various params required for creating flow run for the speicific spec.
	object
	Array of objects (EntitlementSpecDTO)
	object (PolicyItemDTO)
sourceConnectionSpecIds	Array of strings
targetConnectionSpecIds	Array of strings

Responses

201

The flow spec has been successfully created.

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

post/flowSpecs

Request samples

Payload

application/json

{"transformationSpecDTOS": [{"mappingId": "97051e9e86184c7d88d6bf8104ad7765",
"mappingVersion": "0"
}
],
"name": "string",
"providerId": "string",
"version": "string",
"type": "string",
"attributes": {"property1": { },
"property2": { }
},
"optionSpec": {"errorDiagnosticsEnabled": true,
"partialIngestionPercent": 5
},
"scheduleSpec": {"startTime": 1590091157,
"frequency": "minute",
"interval": "15",
"backfill": true
},
"runSpec": {"startTime": 0,
"windowStartTime": 0,
"windowEndTime": 0
},
"permissionsInfo": {"property1": [{"manage": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
],
"property2": [{"manage": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
]
},
"entitlementInfo": [{"operation": "anyOf",
"entitlements": ["string"
]
}
],
"policy": {"duleLabels": ["string"
],
"enforcementRefs": ["string"
]
},
"sourceConnectionSpecIds": ["string"
],
"targetConnectionSpecIds": ["string"
]
}

Response samples

application/json

{"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"name": "CloudStorageToAEP",
"providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"version": "1.0",
"attributes": {"notification": {"category": "sources",
"flowRun": null,
"enabled": true
}
},
"sourceConnectionSpecIds": ["b3ba5556-48be-44b7-8b85-ff2b69b46dc4",
"ecadc60c-7455-4d87-84dc-2a0e293d997b",
"b7829c2f-2eb0-4f49-a6ee-55e33008b629",
"4c10e202-c428-4796-9208-5f1f5732b1cf",
"fb2e94c9-c031-467d-8103-6bd6e0a432f2",
"32e8f412-cdf7-464c-9885-78184cb113fd",
"b7bf2577-4520-42c9-bae9-cad01560f7bc",
"998b8ae3-cec0-43b7-8abe-40b1eb4ee069",
"be5ec48c-5b78-49d5-b8fa-7c89ec4569b8",
"54e221aa-d342-4707-bcff-7a4bceef0001",
"c85f9425-fb21-426c-ad0b-405e9bd8a46c"
],
"targetConnectionSpecIds": ["c604ff05-7f1a-43c0-8e18-33bf874cb11c"
],
"permissionsInfo": {"view": {"@type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
},
"manage": {"@type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
},
"optionSpec": {"name": "OptionSpec",
"spec": {"$schema": "http://json-schema.org/draft-07/schema#"
},
"type": "object",
"properties": {"errorDiagnosticsEnabled": {"title": "Error diagnostics.",
"description": "Flag to enable detailed and sample error diagnostics summary.",
"type": "boolean",
"default": false
},
"partialIngestionPercent": {"title": "Partial ingestion threshold.",
"description": "Percentage which defines the threshold of errors allowed before the run is marked as failed. type: number"
},
"exclusiveMinimum": 0
}
},
"scheduleSpec": {"name": "PeriodicSchedule",
"type": "Periodic",
"spec": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {"startTime": {"description": "epoch time",
"type": "integer"
},
"frequency": {"type": "string",
"enum": ["once",
"minute",
"hour",
"day",
"week"
]
},
"interval": {"type": "integer"
},
"backfill": {"type": "boolean",
"default": true
}
},
"required": ["startTime",
"frequency"
],
"if": {"properties": {"frequency": {"const": "once"
}
}
},
"then": {"allOf": [{"not": {"required": ["interval"
]
}
},
{"not": {"required": ["backfill"
]
}
}
]
},
"else": {"required": ["interval"
],
"if": {"properties": {"frequency": {"const": "minute"
}
}
},
"then": {"properties": {"interval": {"minimum": 15
}
}
},
"else": {"properties": {"interval": {"minimum": 1
}
}
}
}
}
},
"transformationSpec": [{"name": "Mapping",
"spec": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "defines various params required for different mapping from source to target",
"properties": {"mappingId": {"type": "string"
},
"mappingVersion": {"type": "string"
}
}
}
}
]
}

Retrieve a flow spec

Use this endpoint to retrieve an instance of a flow spec.

Request

path Parameters

FLOW_SPEC_ID

required

string

The flow spec with the corresponding ID.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Flow Specification Details Retrieved

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/flowSpecs/{FLOW_SPEC_ID}

Response samples

application/json

{"items": [{"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"name": "CloudStorageToAEP",
"providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"version": "1.0",
"sourceConnectionSpecIds": [""
],
"targetConnectionSpecIds": ["c604ff05-7f1a-43c0-8e18-33bf874cb11c"
],
"optionSpec": {"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {"errorDiagnosticsEnabled": {"title": "Error diagnostics",
"description": "Flag to enable detailed and sample error diagnostics summary.",
"type": "boolean",
"default": false
},
"partialIngestionPercent": {"title": "Partial ingestion threshold",
"description": "Percentage which defines the threshold of errors allowed before the run is marked as failed.",
"type": "number",
"exclusiveMinimum": 0
}
}
}
},
"transformationSpecs": {"name": "Mapping",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines various params required for different mapping from source to target",
"properties": {"mappingId": {"type": "string"
},
"mappingVersion": {"type": "string"
}
}
}
},
"scheduleSpec": {"name": "PeriodicSchedule",
"type": "Periodic",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {"startTime": {"description": "epoch time",
"type": "integer"
},
"frequency": {"type": "string",
"enum": ["once",
"minute",
"hour",
"day",
"week"
]
},
"interval": {"type": "integer"
},
"backfill": {"type": "boolean",
"default": true
}
},
"required": ["startTime",
"frequency"
],
"if": {"properties": {"frequency": {"const": null
}
}
},
"then": {"allOf": [{"not": {"required": ["interval"
]
}
},
{"not": {"required": ["backfill"
]
}
}
]
},
"else": {"required": ["interval"
],
"if": {"properties": {"frequency": { }
}
},
"then": {"properties": {"interval": { }
}
},
"else": {"properties": {"interval": { }
}
}
}
}
},
"attributes": {"isSourceFlow": true,
"flacValidationSupported": true,
"frequency": "batch",
"notification": {"category": "sources",
"flowRun": {"enabled": true
}
}
},
"permissionsInfo": {"manage": [{"type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
}
]
}

Updates an existing flow spec

Use this endpoint to update an existing flow spec.

Request

path Parameters

FLOW_SPEC_ID

required

string

The ID of the queried flow spec.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
required

The following request updates the information of the queried flow spec.

	Array of objects (TransformationSpecDTO)
name required	string
providerId required	string
version	string
type	string
	object
	object (OptionSpecDTO)
	object (ScheduleSpecDTO)
	object (RunSpecDTO) Defines various params required for creating flow run for the speicific spec.
	object
	Array of objects (EntitlementSpecDTO)
	object (PolicyItemDTO)
sourceConnectionSpecIds	Array of strings
targetConnectionSpecIds	Array of strings

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

put/flowSpecs/{FLOW_SPEC_ID}

Request samples

Payload

application/json

{"transformationSpecDTOS": [{"mappingId": "97051e9e86184c7d88d6bf8104ad7765",
"mappingVersion": "0"
}
],
"name": "string",
"providerId": "string",
"version": "string",
"type": "string",
"attributes": {"property1": { },
"property2": { }
},
"optionSpec": {"errorDiagnosticsEnabled": true,
"partialIngestionPercent": 5
},
"scheduleSpec": {"startTime": 1590091157,
"frequency": "minute",
"interval": "15",
"backfill": true
},
"runSpec": {"startTime": 0,
"windowStartTime": 0,
"windowEndTime": 0
},
"permissionsInfo": {"property1": [{"manage": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
],
"property2": [{"manage": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"@type": "lowlevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
]
},
"entitlementInfo": [{"operation": "anyOf",
"entitlements": ["string"
]
}
],
"policy": {"duleLabels": ["string"
],
"enforcementRefs": ["string"
]
},
"sourceConnectionSpecIds": ["string"
],
"targetConnectionSpecIds": ["string"
]
}

Response samples

application/json

{"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"name": "CloudStorageToAEP",
"providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"version": "1.0",
"attributes": {"notification": {"category": "sources",
"flowRun": {"enabled": true
}
}
},
"sourceConnectionSpecIds": ["b3ba5556-48be-44b7-8b85-ff2b69b46dc4",
"ecadc60c-7455-4d87-84dc-2a0e293d997b",
"b7829c2f-2eb0-4f49-a6ee-55e33008b629",
"4c10e202-c428-4796-9208-5f1f5732b1cf",
"fb2e94c9-c031-467d-8103-6bd6e0a432f2",
"32e8f412-cdf7-464c-9885-78184cb113fd",
"b7bf2577-4520-42c9-bae9-cad01560f7bc",
"998b8ae3-cec0-43b7-8abe-40b1eb4ee069",
"be5ec48c-5b78-49d5-b8fa-7c89ec4569b8",
"54e221aa-d342-4707-bcff-7a4bceef0001",
"c85f9425-fb21-426c-ad0b-405e9bd8a46c"
],
"targetConnectionSpecIds": ["c604ff05-7f1a-43c0-8e18-33bf874cb11c"
],
"permissionsInfo": {"view": {"@type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
},
"manage": {"@type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
},
"optionSpec": {"name": "OptionSpec",
"spec": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {"errorDiagnosticsEnabled": {"title": "Error diagnostics.",
"description": "Flag to enable detailed and sample error diagnostics summary.",
"type": "boolean",
"default": false
},
"partialIngestionPercent": {"title": "Partial ingestion threshold.",
"description": "Percentage which defines the threshold of errors allowed before the run is marked as failed.",
"type": "number",
"exclusiveMinimum": 0
}
}
}
},
"scheduleSpec": {"name": "PeriodicSchedule",
"type": "Periodic",
"spec": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {"startTime": {"description": "epoch time",
"type": "integer"
},
"frequency": {"type": "string",
"enum": ["once",
"minute",
"hour",
"day",
"week"
]
},
"interval": {"type": "integer"
},
"backfill": {"type": "boolean",
"default": true
}
},
"required": ["startTime",
"frequency"
],
"if": {"properties": {"frequency": {"const": "once"
}
}
},
"then": {"allOf": [{"not": null,
"required": ["interval"
]
},
{"not": null,
"required": ["backfill"
]
}
]
},
"else": {"required": ["interval"
],
"if": {"properties": {"frequency": {"const": "minute"
}
}
},
"then": {"properties": {"interval": {"minimum": 15
}
}
},
"else": {"properties": {"interval": {"minimum": 1
}
}
}
}
}
},
"transformationSpec": [{"name": "Mapping",
"spec": {"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines various params required for different mapping from source to target.",
"properties": {"mappingId": {"type": "string"
},
"mappingVersion": {"type": "string"
}
}
}
}
]
}

Retrieve a list of flow specs based on a given filtering criteria.

Use this endpoint to retrieve a list of flow specs given a set of filtering parameters.

Request

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
required

The following request establishes a set of filtering paramters to be used to search for specific flow specs.

queryString	string
limit	integer <int32> <= 1000
orderby	string
count	boolean
groupByProperty	string
projectionFields	string

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

post/flowSpecs/search

Request samples

Payload

application/json

{"queryString": "string",
"limit": 1000,
"orderby": "string",
"count": true,
"groupByProperty": "string",
"projectionFields": "string"
}

Response samples

application/json

{"items": [{"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"name": "CloudStorageToAEP",
"providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"version": "1.0",
"sourceConnectionSpecIds": [""
],
"targetConnectionSpecIds": ["c604ff05-7f1a-43c0-8e18-33bf874cb11c"
],
"optionSpec": {"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {"errorDiagnosticsEnabled": {"title": "Error diagnostics",
"description": "Flag to enable detailed and sample error diagnostics summary.",
"type": "boolean",
"default": false
},
"partialIngestionPercent": {"title": "Partial ingestion threshold",
"description": "Percentage which defines the threshold of errors allowed before the run is marked as failed.",
"type": "number",
"exclusiveMinimum": 0
}
}
}
},
"transformationSpecs": {"name": "Mapping",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines various params required for different mapping from source to target",
"properties": {"mappingId": {"type": "string"
},
"mappingVersion": {"type": "string"
}
}
}
},
"scheduleSpec": {"name": "PeriodicSchedule",
"type": "Periodic",
"spec": {"schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {"startTime": {"description": "epoch time",
"type": "integer"
},
"frequency": {"type": "string",
"enum": ["once",
"minute",
"hour",
"day",
"week"
]
},
"interval": {"type": "integer"
},
"backfill": {"type": "boolean",
"default": true
}
},
"required": ["startTime",
"frequency"
],
"if": {"properties": {"frequency": {"const": null
}
}
},
"then": {"allOf": [{"not": {"required": ["interval"
]
}
},
{"not": {"required": ["backfill"
]
}
}
]
},
"else": {"required": ["interval"
],
"if": {"properties": {"frequency": { }
}
},
"then": {"properties": {"interval": { }
}
},
"else": {"properties": {"interval": { }
}
}
}
}
},
"attributes": {"isSourceFlow": true,
"flacValidationSupported": true,
"frequency": "batch",
"notification": {"category": "sources",
"flowRun": {"enabled": true
}
}
},
"permissionsInfo": {"manage": [{"type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["write"
]
}
],
"view": [{"type": "lowLevel",
"name": "EnterpriseSource",
"permissions": ["read"
]
}
]
}
}
]
}

Runs

Runs (or flow runs) represent the instance of a flow execution. For example, if a flow is scheduled to run hourly at 9 AM, 10 AM, and 11 AM, then you would have three instances of a run. Runs retain metric summaries on your flow executions, including information on the duration of the run, size of the data, file count, and a status update. An instance of a run is specific to an organization.

List flow runs

Use this endpoint to list all flow run iterations in your organization.

Request

query Parameters

property	Array of strings A comma-separated list of top-level object properties to be returned in the response. This parameter is used to filter the response data based on the properties provided. For example, `property=lastRunDetails.startedAtUTC>=1670880253121` returns only the flows whos last run iterations were started during or after the specified epoch time in milliseconds. This parameter is also used to cut down the amount of data returned in the response body. For example, `property=state==enabled&orderby=createdAt` returns only base connections that have a status of `enabled` in the order of their creation, in ascending order.
limit	integer Restrict the maximum number of items returned for a given request. For example, adding a parameter of `limit=10` in a request to retrieve all base connections returns only a maximum of 10 base connections. When used to query the API, the returned response automatically includes a `continuationToken` that can be used to fetch records that were not returned due to the limits applied by the parameter.
orderby	string Sort the listed resources by specified fields. For example, `orderby=name` sorts results by name in ascending order (A-Z). Adding a dash (`-`) before the field name (`orderby=-name`) sorts the results in descending order (Z-A).
continuationToken	string An auto-generated string token that is appended to a returned response when there are more results to be read beyond the maximum count of items that can be returned.
count	boolean Default: false A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`)

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Run List Retrieved

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/runs

Response samples

application/json

{"items": [{"id": "7af3ba45-4952-4371-8361-1b30134be7eb",
"createdAt": 1670444672602,
"updatedAt": 1670444707059,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"flowId": "3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"flowSpec": {"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"version": "1.0"
},
"providerRefId": "M-3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d-incremental-0:cd0ab404-960a-422d-b2f6-2ca5063606f2",
"eTag": "\"7e08a7b4-0000-0200-0000-6390f6a30000\"",
"metrics": {"durationSummary": {"startedAtUTC": 1670444654036,
"completedAtUTC": 1670444685455
},
"sizeSummary": {"inputBytes": 124,
"outputBytes": 1884
},
"recordSummary": {"inputRecordCount": 2,
"createdRecordCount": 2,
"outputRecordCount": 2,
"failedRecordCount": 0
},
"fileSummary": {"inputFileCount": 1,
"outputFileCount": 1,
"manifest": {"fileInfo": [{"path": null,
"pathPrefix": null
}
]
}
},
"statusSummary": {"status": "success"
}
},
"activites": [{"id": "4f008a00-3a04-11eb-adc1-0242ac120002",
"name": "Google Cloud Storage Copy Activity",
"updatedAtUTC": 0,
"durationSummary": {"startedAtUTC": 1670444654036,
"completedAtUTC": 1670444685455
},
"latencySummary": { },
"sizeSummary": {"inputBytes": 0,
"outputBytes": 0
},
"recordSummary": { },
"fileSummary": {"inputFileCount": 1
},
"statusSummary": {"status": "success",
"extensions": { }
}
}
]
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 12
}

Create a new run

Create a new run for a given flow by making a POST request to the /runs endpoint while providing the ID of the flow that you want to make a run for. In order to create a run against an existing flow, the flow must be scheduled for one-time ingestion.

Request

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
required

flowId	string The ID of the flow in which your run will be created against.
	object

Responses

201

Run Created

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

post/runs

Request samples

Payload

application/json

{"flowId": "a57c12ae-a406-4a37-95ac-a8e3455e5a52",
"params": {"startTime": 1670455537,
"windowStartTime": 1670455537,
"windowEndTime": 1670455947
}
}

Response samples

application/json

{"id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
"etag": "\"1100c53e-0000-0200-0000-627138980000\""
}

Retrieve a single flow run

Use this endpoint to retrieve a single flow run iteration.

Request

path Parameters

RUN_ID

required

string

The ID of the run you want to retrieve.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Run Details Retrieved

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/runs/{RUN_ID}

Response samples

application/json

{"items": [{"id": "7af3ba45-4952-4371-8361-1b30134be7eb",
"createdAt": 1670444672602,
"updatedAt": 1670444707059,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"flowId": "3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"flowSpec": {"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"version": "1.0"
},
"providerRefId": "M-3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d-incremental-0:cd0ab404-960a-422d-b2f6-2ca5063606f2",
"eTag": "\"7e08a7b4-0000-0200-0000-6390f6a30000\"",
"metrics": {"durationSummary": {"startedAtUTC": 1670444654036,
"completedAtUTC": 1670444685455
},
"sizeSummary": {"inputBytes": 124,
"outputBytes": 1884
},
"recordSummary": {"inputRecordCount": 2,
"createdRecordCount": 2,
"outputRecordCount": 2,
"failedRecordCount": 0
},
"fileSummary": {"inputFileCount": 1,
"outputFileCount": 1,
"manifest": {"fileInfo": [{"path": null,
"pathPrefix": null
}
]
}
},
"statusSummary": {"status": "success"
}
},
"activites": [{"id": "4f008a00-3a04-11eb-adc1-0242ac120002",
"name": "Google Cloud Storage Copy Activity",
"updatedAtUTC": 0,
"durationSummary": {"startedAtUTC": 1670444654036,
"completedAtUTC": 1670444685455
},
"latencySummary": { },
"sizeSummary": {"inputBytes": 0,
"outputBytes": 0
},
"recordSummary": { },
"fileSummary": {"inputFileCount": 1
},
"statusSummary": {"status": "success",
"extensions": { }
}
}
]
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 12
}

Update a new flow run

Use this endpoint to update a flow run iteration.

Request

path Parameters

RUN_ID

required

string

The ID of the flow run that you want to update.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.
If-Match required	string If-Match

Request Body schema: application/json
required

The following request updates the queried flow run.

flowId	string
	object (SpecInfoDTO)
providerRefId	string
parentFlowRunId	string
childFlowRunIds	Array of strings
params	object
	Array of objects (FlowRunPredecessorDTO)
	object (FlowRunMetricsDTO)
	Array of objects (ActivityDTO)
recordTypes	Array of strings

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

put/runs/{RUN_ID}

Request samples

Payload

application/json

{"flowId": "string",
"flowSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"providerRefId": "string",
"parentFlowRunId": "string",
"childFlowRunIds": ["string"
],
"params": { },
"predecessors": [{"flowId": "string",
"flowRunId": "string",
"flowSpec": { }
}
],
"metrics": {"durationSummary": {"startedAtUTC": 0,
"completedAtUTC": 0,
"extensions": { }
},
"latencySummary": {"minMs": 0,
"maxMs": 0,
"avgMs": 0,
"extensions": { }
},
"sizeSummary": {"inputBytes": 0,
"outputBytes": 0
},
"recordSummary": {"inputRecordCount": 0,
"createdRecordCount": 0,
"updatedRecordCount": 0,
"skippedRecordCount": 0,
"failedRecordCount": 0,
"deletedRecordCount": 0,
"warningRecordCount": 0,
"skippedInfo": [{"message": "string",
"code": "string",
"details": { }
}
],
"failedInfo": [{"message": "string",
"code": "string",
"details": { }
}
],
"extensions": { }
},
"fileSummary": {"inputFileCount": 0,
"outputFileCount": 0,
"skippedFileCount": 0,
"failedFileCount": 0,
"extensions": { },
"manifest": {"property1": [{"path": "string",
"outputBytes": 0,
"pathPrefix": "string"
}
],
"property2": [{"path": "string",
"outputBytes": 0,
"pathPrefix": "string"
}
]
},
"activityRefs": ["string"
]
},
"statusSummary": {"status": "success",
"extensions": { }
}
},
"activities": [{"id": "4f008a00-3a04-11eb-adc1-0242ac120002",
"name": "Google Cloud Storage Copy Activity",
"updatedAtUTC": 0,
"durationSummary": {"startedAtUTC": 1670444654036,
"completedAtUTC": 1670444685455
},
"latencySummary": {"minMs": 0,
"maxMs": 0,
"avgMs": 0,
"extensions": { }
},
"sizeSummary": {"inputBytes": 0,
"outputBytes": 0
},
"recordSummary": { },
"fileSummary": {"inputFileCount": 1
},
"statusSummary": {"status": "success",
"extensions": { }
}
}
],
"recordTypes": ["string"
]
}

Response samples

application/json

{"id": "ae4532-fe4324-f34vsd32"
}

Perform an action on a given flowRun object.

Use this endpoint to perform an action against a given flow run object.

Request

path Parameters

RUN_ID

required

string

The ID of the flow run that you want to update.

query Parameters

required

string

The operative action to be performed on the queried flow run.

Value: "RE_TRIGGER"

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.
If-Match	string If-Match

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

post/runs/{RUN_ID}/action

Response samples

application/json

{"id": "7af3ba45-4952-4371-8361-1b30134be7eb",
"createdAt": 1670444672602,
"updatedAt": 1670444707059,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"flowId": "3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d",
"flowSpec": {"id": "9753525b-82c7-4dce-8a9b-5ccfce2b9876",
"version": "1.0"
},
"providerRefId": "M-3d17a4ff-9e0a-4f7c-94bb-bc0b61a3a76d-incremental-0:cd0ab404-960a-422d-b2f6-2ca5063606f2",
"eTag": "\"7e08a7b4-0000-0200-0000-6390f6a30000\"",
"metrics": {"durationSummary": {"startedAtUTC": 1670444654036,
"completedAtUTC": 1670444685455
},
"sizeSummary": {"inputBytes": 124,
"outputBytes": 1884
},
"recordSummary": {"inputRecordCount": 2,
"createdRecordCount": 2,
"outputRecordCount": 2,
"failedRecordCount": 0
},
"fileSummary": {"inputFileCount": 1,
"outputFileCount": 1,
"manifest": {"fileInfo": [{"path": "https://platform.adobe.io/data/foundation/export/batches/01GKQEBS103JPWNZNJTEVFVDMY/meta?path=input_files",
"pathPrefix": "/acme/acme-customers/sales/acme-customers-sales-spring.csv"
}
]
}
},
"statusSummary": {"status": "success"
}
},
"activites": [{"id": "4f008a00-3a04-11eb-adc1-0242ac120002",
"name": "Google Cloud Storage Copy Activity",
"updatedAtUTC": 0,
"durationSummary": {"startedAtUTC": 1670444654036,
"completedAtUTC": 1670444685455
},
"latencySummary": { },
"sizeSummary": {"inputBytes": 0,
"outputBytes": 0
},
"recordSummary": { },
"fileSummary": {"inputFileCount": 1
},
"statusSummary": {"status": "success",
"extensions": { }
}
}
]
}

Source connections

Source connections represent the incoming data from a given source. Source connections define the source and the format of the incoming data. Source connections also refer to the base connection for authentication information. For file-based sources like cloud storages, source connections can define additional information on the data transfer, such as column delimiter, encoding type, compression type, regular expressions, and whether ingestion is to be done recursively. For table-based sources such as CRMs and databases, source connections can be used for additional attributes such as tableName and column. An instance of a source connection is specific to an organization.

List all source connections

Use this endpoint to retrieve a list of all source connections.

Request

query Parameters

property	Array of strings A comma-separated list of top-level object properties to be returned in the response. This parameter is used to filter the response data based on the properties provided. For example, `property=lastRunDetails.startedAtUTC>=1670880253121` returns only the flows whos last run iterations were started during or after the specified epoch time in milliseconds. This parameter is also used to cut down the amount of data returned in the response body. For example, `property=state==enabled&orderby=createdAt` returns only base connections that have a status of `enabled` in the order of their creation, in ascending order.
limit	integer Restrict the maximum number of items returned for a given request. For example, adding a parameter of `limit=10` in a request to retrieve all base connections returns only a maximum of 10 base connections. When used to query the API, the returned response automatically includes a `continuationToken` that can be used to fetch records that were not returned due to the limits applied by the parameter.
orderby	string Sort the listed resources by specified fields. For example, `orderby=name` sorts results by name in ascending order (A-Z). Adding a dash (`-`) before the field name (`orderby=-name`) sorts the results in descending order (Z-A).
continuationToken	string An auto-generated string token that is appended to a returned response when there are more results to be read beyond the maximum count of items that can be returned.
count	boolean Default: false A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`)

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

get/sourceConnections

Response samples

application/json

{"items": [{"id": "eb19c882-f19c-4d63-ad21-1d7ba9b21a85",
"createdAt": 1670276871555,
"updatedAt": 1670276871555,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google Cloud Storage source connection",
"description": "A Google Cloud Storage source connection for ACME customer data",
"baseConnectionId": "69f188b6-af07-4587-8061-e94d34637b41",
"state": "enabled",
"data": {"format": "delimited"
},
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"params": {"path": "Accounts"
},
"version": "\"5f00fba7-0000-0200-0000-5ed560520000\"",
"etag": "\"5f00fba7-0000-0200-0000-5ed560520000\"",
"providerRefId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"inheritedAttributes": {"baseConnection": {"id": "69f188b6-af07-4587-8061-e94d34637b41",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
}
}
}
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 1
}

Create a new source connection

Use this endpoint to create a new source connection.

Request

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
optional

name required	string
baseConnectionId	string
description	string
required	object (SourceConnectionDataDTO)
	object
required	object (SpecInfoDTO)

Responses

201

Source Connection Created

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

post/sourceConnections

Request samples

Payload

application/json

{"name": "Google Cloud Storage source connection",
"baseConnectionId": "69f188b6-af07-4587-8061-e94d34637b41",
"description": "A Google Cloud Storage source connection for ACME customer data",
"data": {"format": "delimited"
},
"params": {"path": "/acme/acme-customers/sales/acme-customers-sales-spring.csv"
},
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
}
}

Response samples

application/json

{"id": "eb19c882-f19c-4d63-ad21-1d7ba9b21a85",
"etag": "\"c207057b-0000-0200-0000-638e67070000\""
}

Retrieve a source connection by ID

Retrieve a single source connection by making a GET request to the /sourceConnections/{SOURCE_CONNECTION_ID} endpoint while providing the ID of the source connection you want to retrieve.

Request

path Parameters

SOURCE_CONNECTION_ID

required

string

The ID of the source connection you want to retrieve.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Source Connection Details Retrieved

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/sourceConnections/{SOURCE_CONNECTION_ID}

Response samples

application/json

{"items": [{"id": "eb19c882-f19c-4d63-ad21-1d7ba9b21a85",
"createdAt": 1670276871555,
"updatedAt": 1670276871555,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google Cloud Storage source connection",
"description": "A Google Cloud Storage source connection for ACME customer data",
"baseConnectionId": "69f188b6-af07-4587-8061-e94d34637b41",
"state": "enabled",
"data": {"format": "delimited"
},
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"params": {"path": "Accounts"
},
"version": "\"5f00fba7-0000-0200-0000-5ed560520000\"",
"etag": "\"5f00fba7-0000-0200-0000-5ed560520000\"",
"providerRefId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"inheritedAttributes": {"baseConnection": {"id": "69f188b6-af07-4587-8061-e94d34637b41",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
}
}
}
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 1
}

Delete a source connection

Use this endpoint to delete an instance of a source connection.

Request

path Parameters

SOURCE_CONNECTION_ID

required

string

The ID of the source connection you want to delete.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

204

Source Connection Deleted

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

delete/sourceConnections/{SOURCE_CONNECTION_ID}

Update a source connection

Update the information of a source connection by making a PATCH request to the /sourceConnections/{SOURCE_CONNECTION_ID} endpoint while providing the ID of the source connection you want to update. To update a source connection, you must also provide the current etag of your source connection as the if-match header.

Request

path Parameters

SOURCE_CONNECTION_ID

required

string

The ID of the source connection you want to update.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.
if-match required	string A parameter required when updating a connection or a dataflow. When making a PUT or PATCH request, you must add an `if-match` header parameter and include the current version/etag of the resource that you want to update to complete the update.

Request Body schema: application/json
required

op - (Required) The operation call used to define the action needed to update the connection. Operations include add, replace, and remove.
path - (Optional) The path of the parameter to be updated.
value - (Required) The new value you want to update your parameter with.

Array

op required	string Enum: "ADD" "REPLACE" "REMOVE"
path required	string
required	object

Responses

200

Source Connection Updated

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

patch/sourceConnections/{SOURCE_CONNECTION_ID}

Request samples

Payload

application/json

[{"op": "ADD",
"path": "/auth/params",
"value": {"description": "A new description to provide further context on a specified connection or flow."
}
}
]

Response samples

application/json

{"items": [{"id": "eb19c882-f19c-4d63-ad21-1d7ba9b21a85",
"createdAt": 1670276871555,
"updatedAt": 1670276871555,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google Cloud Storage source connection",
"description": "A Google Cloud Storage source connection for ACME customer data",
"baseConnectionId": "69f188b6-af07-4587-8061-e94d34637b41",
"state": "enabled",
"data": {"format": "delimited"
},
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"params": {"path": "Accounts"
},
"version": "\"5f00fba7-0000-0200-0000-5ed560520000\"",
"etag": "\"5f00fba7-0000-0200-0000-5ed560520000\"",
"providerRefId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
"inheritedAttributes": {"baseConnection": {"id": "69f188b6-af07-4587-8061-e94d34637b41",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
}
}
}
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 1
}

Performs a state transition action on an existing source connection.

Use this endpoint to perform a state transition action on an existing source connection.

Request

path Parameters

SOURCE_CONNECTION_ID

required

string

The ID of the queried source connection.

query Parameters

required

string

The operative action to perform against the queried source connection.

Value: "PUBLISH"

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

post/sourceConnections/{SOURCE_CONNECTION_ID}/action

Response samples

application/json

{"id": "eb19c882-f19c-4d63-ad21-1d7ba9b21a85",
"etag": "\"c207057b-0000-0200-0000-638e67070000\""
}

Target connections

Target connections represent the outgoing data from a source to a location such as Experience Platform or the data lake. Target connections contain information on your schema, dataset, and the destination of your data. Target connections also include a unique target connection ID that is required in order to create a flow. An instance of a target connection is specific to an organization.

List all target connections.

Use this endpoint to retrieve a list of all target connections.

Request

query Parameters

property	Array of strings A comma-separated list of top-level object properties to be returned in the response. This parameter is used to filter the response data based on the properties provided. For example, `property=lastRunDetails.startedAtUTC>=1670880253121` returns only the flows whos last run iterations were started during or after the specified epoch time in milliseconds. This parameter is also used to cut down the amount of data returned in the response body. For example, `property=state==enabled&orderby=createdAt` returns only base connections that have a status of `enabled` in the order of their creation, in ascending order.
limit	integer Restrict the maximum number of items returned for a given request. For example, adding a parameter of `limit=10` in a request to retrieve all base connections returns only a maximum of 10 base connections. When used to query the API, the returned response automatically includes a `continuationToken` that can be used to fetch records that were not returned due to the limits applied by the parameter.
orderby	string Sort the listed resources by specified fields. For example, `orderby=name` sorts results by name in ascending order (A-Z). Adding a dash (`-`) before the field name (`orderby=-name`) sorts the results in descending order (Z-A).
continuationToken	string An auto-generated string token that is appended to a returned response when there are more results to be read beyond the maximum count of items that can be returned.
count	boolean Default: false A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`)

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Target Connection Details Retrieved

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

get/targetConnections

Response samples

application/json

{"items": [{"id": "1642748e-7cbc-4f3d-8274-8e7cbcaf3d97",
"createdAt": 1670279178771,
"updatedAt": 1670279178771,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google Cloud Storage Target Connection",
"description": "A Google Cloud Storage Target Connection for ACME customer data",
"state": "enabled",
"data": {"format": "delimited",
"schema": {"id": "https://ns.adobe.com/{TENANT}/schemas/8e5fd1adf94007b936d0f8ea9e270c48dba26b7dcdad80d0",
"version": "application/vnd.adobe.xed-full+json;version=1.0"
}
},
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"params": {"dataSetId": "5ed18e0f4f90b719196f44a9"
},
"version": "\"6f00d1ea-0000-0200-0000-5ea6713e0000\"",
"etag": "\"6f00d1ea-0000-0200-0000-5ea6713e0000\"",
"providerRefId": "string",
"inheritedAttributes": {"baseConnection": {"id": "69f188b6-af07-4587-8061-e94d34637b41",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
}
}
}
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 0
}

Create a target connection

Use this endpoint to create a target connection.

Request

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Request Body schema: application/json
optional

name	string The name of the target connection.
description	string
required	object (TargetConnectionDataDTO)
	object
required	object

Responses

201

Target Connection Created

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

post/targetConnections

Request samples

Payload

application/json

{"name": "Google Cloud Storage target connection",
"description": "A Google Cloud Storage Target Connection for ACME customer data",
"data": {"format": "delimited",
"schema": {"id": "https://ns.adobe.com/{TENANT}/schemas/8e5fd1adf94007b936d0f8ea9e270c48dba26b7dcdad80d0",
"version": "application/vnd.adobe.xed-full+json;version=1.0"
}
},
"params": {"dataSetId": "638e6c7b5679741b63ff5c24"
},
"connectionSpec": {"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}

Response samples

application/json

{"id": "eea7eaf4-3fe5-4792-b59b-2ec24c3e8331",
"etag": "\"29070e1a-0000-0200-0000-638e700a0000\""
}

Performs a state transition action on an existing target connection.

Use this endpoint to perform a state transition action on an existing target connection.

Request

path Parameters

TARGET_CONNECTION_ID

required

string

The ID of the queried target connection.

query Parameters

required

string

The operative action to perform against the queried target connection.

Value: "PUBLISH"

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

200

Success

401

The user is unauthorized. Contact your administrator to resolve permissions and access the resource.

500

An internal error has occurred. Please try again. If the problem persisits, contact customer support.

post/targetConnections/{TARGET_CONNECTION_ID}/action

Response samples

application/json

{"id": "eea7eaf4-3fe5-4792-b59b-2ec24c3e8331",
"etag": "\"29070e1a-0000-0200-0000-638e700a0000\""
}

Retrieve a target connection

Retrieve a single target connection by making a GET request to the /targetConnections/{TARGET_CONNECTION_ID} endpoint while providing the ID of the target connection you want to retrieve.

Request

path Parameters

TARGET_CONNECTION_ID

required

string

The ID of the target connection you want to retrieve.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.

Responses

200

Target Connection Details Retrieved

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

get/targetConnections/{TARGET_CONNECTION_ID}

Response samples

application/json

{"items": [{"id": "1642748e-7cbc-4f3d-8274-8e7cbcaf3d97",
"createdAt": 1670279178771,
"updatedAt": 1670279178771,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google Cloud Storage Target Connection",
"description": "A Google Cloud Storage Target Connection for ACME customer data",
"state": "enabled",
"data": {"format": "delimited",
"schema": {"id": "https://ns.adobe.com/{TENANT}/schemas/8e5fd1adf94007b936d0f8ea9e270c48dba26b7dcdad80d0",
"version": "application/vnd.adobe.xed-full+json;version=1.0"
}
},
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"params": {"dataSetId": "5ed18e0f4f90b719196f44a9"
},
"version": "\"6f00d1ea-0000-0200-0000-5ea6713e0000\"",
"etag": "\"6f00d1ea-0000-0200-0000-5ea6713e0000\"",
"providerRefId": "string",
"inheritedAttributes": {"baseConnection": {"id": "69f188b6-af07-4587-8061-e94d34637b41",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
}
}
}
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 0
}

Delete a target connection

Use this endpoint to delete an instance of a target connection.

Request

path Parameters

TARGET_CONNECTION_ID

required

string

The ID of the target connection you want to delete.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.

Responses

204

Target Connection Deleted

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

delete/targetConnections/{TARGET_CONNECTION_ID}

Update a target connection

Use this endpoint to update a target connection.

Request

path Parameters

TARGET_CONNECTION_ID

required

string

The ID of the target connection you want to update.

header Parameters

Authorization required	string 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.
x-api-key required	string 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.
x-gw-ims-org-id required	string 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.
x-sandbox-name	string 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.
if-match required	string A parameter required when updating a connection or a dataflow. When making a PUT or PATCH request, you must add an `if-match` header parameter and include the current version/etag of the resource that you want to update to complete the update.

Request Body schema: application/json
required

op - (Required) The operation call used to define the action needed to update the connection. Operations include add, replace, and remove.
path - (Optional) The path of the parameter to be updated.
value - (Required) The new value you want to update your parameter with.

Array

op required	string Enum: "ADD" "REPLACE" "REMOVE"
path required	string
required	object

Responses

200

Target Connection Details Retrieved

403

Authorization Error - Missing OAuth Token

503

Server Error - Service Unavailable

patch/targetConnections/{TARGET_CONNECTION_ID}

Request samples

Payload

application/json

[{"op": "ADD",
"path": "/auth/params",
"value": {"description": "A new description to provide further context on a specified connection or flow."
}
}
]

Response samples

application/json

{"items": [{"id": "1642748e-7cbc-4f3d-8274-8e7cbcaf3d97",
"createdAt": 1670279178771,
"updatedAt": 1670279178771,
"createdBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"updatedBy": "28AF22BA5DE6B0B40A494036@AdobeID",
"createdClient": "exc_app",
"updatedClient": "exc_app",
"sandboxId": "1bd86660-c5da-11e9-93d4-6d5fc3a66a8e",
"sandboxName": "prod",
"imsOrgId": "5C1328435BF324E90A49402A@AdobeOrg",
"name": "Google Cloud Storage Target Connection",
"description": "A Google Cloud Storage Target Connection for ACME customer data",
"state": "enabled",
"data": {"format": "delimited",
"schema": {"id": "https://ns.adobe.com/{TENANT}/schemas/8e5fd1adf94007b936d0f8ea9e270c48dba26b7dcdad80d0",
"version": "application/vnd.adobe.xed-full+json;version=1.0"
}
},
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
},
"params": {"dataSetId": "5ed18e0f4f90b719196f44a9"
},
"version": "\"6f00d1ea-0000-0200-0000-5ea6713e0000\"",
"etag": "\"6f00d1ea-0000-0200-0000-5ea6713e0000\"",
"providerRefId": "string",
"inheritedAttributes": {"baseConnection": {"id": "69f188b6-af07-4587-8061-e94d34637b41",
"connectionSpec": {"id": "32e8f412-cdf7-464c-9885-78184cb113fd",
"version": "1.0"
}
}
}
}
],
"_links": {"next": {"href": "/connections?continuationToken=abcdefghijkLMNOPqrstupWXKYZ"
}
},
"count": 0
}

Get credentials

Flow Service API - Sources (1.0)

(NEW) Interactive API documentation

Connections

List connections

query Parameters

header Parameters

Create a new connection

header Parameters

Request Body schema: application/jsonrequired

Retrieve a base connection

path Parameters

header Parameters

Test a base connection's connectivity

path Parameters

header Parameters

Explore a connection's contents

path Parameters

query Parameters

header Parameters

Perform a state transition action on an existing connection.

path Parameters

query Parameters

header Parameters

Request Body schema: application/jsonoptional

Delete an existing connection

path Parameters

header Parameters

Update an existing connection

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Retrieve configs for the properties of a given connection.

path Parameters

header Parameters

Retrieve a list of connections based on a given filtering criteria.

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Connection specs

List connection specs

query Parameters

header Parameters

Creates a new connection spec.

header Parameters

Request Body schema: application/jsonrequired

Retrieve a connection spec

path Parameters

header Parameters

Updates an existing connection spec.

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Explore objects of a connection spec.

path Parameters

header Parameters

Retrieve config options for a connection spec.

path Parameters

header Parameters

Flows

List flows

query Parameters

header Parameters

Create a flow

header Parameters

Request Body schema: application/jsonrequired

Retrieve a flow's details

path Parameters

header Parameters

Delete a flow

path Parameters

header Parameters

Update a flow

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Retrieves list of flows based on a given filtering criteria.

query Parameters

header Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional