Api Documentation (1.0)

Download OpenAPI specification:

Api Documentation

data-sources

Data Sources Controller

Get data sources

Returns a pageable list of data sources filtered by the query parameters

query Parameters
append
boolean

Write mode (true - append, false - overwrite

applicationId
string

Id of the application

asAtTime
integer <int64>
Default: 0

Timestamp of the request, if asAtTime equals 0, the current timestamp will be applied

dataSourceUri
string

Destination path

facet.timestamp
boolean
Default: false
Example: facet.timestamp=0

Enable 'timestamp' facet computation. (default - false)

pageNum
integer <int32>
Default: 1
Example: pageNum=1

Page number

pageSize
integer <int32>
Default: 10

Page size

searchTerm
string

Text to filter the results

sortField
string
Default: "dataSourceUri"

Sort field

sortOrder
string
Default: "asc"
Example: sortOrder=asc

Sort order

timestampEnd
integer <int64>

End of the last write time range (inclusive)

timestampStart
integer <int64>

Beginning of the last write time range (inclusive)

Responses

execution-events

Execution Events Controller

Get execution events

Returns a pageable list of execution events filtered by the query parameters

query Parameters
append
boolean

Write mode (true - append, false - overwrite

applicationId
string

Id of the application

asAtTime
integer <int64>
Default: 0

Timestamp of the request, if asAtTime equals 0, the current timestamp will be applied

dataSourceUri
string

Destination path

facet.timestamp
boolean
Default: false
Example: facet.timestamp=0

Enable 'timestamp' facet computation. (default - false)

pageNum
integer <int32>
Default: 1
Example: pageNum=1

Page number

pageSize
integer <int32>
Default: 10

Page size

searchTerm
string

Text to filter the results

sortField
string
Default: "timestamp"

Sort field

sortOrder
string
Default: "desc"
Example: sortOrder=asc

Sort order

timestampEnd
integer <int64>

End of the time range (inclusive)

timestampStart
integer <int64>

Beginning of the time range (inclusive)

Responses

lineage

Lineage Detailed Controller

Get graph of attributes that depends on attribute with provided id

query Parameters
attributeId
string

Attribute ID

Responses

execPlanDataSources

path Parameters
plan_id
required
string <uuid>

plan_id

query Parameters
access
string

access

Responses

Get detailed execution plan (DAG)

Returns a logical plan DAG by execution plan ID

query Parameters
execId
string <uuid>

Execution plan ID

Responses

Get execution event lineage overview

    Returns a lineage overview for a given execution event.
    The graph consists of nodes of two types: data sources and executed jobs.
    The lineage describes the historical data flow only, that is the data flow that has affected and
    is observed by the given execution event (at the time of the event)
  
query Parameters
eventId
string

Execution event ID

maxDepth
integer <int32>
Default: 5
Example: maxDepth=5

Max depth of the graph. ([Source] -> [App] -> [Target]) is considered one level

Responses

operations

Operation Details Controller

Get Operation details

path Parameters
operationId
required
string

Id of the operation node to retrieve

Responses