1 of 1

Search Filters

This page describes the searchFilter endpoint.

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

Search filter workflow

Save a new search filter.
Search for saved search filters.
Delete a search filter.

Save a new search filter

POST /searchFilter

Save a new search filter.

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

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

GET /searchFilter

Retrieve saved search filters.

Query parameters

Response parameters

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

DELETE /searchFilter/{searchFilterName}

Delete a search filter by name.

Query parameters

Response parameters

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": ""
  }
}

Search Filters

This page describes the searchFilter endpoint.

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

Save a new search filter

POST /searchFilter

Save a new search filter.

Payload parameters

Attribute

Description

Required

Response parameters

Attribute

Description

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

GET /searchFilter

Retrieve saved search filters.

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

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

DELETE /searchFilter/{searchFilterName}

Delete a search filter by name.

Query parameters

Attribute

Description

Required

Response parameters

Attribute

Description

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": ""
  }
}

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

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

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