POST /api/database/views/{view_id}/filters/

Creates a new filter for the view related to the provided view_id parameter. When the rows of a view are requested, for example via the list_database_table_grid_view_rows endpoint, then only the rows that apply to all the filters are going to be returned. A filter compares the value of a field to the value of a filter. It depends on the type how values are going to be compared.

Servers

Path parameters

Name	Type	Required	Description
`view_id`	Integer	Yes	Creates a filter for the view related to the provided value.

Request headers

Name	Type	Required	Description
`ClientSessionId`	String	No	An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`ClientUndoRedoActionGroupId`	String	No	An optional header that marks the action performed by this request as having occurred in a particular action group.Then calling the undo/redo endpoint with the same ClientSessionId header, all the actions belonging to the same action group can be undone/redone together in a single API call.

Request body fields

Name	Type	Required	Description
`field`	Integer	Yes	The field of which the value must be compared to the filter value.
`group`	Integer	No	The id of the filter group the new filter will belong to. If this is null, the filter will not be part of a filter group, but directly part of the view.
`type`	String	Yes	Indicates how the field's value must be compared to the filter's value. The filter is always in this order `field` `type` `value` (example: `field_1` `contains` `Test`). `equal` - equal `not_equal` - not_equal `filename_contains` - filename_contains `files_lower_than` - files_lower_than `has_file_type` - has_file_type `contains` - contains `contains_not` - contains_not `contains_word` - contains_word `doesnt_contain_word` - doesnt_contain_word `length_is_lower_than` - length_is_lower_than `higher_than` - higher_than `higher_than_or_equal` - higher_than_or_equal `lower_than` - lower_than `lower_than_or_equal` - lower_than_or_equal `is_even_and_whole` - is_even_and_whole `date_equal` - date_equal `date_before` - date_before `date_before_or_equal` - date_before_or_equal `date_after_days_ago` - date_after_days_ago `date_after` - date_after `date_after_or_equal` - date_after_or_equal `date_not_equal` - date_not_equal `date_equals_today` - date_equals_today `date_before_today` - date_before_today `date_after_today` - date_after_today `date_within_days` - date_within_days `date_within_weeks` - date_within_weeks `date_within_months` - date_within_months `date_equals_days_ago` - date_equals_days_ago `date_equals_months_ago` - date_equals_months_ago `date_equals_years_ago` - date_equals_years_ago `date_equals_week` - date_equals_week `date_equals_month` - date_equals_month `date_equals_day_of_month` - date_equals_day_of_month `date_equals_year` - date_equals_year `date_is` - date_is `date_is_not` - date_is_not `date_is_before` - date_is_before `date_is_on_or_before` - date_is_on_or_before `date_is_after` - date_is_after `date_is_on_or_after` - date_is_on_or_after `date_is_within` - date_is_within `single_select_equal` - single_select_equal `single_select_not_equal` - single_select_not_equal `single_select_is_any_of` - single_select_is_any_of `single_select_is_none_of` - single_select_is_none_of `link_row_has` - link_row_has `link_row_has_not` - link_row_has_not `link_row_contains` - link_row_contains `link_row_not_contains` - link_row_not_contains `boolean` - boolean `empty` - empty `not_empty` - not_empty `multiple_select_has` - multiple_select_has `multiple_select_has_not` - multiple_select_has_not `multiple_collaborators_has` - multiple_collaborators_has `multiple_collaborators_has_not` - multiple_collaborators_has_not `user_is` - user_is `user_is_not` - user_is_not `has_value_equal` - has_value_equal `has_not_value_equal` - has_not_value_equal `has_value_contains` - has_value_contains `has_not_value_contains` - has_not_value_contains `has_value_contains_word` - has_value_contains_word `has_not_value_contains_word` - has_not_value_contains_word `has_value_length_is_lower_than` - has_value_length_is_lower_than `has_all_values_equal` - has_all_values_equal `has_empty_value` - has_empty_value `has_not_empty_value` - has_not_empty_value `has_any_select_option_equal` - has_any_select_option_equal `has_none_select_option_equal` - has_none_select_option_equal `has_value_lower` - has_value_lower `has_value_lower_or_equal` - has_value_lower_or_equal `has_value_higher` - has_value_higher `has_value_higher_or_equal` - has_value_higher_or_equal `has_not_value_higher_or_equal` - has_not_value_higher_or_equal `has_not_value_higher` - has_not_value_higher `has_not_value_lower_or_equal` - has_not_value_lower_or_equal `has_not_value_lower` - has_not_value_lower `has_date_equal` - has_date_equal `has_not_date_equal` - has_not_date_equal `has_date_before` - has_date_before `has_not_date_before` - has_not_date_before `has_date_on_or_before` - has_date_on_or_before `has_not_date_on_or_before` - has_not_date_on_or_before `has_date_on_or_after` - has_date_on_or_after `has_not_date_on_or_after` - has_not_date_on_or_after `has_date_after` - has_date_after `has_not_date_after` - has_not_date_after `has_date_within` - has_date_within `has_not_date_within` - has_not_date_within Possible values: `"higher_than_or_equal"` `"date_before"` `"has_value_contains"` `"single_select_equal"` `"has_value_lower_or_equal"` `"date_equals_years_ago"` `"has_all_values_equal"` `"multiple_select_has_not"` `"has_not_value_higher"` `"single_select_is_any_of"` `"single_select_is_none_of"` `"date_is_before"` `"has_value_higher_or_equal"` `"link_row_has_not"` `"higher_than"` `"date_within_weeks"` `"date_is_on_or_after"` `"has_date_equal"` `"has_value_contains_word"` `"has_not_value_higher_or_equal"` `"has_value_lower"` `"link_row_contains"` `"user_is_not"` `"not_empty"` `"date_is_after"` `"multiple_collaborators_has_not"` `"not_equal"` `"date_after_or_equal"` `"lower_than_or_equal"` `"has_not_date_on_or_after"` `"has_none_select_option_equal"` `"has_not_value_lower"` `"is_even_and_whole"` `"has_value_equal"` `"boolean"` `"empty"` `"has_date_on_or_after"` `"date_before_today"` `"has_any_select_option_equal"` `"has_not_value_lower_or_equal"` `"has_empty_value"` `"date_is"` `"contains"` `"date_not_equal"` `"date_is_on_or_before"` `"contains_word"` `"date_within_months"` `"lower_than"` `"length_is_lower_than"` `"has_not_value_contains_word"` `"date_equals_today"` `"has_value_length_is_lower_than"` `"has_not_date_equal"` `"equal"` `"date_equals_days_ago"` `"multiple_collaborators_has"` `"has_date_after"` `"has_not_date_within"` `"has_date_on_or_before"` `"filename_contains"` `"files_lower_than"` `"has_not_date_before"` `"date_is_not"` `"has_not_date_on_or_before"` `"link_row_has"` `"date_equals_month"` `"user_is"` `"has_not_value_contains"` `"date_equals_year"` `"date_before_or_equal"` `"single_select_not_equal"` `"has_file_type"` `"date_after_days_ago"` `"date_equals_week"` `"date_after_today"` `"link_row_not_contains"` `"has_not_empty_value"` `"date_equal"` `"doesnt_contain_word"` `"date_after"` `"multiple_select_has"` `"has_not_date_after"` `"date_within_days"` `"has_date_within"` `"has_not_value_equal"` `"date_is_within"` `"contains_not"` `"has_value_higher"` `"date_equals_day_of_month"` `"date_equals_months_ago"` `"has_date_before"`
`value`	String	No	The filter value that must be compared to the field's value.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.