Response Filters
Response Filters are created to get customized responses from specific methods. Filtering is the process of excluding elements from the responses before being returned to the calling developers. The elements that are selected from a sample response schema for a particular method are excluded from the responses. Filters are applied when they are added to methods while defining a Plan.
Response filters only works if the Content-Type header is set to application/json (for JSON responses) or application/xml (for XML responses).
The response filter pipeline now supports Brotli-compressed (Content-Encoding: br) and Deflate-compressed (Content-Encoding: deflate) backend responses, in addition to the existing Gzip support. When the backend returns a response with any of these encodings, the filtered response is returned without errors.
Response Filters are available only in the Advanced-Packager-enabled Portals. Contact [Boomi Account Representative] API Management Support for more information.
The following table describes the fields on the Response Filters page.
| Field | Description |
|---|---|
| Filter | Filter name. |
| Fields Excluded | Number of elements in the schema that are excluded from the response. |
| Methods Using Filter | Number of methods to which the filter is applied. |
| Created | Date and time when the filter was created. |
| Last Modified | Date and time when the filter was last updated. |
