SAP Knowledge Base Article - Public

2569829 - Is it possible to make some field filterable in OData API?

Symptom

You are trying to filter a field using OData API or Integration Center and you are not being able to:

  • In Integration Center, the field doesn't appear in the filter selection tab (Filter and Sort).
  • In OData API itself, you are facing the error below:
    "[COE0003]Bad property expression: <fieldname>; <fieldname> is not filterable"

Is it possible to change this field properties and make it filterable?

Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental.

Environment

  • SAP SuccessFactors HXM Suite
    • Integration Center
    • OData API

Cause

If you are unable to select a field in filters of Integration Center or OData API, navigate to OData API Data Dictionary tool and select the entity name. Now look for the corresponding field value under sap:filterable column, you'll be able to confirm if the field is filterable or not (it will show filterable=true/false):

  • For all the fields of an API entity for which "sap:filterable" column value has been set as "true", it can be used as a filter.
  • For all the fields set to "false", the field cannot be used as a filter.

filterable.png

Resolution

You can evaluate to change the configuration of that field through the Data Model of your instance or through some configuration in Provisioning, however this depends on the API entity which that field is is maintained on. For example, all Employee Central entities are hardcoded, so it is not possible to change it for those entities. Fields from User entity also can't have their filterable property changed.

However there are some entities that can have their custom fields changed to filterable, for example the API entities from Recruiting module: KBA 2538333.

On Integration Center you can use a workaround to filter using non-filterable fields, refer to the KBA 2729338.

If you judge that a specific non-filterable field should be updated with the possibility of choosing between filterable=true/false, it is recommended for you to raise an enhancement request in SAP influence website so the same can be considered in future releases.

 

See Also

 

Keywords

Filterable, Integration Center, OData API, SuccessFactors Employee Central, filter, field, IC SF, HCM Suite, rcm, recruiting, user, non-filterable, non, , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT , Integrations , LOD-SF-INT-API , API & Adhoc API Framework , LOD-SF-INT-INC , Integration Center , How To

Product

SAP SuccessFactors HCM suite all versions