Get Dataflow object details and related paths

get

https://{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. They can also be filtered by external_id using the lookup query parameters below. Note: Request body payload is optional and may not be supported in some API clients such as Swagger UI.

Query Params

keyField

string

enum

Defaults to id

Field to use as an identifier of the resource (id, or external_id)

Allowed:

limit

integer

Defaults to 100

Specifies the number of objects to be fetched in one paginated request. Response may have a X-Next-Page URL parameter in the header to fetch next set of objects or page

skip

integer

Defaults to 0

Specifies the number of objects to be skipped in one request. Used together with Limit parameter to fetch paginated requests. This is automatically set in X-Next-Page response header if present

excludeTemp

boolean

Defaults to false

Same as excludeTemp on GET /lineage/ (stitching, depth limit configured by lineage-service.filters.asset_depth with default 10, parallel-chain merge), applied to the data objects on either side of the seed dataflow. The seed dataflow itself is unaffected.

excludeGone

boolean

Defaults to true

Same as excludeGone on GET /lineage/ (stitching, depth limit configured by lineage-service.filters.asset_depth with default 10, parallel-chain merge), applied to the data objects on either side of the seed dataflow. Default is true.

external_id__iexact

string

filter by external_id case insensitive exact match

external_id__contains

string

filter by external_id containing the given string

external_id__icontains

string

filter by external_id containing the given string, case insensitive match

external_id__startswith

string

filter by external_id starting with the given string

external_id__istartswith

string

filter by external_id starting with the given string, case insensitive match

external_id__endswith

string

filter by external_id ending with the given string

external_id__iendswith

string

filter by external_id ending with the given string, case insensitive match

Body Params

List of dataflow object ids or external ids

Responses

Language

Credentials

Header

URL

Loading…

Response

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