SAP Knowledge Base Article - Public

2755175 - How to retrieve more information of entities - SuccessFactors OData API

Symptom

In order to get extra information, such as language labels, picklists, beyond what the standard OData metadata provides, SuccessFactors OData exposes metadata as an entity.

Environment

SuccessFactors BizX - all versions.

Resolution

Metadata as an entity:

The SuccessFactors OData API exposes an entity named 'Entity'. Its properties are exposed as complex type value embedded in the response body of 'Entity'. Different forms of metadata can thus be exposed without changing the standard OData metadata format. You can access the new metadata just like you would access a regular entity. In addition, it supports a simple filter to output metadata of a specific entity or a group of entities.

Sample API Calls
  • The following API call allows you the access the entire metadata for your instance:

https://<hostname>/odata/v2/$metadata

  • The following API call shows you how to access the metadata for only the User entity:

https://<hostname>/odata/v2/Entity('User')?$format=json

  • The following API call shows you how to access the metadata for the User and Photo entities:

https://<hostname>/odata/v2/User,Photo/$metadata

  • You can use the same URL to query User entity data:

https://<hostname>/odata/v2/User,Photo/User?$format=json&$filter=userId eq ‘example’

See Also

find more details in the handbook = SAP SuccessFactors HCM Suite OData API: Reference Guide

Keywords

$metadata; metadata as entity; OData call; more information of entities; , KBA , LOD-SF-INT , SF Integrations - EC Payroll, Boomi/ HCI, API , LOD-SF-INT-ODATA , OData API Framework , How To

Product

SAP SuccessFactors HCM Suite all versions