Enterprise Data Catalog REST API Reference > Lineage Filter APIs > Lineage Filter REST APIs
  

Lineage Filter REST APIs

You can use the following Lineage Filter REST APIs to list, create, and delete lineage filters:
Data Provision REST API
Description
GET models/defaultLineageFilter
Lists the default lineage filter
POST models/defaultLineageFilter
Creates a default lineage filter
POST models/lineageFilter
Creates a lineage filter
GET models/lineageFilter/{id}
Lists a lineage filter definition
PUT models/lineageFilter/{id}
Updates a lineage filter definition
DELETE models/lineageFilter/{id}
Deletes a lineage filter definition

List the Default Lineage Filter

/models/defaultLineageFilter
API to list the default lineage filter.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/models/defaultLineageFilter
HTTP Method Type
GET

Response Codes

Code
Reason
200
Listed the default lineage filter
400
Missing or invalid parameter
401
Missing credentials
403
User does not have the required access permissions
404
Requested object not found
429
Rate limit for requests encountered

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/defaultLineageFilter" -H "accept: application/json"

Create a Default Lineage Filter

/models/defaultLineageFilter
API to create a default lineage filter. When you run the API, it overwrites the existing default lineage filter.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/models/defaultLineageFilter
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
lineageFilter
Required
The name of the default lineage filter.
Body
-

Response Codes

Code
Reason
200
Created the default lineage filter.
201
Created the default lineage filter
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
412
Conflicting edit detected.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X POST "http://<CatalogAdmin>:<port>/access/2/catalog/models/defaultLineageFilter" -H "accept: application/json" -H "Content-Type: text/plain" -d "\"string\""

Create a Lineage Filter

/models/lineageFilter
API to create a lineage filter facet.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/models/lineageFilter
HTTP Method Type
POST

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
lineageFilter
Required
Enter the lineage filter facet attribute parameters.
Body
-

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
excludeTypeFilter
Optional
The classes to exclude from the lineage filter facet.
String
Provide the following values:
  • - classes
  • - value
filterByDefault
Optional
Specifies whether the lineage filter facet is applied to all lineage queries.
Default is true.
Boolean
Provide one of the following values:
  • - true
  • - false
global
Optional
Ignore users and groups so that the facet is visible to all users.
Default is true.
String
-
leafFilter
Optional
The classes to include in the lineage filter facet.
String
Provide the following values:
  • - classes
  • - value
name
Required
The name of the facet.
String
-
owner
Optional
The user who owns the facet.
String
-
passThroughFilter
Optional
The classes to ignore in the lineage filter facet.
String
Provide the following values:
  • - classes
  • - value

Response Codes

Code
Reason
200
Updated the lineage filter facet
201
Created a lineage filter facet
400
Missing or invalid parameter
401
Missing credentials
403
User does not have the required access permissions
404
Requested object not found
412
Conflicting edit detected
429
Rate limit for requests encountered

Sample Call Using Curl

curl -X POST "http://<CatalogAdmin>:<port>/access/2/catalog/models/lineageFilter" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"excludeTypeFilter\": { \"classes\": [ \"string\" ] }, \"filterByDefault\": true, \"global\": true, \"leafFilter\": { \"classes\": [ \"string\" ] }, \"name\": \"string\", \"owner\": \"string\", \"passThroughFilter\": { \"classes\": [ \"string\" ] }}"

List a Lineage Filter Definition

/models/lineageFilter/{id}
API to list a lineage filter facet definition.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/models/lineageFilter/{id}
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the lineage filter facet.
Path
String

Response Codes

Code
Reason
200
Listed the lineage filter facet definition.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/lineageFilter/45345435" -H "accept: application/json"

Update a Lineage Filter

/models/lineageFilter/{id}
API to update a lineage filter.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/models/lineageFilter/{id}
HTTP Method Type
PUT

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of lineage filter facet.
Path
String
facet
Required
Enter the facet attributes.
Body
-
if-Match
Optional
Identify the ETag for the resource. Enterprise Data Catalog does not update the resource if the ETag for the resource has changed.
Header
String

Attribute Parameters

Parameter
Required or Optional
Description
Data Type
Values
excludeTypeFilter
Optional
The classes to exclude from the lineage filter facet.
String
Provide the following values:
  • - classes
  • - value
filterByDefault
Optional
Specifies whether the lineage filter facet is applied to all lineage queries.
Default is true.
Boolean
Provide one of the following values:
  • - true
  • - false
global
Optional
Ignore users and groups so that the facet is visible to all users.
Default is true.
String
-
leafFilter
Optional
The classes to include in the lineage filter facet.
String
Provide the following values:
  • - classes
  • - value
name
Required
The name of the facet.
String
-
owner
Optional
The user who owns the facet.
String
-
passThroughFilter
Optional
The classes to ignore in the lineage filter facet.
String
Provide the following values:
  • - classes
  • - value

Response Codes

Code
Reason
200
Updated the lineage filter facet
201
Created the lineage filter facet
400
Missing or invalid parameter
401
Missing credentials
403
User does not have the required access permissions
404
Requested object not found
412
Conflicting update detected
429
Rate limit for requests encountered

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/models/lineageFilter/45345" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"excludeTypeFilter\": { \"classes\": [ \"string\" ] }, \"filterByDefault\": true, \"global\": true, \"leafFilter\": { \"classes\": [ \"string\" ] }, \"name\": \"string\", \"owner\": \"string\", \"passThroughFilter\": { \"classes\": [ \"string\" ] }}"

Delete a Lineage Filter Definition

/models/lineageFilter/{id}
API to delete a lineage filter definition.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog//models/lineageFilter/{id}
HTTP Method Type
DELETE

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
id
Required
The ID of the lineage filter.
Path
String

Response Codes

Code
Reason
200
Deleted the lineage filter.
204
No content to display.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
412
Conflicting edit detected.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X DELETE "http://<CatalogAdmin>:<port>/access/2/catalog/models/lineageFilter/4534535" -H "accept: application/json"