HR API Filter Query Parameter
- Case sensitivity
- Filtering on multiple values
- Quotes are significant characters
- Partial String Searches
Filter results of query using the filter query parameter family .
Case sensitivity
The attribute name is case-sensitive (example: salaryGrade ) but the value is not (example: grade and GRADE will match Grade ).
Filtering on multiple values
Multiple values can be included in a filter by using a comma as a delimiter, which will execute an \"OR\" query for the included values (e.g. /supervisoryOrganizations?filter[supervisoryOrganizationType]=Department,Division will find supervisory organizations that have the supervisoryOrganizationType of Department or Division).
There is a limit of 10 values per filter.
Multiple filters for the same attribute cannot be sent in a single request (e.g. /supervisoryOrganizations?filter[supervisoryOrganizationType]=Department&filter[supervisoryOrganizationType]=Division ). Instead, use a single filter with comma-separated values.
Quotes are significant characters
Quotes are significant characters and should only be used if they're intended to be used in the filter value.
Returns no values: filter[supervisoryOrganizationType]='Division' Works: filter[supervisoryOrganizationType]=Division
Partial String Searches
Filters can also be used to facilitate partial string searches. For this feature, prefix the value with one of the supported keywords followed by a : . For example /supervisoryOrganizations?filter[name]=STARTS_WITH:University , will return results for supervisoryOrganizations with name that starts with University .
You can also combine multiple operations on separate values. For example: filter[name]=STARTS_WITH:University,STARTS_WITH:Office,ENDS_WITH:Chancellor,computer science , will return results for supervisoryOrganizations with name that starts with University , starts with Office , ends with Chancellor , or matches computer science .
Supported operations are [ STARTS_WITH , CONTAINS , ENDS_WITH ].