Viewfilter

A view filter [Viewfilter] is a collection of user-defined criteria that can be used to filter list data.

—	XML	SOAP	REST	Database table
Object	`Viewfilter`	`oaViewfilter`	—	`viewfilter`
Supported Commands	`Read`	`read()`	—	—

—

XML

SOAP

REST

Database table

Object

Viewfilter

oaViewfilter

—

viewfilter

Supported Commands

Read

read()

—

The Viewfilter object has the following properties:

XML / SOAP	Database	Description
`action`	—	[Read-only] The filter action.
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`fields`	—	[Read-only] Comma delimited list of fields.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by OpenAir.
`label`	`label`	[Read-only] The name given to this filter. It appears in the Filter: drop-down list.
`limit_values`	—	[Read-only] For permission rule with action set to “limit values”, the comma-separated list of limit values for each limited field, one field per line. If limit values correspond to entity names on the UI, the internal IDs for these entities are returned. For example: `_project_stage_id:"3","4" currency:"USD","GBP" _custom_RF_cf_Project_dropdown:"dropdown_value2","dropdown_value3" _custom_RF_cf_Project_pick_list:"2"`
`match_all`	`match_all`	[Read-only] A 1/0 field. 1 = if all rules met. 0 = if rules must be met.
`name`	`name`	[Read-only] The internal name of the list or calendar this filter is applied to.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.
`userid`	`userid`	[Read-only] The user who created this filter.

XML / SOAP

Database

Description

action

—

[Read-only] The filter action.

created

[Read-only] Time the record was created. See Date Fields.

fields

—

[Read-only] Comma delimited list of fields.

id

[Read-only] Unique ID. Automatically assigned by OpenAir.

label

[Read-only] The name given to this filter. It appears in the Filter: drop-down list.

limit_values

—

[Read-only] For permission rule with action set to “limit values”, the comma-separated list of limit values for each limited field, one field per line. If limit values correspond to entity names on the UI, the internal IDs for these entities are returned. For example:

                    _project_stage_id:&quot;3&quot;,&quot;4&quot;
currency:&quot;USD&quot;,&quot;GBP&quot;
_custom_RF_cf_Project_dropdown:&quot;dropdown_value2&quot;,&quot;dropdown_value3&quot;
_custom_RF_cf_Project_pick_list:&quot;2&quot;

match_all

[Read-only] A 1/0 field. 1 = if all rules met. 0 = if rules must be met.

name

[Read-only] The internal name of the list or calendar this filter is applied to.

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

userid

[Read-only] The user who created this filter.