Search filter API reference guide
This page describes the searchFilter endpoint.
POST /searchFilter
Save a new search filter.
Required Immuta permission: CREATE_FILTER
The following request saves a new search filter.
GET /searchFilter
Retrieve saved search filters.
The following request retrieves all saved search filters.
DELETE /searchFilter/{searchFilterName}
Delete a search filter by name.
Required Immuta permission: CREATE_FILTER
The following request deletes the Medical Claims search filter.
filter
array Includes facets to use in the search filter, such as searchText (the base search string for data sources/projects), tag, column, connectionString, schema, and type (type of models to search for: datasource or project).
Yes
name
string Name to be used for the search filter.
No
filter
array The facets used in the search filter, such as searchText (the base search string for data sources/projects), tag, column, connectionString, schema, and type (type of models used in the filter: datasource or project).
name
string The name of the search filter.
searchText
string A string used to filter returned saved filters. The query is executed with a wildcard prefix and suffix.
No
values
array Details regarding the search filters, including name, filter, searchText (the base search string for data sources/projects), tag, column, connectionString, schema, and type (type of models used in the filter: datasource or project).
searchFilterName
string The name of the specific search filter.
Yes
values
array Details regarding the search filters, including name, filter, searchText (the base search string for data sources/projects), tag, column, connectionString, schema, and type (type of models used in the filter: datasource or project).
curl \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
--data @example_payload.json
https://your-immuta-url.com/searchFilter{
"name": "Medical Claims",
"filter": {
"searchText": "",
"column": ["income_greater_than_50k"],
"type": "datasource",
"tag": ["Discovered.Entity.Medicare Number"]
}
}{
"name": "Medical Claims",
"filter": {
"searchText": "",
"column": ["income_greater_than_50k"],
"type": "datasource",
"tag": ["Discovered.Entity.Medicare Number"]
}
}curl \
--request GET \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://your-immuta-url.com/searchFilter{
"values": [{
"name": "States",
"filter": {
"type": "datasource",
"column": ["state"],
"searchText": ""
}
}]
}curl \
--request DELETE \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://your-immuta-url.com/searchFilter/Medical%20Claims{
"name": "Medical Claims",
"filter": {
"tag": ["Discovered.Entity.Medicare Number"],
"type": "datasource",
"column": ["income_greater_than_50k"],
"searchText": ""
}
}