Skip to main content

Filtering

Basics and examples of filtering in Proactis APIs

Filtering in REST API refers to the process of limiting the result set of an API request based on specific criteria. Filtering allows users of a REST API to retrieve only the data they need, and can be used to improve the performance of the API and reduce the amount of data transmitted over the network.

Query Parameters​

It filters data based on specific query parameter values. These parameters are added to the URL after a ? and separated by &. The value of the query parameter is used to filter data.

For example, consider an API endpoint that returns a list of suppliers. You can use query parameters to filter the suppliers based on specific criteria. Let's say you want to get all the suppliers which are active in Proactis. You can use a query parameter like online=true to filter the suppliers:

GET /suppliers/v1/{DomainId}}?online=true

The API would then return a list of all the suppliers which are active in Proactis.

Query parameters can be easily added to the URL, and can be combined in various ways to filter data based on complex conditions. What filters are supported depends on the API, the API documentation will show the possible filters.

Filtering supports string patterns and is case sensitive.

Contents