3738664 - Is it possible to retrieve Alumni data from a custom MDF object in OData API?

You created a custom MDF with the Data Type of the external code set as "User".

You assigned Alumni user records to this custom MDF.

Is it possible to retrieve these records using the OData API?

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

• SAP SuccessFactors HCM Suite
  • OData API
  • Onboarding
  • MDF

1. Create the custom MDF object "cust_Attachment" with the externalCode Data Type set as User:
   
   
   
   
2. Assign an Alumni user to it:
   
   
   
   
3. Now, is it possible to get this data through the OData API?

Yes, that's possible.

Refer below to the query built based on the example shown above:
https://qacand-api.hcm.ondemand.com/odata/v2/cust_Attachment?$filter=externalCode eq '778'

It would be a regular query, no special filters.

You just need to ensure that the API user running the query has:

1. Either the admin or non-admin permission to view the MDF object.
   • The admin permission to view all MDF objects is: Metadata Framework > Admin access to MDF OData API
2. Permission to view Alumni users in the target population of the role granting the permission above.
   • This is granted in the first step when creating the role assignment:
     
     

alumni, mdf, custom, api, odata api, externalcode, data type, target population , KBA , LOD-SF-INT-MDF , Metadata Framework API (MDF) , LOD-SF-OBX-OFP-ALU , Alumni Access , How To