New API

Download as doc, pdf, or txt
Download as doc, pdf, or txt
You are on page 1of 7

OM

Dir 825

Dplink archer c5

NEELA VENI THATIKONDA 9550407452

OData API Dictionary

The OData API dictionary contains all the entities available in your instance, it
lists the allowed operations, the field (property name), the label as well as
telling you which fields are required or not. To view the OData dictionary,
you:1.

Navigate to the Admin Center and search for the OData API Data
Dictionary.2.

The OData API Data Dictionary is displayed.

Metadata as an entity

In order to get extra information, such as language labels, pick lists, beyond
what the standard OData metadata provides,

Success factors OData exposes metadata as an entity. The Success Factors


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.

What is an Entity?

Employee Central stores data in table structures which are known as entities.
Entities are grouped together in objects.

Employee Central entities let you create and manipulate employee data.
Navigations in an entity represent associations between entities.

Each entity can have the following properties:

1) Effective dating: Allows you to make scheduled changes to a record.

2) Business keys: Uniquely identifies an entity

3) Required/nullable attribute: Attribute set by the data model. For business


keys, Required is always set to TRUE.

4) Processing parameters for upsert: Both full purge and incremental purge
are supported.

What is an Employee Central OData API?

The Employee Central OData API exposes the Employee Central entities. These entities include

1) Foundation

2) Personal

3) Employment

4) MDF objects.

MDF Objects:

If an entity is based on MDF, the following operations are supported:


1

Metadata Query (as for the objects listed above)


1. Query

2. Merge/Replace

3. Delete

4. Upsert - Creates a record but unlike the operation PUT, you can choose between a full or incremental purge.

Effective Dated Query in OData


Employee Central API delivers parameters asOfDate, fromDate, and toDate for effective-dated entities so that you can query
the history or future records of an entity.

There are two ways to query effective-dated entities. You can use one of the following ways but not both in one query.
1
asOfDate query: Returns one single effective record as of the specified date. If no asOfDate is specified, the OData API uses
the current date of the query as asOfDate. For records that allow multiple changes per day, the record with the highest
sequence number is returned.

fromDate and toDate query (date range query): Returns records effective between the specified date range. With records that
allow multiple changes per day, the record with the highest sequence number is returned. You can use one or both of the
parameters in one query.
filter with toDate and fromDate :
Pagination

You can avoid lost or duplicated records by using cursor-based and snapshot-based pagination in
some of the Employee Central entities.

Cursor-Based Pagination

You can use this feature for the following Employee Central entities:

1. EmpJob
2. EmpEmployment

3. EmpCompensation

4. EmpPayCompRecurring
5. EmpPayCompNonRecurring
6. FOLocation

You might also like