Active Filter Set

You can specify the filter set you want to apply to your request by using the filterSetId query parameter. The active filter set determines what data can be viewed or modified.

Note:

In OpenAir, filter sets define what data the authenticated user has permission to view or update. Each user has at least one filter set assigned — the primary filter set. If more than one filter set are assigned to a user, that user can set an filter set as active to control the data available in OpenAir. For more information, see Filter Sets Overview.

The filterSetId is the internal ID of the filter set to be applied.

When specified, the request is successful only if the data is accessible when the specified filter set is active in OpenAir. For example:
- A GET request only returns an object if the object can be accessed when the specified filter set is active.
- A POST request only creates an object if all items associated with this object can be accessed when the specified filter set is active.
- A PUT request only updates an object if the object and all the updated object properties can be accessed when the specified filter set is active.
- A DELETE request only deletes an object if the object can be accessed when the specified filter set is active.
Otherwise and by default, the primary filter set associated with the user who authorized the application is applied.

Important:

Review the following guidelines:

The filter set with the specified internal ID must exist and must be associated with the user who authorized the application as per the access token.
If the request concerns multiple objects, the requests returns, creates, updates or deletes only the objects that can be viewed or modified when the specified filter set is active. In the case of POST, PUT, and DELETE requests, the REST API returns the HTTP response code 207 Multiple statuses returned. See also Errors.
Filter sets may overlay with other access control features such as role permissions, and form permissions, for example.