Skip to content

You are viewing documentation for Immuta version 2023.4.

For the latest version, view our documentation for Immuta SaaS or the latest self-hosted version.

cancel

Search Filter API Reference Guide

This page describes the searchFilter endpoint.

Note

Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.

Search filter workflow

  1. Save a new search filter.
  2. Search for saved search filters.
  3. Delete a search filter.

Save a new search filter

Endpoint

Method Path Purpose
POST /searchFilter Save a new search filter.

Query Parameters

None.

Payload Parameters

Attribute Description Required
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

Response Parameters

Attribute Description
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.

Request example

The following request saves a new search filter.

curl \
    --request POST \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    --data @example_payload.json
    https://your-immuta-url.com/searchFilter

Payload example

{
  "name": "Medical Claims",
  "filter": {
    "searchText": "",
    "column": ["income_greater_than_50k"],
    "type": "datasource",
    "tag": ["Discovered.Entity.Medicare Number"]
  }
}

Response example

{
  "name": "Medical Claims",
  "filter": {
    "searchText": "",
    "column": ["income_greater_than_50k"],
    "type": "datasource",
    "tag": ["Discovered.Entity.Medicare Number"]
  }
}

Search saved search filters

Endpoint

Method Path Purpose
GET /searchFilter Retrieve saved search filters.

Query Parameters

Attribute Description Required
searchText string A string used to filter returned saved filters. The query is executed with a wildcard prefix and suffix. No

Response Parameters

Attribute Description
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).

Request example

The following request retrieves all saved search filters.

curl \
    --request GET \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    https://your-immuta-url.com/searchFilter

Response example

{
  "values": [{
    "name": "States",
    "filter": {
      "type": "datasource",
      "column": ["state"],
      "searchText": ""
    }
  }]
}

Delete a search filter

Endpoint

Method Path Purpose
DELETE /searchFilter/{searchFilterName} Delete a search filter by name.

Query Parameters

Attribute Description Required
searchFilterName string The name of the specific search filter. Yes

Response Parameters

Attribute Description
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).

Request example

The following request deletes the Medical Claims search filter.

curl \
    --request DELETE \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer dea464c07bd07300095caa8" \
    https://your-immuta-url.com/searchFilter/Medical%20Claims

Response example

{
  "name": "Medical Claims",
  "filter": {
    "tag": ["Discovered.Entity.Medicare Number"],
    "type": "datasource",
    "column": ["income_greater_than_50k"],
    "searchText": ""
  }
}