API design is becoming a core pillar of API product strategy regardless if the API is public or used internally. Good API design improves the overall Developer Experience. It provides the
filter the parameter to fetch your content with endless possibilities!
- Used to filter result set and narrow down result set or drill down into the results
- Controlled via special input parameter called “filters” containing JSON structure inside the value
- Multiple filters can be chained together inside the same JSON structure, simply add another filter field definition after the first one
- Multiple value formats for each key are supported inside JSON structure including simple string/scalar, array, or associative array ( key => value )
A practical examples of a filter:
The filter query parameter is used to filter items in a resource collection to return a subset of resources in response. The subset includes only those resources that satisfy the parameter value specified in the query
Example 1: To return results for 1 transaction record from Sales Transactions
Example 2: To return results from a field name in the following request :
Example 3: In this scenario, more than one field is passed in the filtering parameter
Example 4: In this scenario, more than one field is passed in the filtering parameter but operator sign checks for greater than (gt) field value
Example 5: In this scenario, the filtering parameter is a little complex expression but operator sign checks for greater than (gt) field value with subfields.
Example 6: In this, the complex expression is passed in the filtering parameter with grouping open & close () and OR condition to check if not equal null
Example 7: In this scenario, using expand – will retrieve PayeeId , Position Name and Period with
filtering parameter becomes a little complex expression but will filter payment results only for single PayeeId
Please feel free to reach out in case of any clarifications/API development work for your Project
Kindly share this blog with your friends below the icons.