SAP Knowledge Base Article - Public

2890064 - Using the integration center tool to export the OData query and helping with your OData upserts - SuccessFactors HXM Suite

Symptom

You are building your OData upsert / POST and facing some issues regarding values passed in the payload, like picklists with option ID or external code.

You are trying to build OData queries / GET and export the queries to be used in REST tools.

This KBA will help you building queries in Integration center tool and exporting these queries to be used in other REST tools.

This can also be helpful to understand what is the correct payload that you will need to send while doing OData API Upsets.

Environment

  • SuccessFactors HCM HXM Suite
    • OData API
    • Integration center

Resolution

  1. Admin center > Integration center > click in "Create" button and select "Scheduled Simple File Output integration"
  2. Type the name of the entity in the top search bar, like EmpCompensation
  3. Select the fields that you want to see in your OData query later or the fields that you will use during your OData upsert
  4. Click in the tab "Configure Fields"
  5. Click in Save > "Export Integration Specification"
  6. Open the CSV file generated and go to the last line
  7. You will see some information like the following:
    • OData Query URL: /odata/v2/EmpCompensation?$select=startDate,userId,endDate,event,eventReason,payGrade,payGroup,payrollSystemId
  8. This information above can be used in any REST client to run your OData query
  9. In the OData query response, you will see how the fields are stored in the database. If you are doing OData Upserts, you may observe that some fields could have Option ID or External Code of picklists, etc.

The resolution steps above will help you to build your OData queries via Integration center and later using in REST tool client to see the results.

Keywords

HCM Suite, HXM, Integration Center, OData API, upserts, query, queries, IC, SuccessFactors, how to export OData query, odata/v2, Scheduled Simple File Output integration, Export Integration Specification , KBA , LOD-SF-INT , Integrations , LOD-SF-INT-INC , Integration Center , LOD-SF-INT-ODATA , OData API Framework , How To

Product

SAP SuccessFactors HXM Suite all versions