Question Re: Successfactors: Odata API to create a time off entry for an employee in Human Capital Management Q&A

Successfactors: Odata API to create a time off entry for an employee

Former Member — Fri, 12 May 2017 02:12:24 GMT

Hi,

We have a web application which needs to create a time off vacation entry for users in Successfactors. Obviously, we need to use SuccessFactors Odata APIs to do this. We are looking for the specific APIs that we can use to do the following:

1. Query by giving an employee number and get their time off balances

2. Create a time off request for a specific start date and end date and time off type.

Regards

Ravi

Re: Successfactors: Odata API to create a time off entry for an employee

former_member206574 — Fri, 26 May 2017 18:07:35 GMT

Hi Ravi,

Check the below entities for your queries.

1. Query by giving an employee number and get their time off balances

https://<hostname>/odata/v2/EmpTimeAccountBalance?$filter=userId eq '<userIdValue>' and timeAccountType eq '<timeTypevalue>'

above service will give you the total leaves for the current year in the property balance.

https://<hostname>/odata/v2/EmployeeTime?$filter=userId eq '<userIdValue>' and (timeType eq '<timeTypevalue>') and (startDate ge datetime'2017-01-01T00:00:00')

in response u can find the property deductionQuantity for the timeType. this is a list of records for the current year. sum all the deduction quantity from the response list.

balances = balance - (sum of deductionQuantity)

2. Create a time off request for a specific start date and end date and time off type.

https://<hostname>/odata/v2/EmployeeTime

Payload:

{ "__metadata" : { "uri" : "http://<hostname>/odata/v2/EmployeeTime", "type": "SFOData.EmployeeTime"}, "startDate": "/Date(1483920000000)/", "endDate": "/Date(1483920000000)/", "externalCode": "<some unique value>", "userIdNav": { "__metadata": { "uri": "https://<hostname>/odata/v2/User('<userId>')", "type": "SFOData.User" }}, "timeTypeNav": { "__metadata": { "uri": "https://<hostname>/odata/v2/TimeType('<timeType>')", "type": "SFOData.TimeType" } } }

Consider the property externalCode which should be unique value always like key parameter while creating.

Regards,

Venu

Re: Successfactors: Odata API to create a time off entry for an employee

siddharthrajora — Mon, 29 May 2017 18:09:06 GMT

also you can get using Integration center also, ie simple querying the data

Re: Successfactors: Odata API to create a time off entry for an employee

former_member217117 — Fri, 20 Oct 2017 06:31:32 GMT

HI Ravi,

Have you tried the solution provided by Venu? Did it work? Thanks

Re: Successfactors: Odata API to create a time off entry for an employee

KP-1 — Mon, 02 Apr 2018 09:52:30 GMT

Hi Venugopal,

I did try this and I am surprised by the results.

This query delivers the results that is expected, however, I am afraid I have to say, the Workflow doesnt get triggered at all.

Do you have anything specific in mind to make it work?

Thanks,

Kunjal

Re: Successfactors: Odata API to create a time off entry for an employee

former_member22925 — Sat, 08 Sep 2018 16:39:15 GMT

THANKS¡ Venugopal

Re: Successfactors: Odata API to create a time off entry for an employee

former_member603293 — Mon, 17 Jun 2019 09:06:36 GMT

Hi Venugopal,

I have same question with Kunjal.

How to trigger the workflow(approve the leave request etc.) by using this API?

Thanks. Kevin

Re: Successfactors: Odata API to create a time off entry for an employee

Former Member — Mon, 21 Oct 2019 08:22:53 GMT

Documentation provided by SAP-

https://help.sap.com/doc/7efdca36492e47c7b20ab92c4ca6323c/1908/en-US/SF_EC_OData_API_REF.pdf

API 1-https://<host>/odata/v2/EmpTimeAccountBalance?$filter=userId eq '3334343' and timeAccountType+in+'EL_Ind','SL_Ind','CL_Ind' &$format=json

Above API will give you the total available leaves as of today date.

API 2: https://<host>/odata/v2/EmployeeTime?$filter=(userId eq '3334343') and (approvalStatus eq 'APPROVED') and (timeType eq 'CL_Ind') and (startDate gt datetime'2019-10-19T00:00:00') &$format=json

Above API will give us list of approved leaves of an employee by passing user id and status Approved and Time Type And date greater than today date.

Get Total available leave balance for particular leave type:

Total Leave Balance=API 1(balance)- API 2 (sum of deductionQuantity)

Thanks

Priti

Re: Successfactors: Odata API to create a time off entry for an employee

former_member512458 — Tue, 28 Jan 2020 19:24:00 GMT

Hi Kunjal & Kevin,

In order to trigger workflow

please use following endpoint

POST https://<HOSTNAME>/odata/v2/upsert?workflowConfirmed=true&$format=json

{

"__metadata": { "uri": "https://<hostname>/odata/v2/EmployeeTime", "type": "SFOData.EmployeeTime" },

"startDate": "/Date(1484677800000)/",

"endDate": "/Date(1484739000000)/",

"externalCode":"<UNIQUE VALUE>",

"approvalStatus": "PENDING",

"userIdNav": { "__metadata": { "uri": "https://<hostname>/odata/v2/User('<USERID>')", "type": "SFOData.User" } },

"timeTypeNav": { "__metadata": { "uri": "https://<hostname>/odata/v2/TimeType('<TIMETYPE>')", "type": "SFOData.TimeType" } }

}

This will trigger workflow.

Try to use oAuth for this POST. If you use a technical user than make sure, it has no admin access to MDF oData API as below statement

The parameter has no impact on admin users with the Admin access to MDF OData API permission. If an admin user creates or changes a record for a workflow-enabled entity, no workflow is triggered and the record is saved as normal data.

https://help.sap.com/viewer/d599f15995d348a1b45ba5603e2aba9b/1911/en-US/886cdf72d3474996889d0b306d30c27c.html

Kind Regards,

Ravi

Re: Successfactors: Odata API to create a time off entry for an employee

Kshetrali — Fri, 16 Oct 2020 10:16:21 GMT

hello Ravi,

unable to open the link mentioned by you.

https://help.sap.com/viewer/d599f15995d348a1b45ba5603e2aba9b/1911/en-US/886cdf72d3474996889d0b306d30c27c.html

Kindly help with description or correct link.

Re: Successfactors: Odata API to create a time off entry for an employee

former_member48810 — Wed, 13 Jan 2021 11:57:04 GMT

how to query in bulk data abstraction for number of leaves

Re: Successfactors: Odata API to create a time off entry for an employee

lenastodal — Wed, 17 Feb 2021 17:04:31 GMT

Pankaj - Quick tip that might help you get an answer to your question quicker:
Please raise your question again as a new question and follow our rules of engagement: https://community.sap.com/resources/rules-of-engagement. The author of the original question is no longer active in the community and won't receive your query. With the help of our Q&A tutorial: https://developers.sap.com/tutorials/community-qa.html, you'll be able to prepare questions that draw responses from our members.
Thank you!

Re: Successfactors: Odata API to create a time off entry for an employee

souptiksom — Fri, 16 Jul 2021 04:17:53 GMT

Unable to do that. Please share the steps.

Re: Successfactors: Odata API to create a time off entry for an employee

former_member757322 — Mon, 19 Jul 2021 20:11:26 GMT

hai ravi,I am also facing same issue,please help me out

Re: Successfactors: Odata API to create a time off entry for an employee

Radoslav — Thu, 14 Oct 2021 13:50:45 GMT

This really helped me. The API documentation is terrifying 😄