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 |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/models/defaultLineageFilter |
HTTP Method Type | GET |
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 |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/models/defaultLineageFilter |
HTTP Method Type | POST |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
lineageFilter | Required | The name of the default lineage filter. | Body | - |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/models/lineageFilter |
HTTP Method Type | POST |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
lineageFilter | Required | Enter the lineage filter facet attribute parameters. | Body | - |
Parameter | Required or Optional | Description | Data Type | Values |
---|---|---|---|---|
excludeTypeFilter | Optional | The classes to exclude from the lineage filter facet. | String | Provide the following values:
|
filterByDefault | Optional | Specifies whether the lineage filter facet is applied to all lineage queries. Default is true. | Boolean | Provide one of the following values:
|
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:
|
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:
|
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 |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/models/lineageFilter/{id} |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the lineage filter facet. | Path | String |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/models/lineageFilter/{id} |
HTTP Method Type | PUT |
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 |
Parameter | Required or Optional | Description | Data Type | Values |
---|---|---|---|---|
excludeTypeFilter | Optional | The classes to exclude from the lineage filter facet. | String | Provide the following values:
|
filterByDefault | Optional | Specifies whether the lineage filter facet is applied to all lineage queries. Default is true. | Boolean | Provide one of the following values:
|
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:
|
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:
|
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 |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog//models/lineageFilter/{id} |
HTTP Method Type | DELETE |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the lineage filter. | Path | String |
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. |