Get Dataflow object details and related paths

get {protocol}://{base-url}/integration/v2/dataflow/

API to fetch dataflow objects' details and their associated lineage paths. Dataflow Objects can be filtered by providing an array of dataflow object IDs or external IDs in the request body payload. Note: Request body payload is optional and may not be supported in some API clients such as Swagger UI.

Responses

Response body

object

dataflow_objects

array of objects

dataflow_objects

object

number

The Alation ID of the dataflow object

external_id

string

required

The external id of the dataflow object. To access this dataflow object uniquely.

title

string

Title of the dataflow object

description

string

The description of the transformation

content

string

The transformation logic, code or sql query

group_name

string

The dataflow source group name to which the dataflow belongs to. Case sensitive. If an exact match is found then it would be used, otherwise it will create a new dataflow source group.

paths

array of arrays of arrays of objects

"paths" is an array of "path"s. Each "path" specifies the details of sources (-> dataflows) -> targets lineage by listing elements of each step, or "segment", of the lineages in order.
Each "segment" may contain data objects and/or dataflows, but the first and the last
"segment" of a "path" SHOULD NOT contain any dataflows.

paths

array of arrays of objects

array of objects

object

otype

string

required

Alation object type of source/target

dataflow - Represents a dataflow
table - Represents a table
column/attribute - Represents a column
file - Represents a file
directory - Represents a directory
bi_report - Represents a report of a BI server
bi_report_column - Represents a column of a report of a BI server
bi_datasource - Represents a data source of a BI server
bi_datasource_column - Represents a column of a data source of a BI server
external - Placeholder for anything Alation doesn't support natively

dataflow table column file directory bi_report bi_report_column bi_datasource bi_datasource_column external

key

string

required

Unique identifier of an object

dataflow - api/<unique identifier of dataflow>
table - <datasource_id>.[<dbname>/<catalog_name>.]<schema_name>.<table_name> NOTE:
<db_name> has to be specified for SQL Server, Redshift, Snowflake and Netezza.
column/attribute - <datasource_id>.[<dbname>/<catalog_name>.]<schema_name>.<table_name>.<column_name>
NOTE: <db_name> has to be specified for SQL Server, Redshift, Snowflake and Netezza.
file - <filesystem_id>.<full path of a file delimited by '/'>
directory - <filesystem_id>.<full path of a directory delimited by '/'>
bi_report - <bi_server_id>.bi_report.<unique identifier of bi_report on
the server>
bi_report_column - <bi_server_id>.bi_report_column.<unique identifier of
bi_report_column on the server>
bi_datasource - <bi_server_id>.bi_datasource.<unique identifier of
bi_datasource on the server>
bi_datasource_column - <bi_server_id>.bi_datasource_column.<unique
identifier of bi_datasource_column on the server>
external - <unique identifier/name of external object>

dataflow table column file directory bi_report bi_report_column bi_datasource bi_datasource_column external

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://alation_domain/integration/v2/dataflow/?keyField=id&limit=100&skip=0' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

200Object containing dataflow object details and their lineage paths

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

429Too many requests

500Internal Server Error