Skip to Content
Product Information
Author's profile photo Naresh Purohit

EC ODATA API for Workflow pending data

Employee data is one of the most requested data across the organization and systems. The consumer systems are not only limited to Payroll, benefits and time management but also extend to core ERP, CRM, SRM IDM and GRC etc. We always strives to provide the complete HR data to disparate systems via our powerful APIs.

You can find details of of our existing ODATA APIs here. Apart from core personal and employment information we also have extensive APIs for extracting workflow information. It is already possible to extract the details regarding existing workflows in EC including status and steps using wfRequest and EmpWFRequest entity. It is also possible to take multiple actions on workflow including approval and rejection via existing function imports.

The missing link for workflow in case of EC person and employment entities is the pending data in a workflow which is not yet approved/rejected. In b1711 we have provided an Beta API to extract this pending data. This feature has been requested by multiple customers and partners especially for UI extension usecase. This API will allow you to read workflow for following entities

Type Involve entities
ESS PerPerson
PerPersonal
PerPersonRelationship
PerAddressDEFLT
PerNationalId
MSS EmpJob
EmpJobRelationships
EmpCompensation
EmpPayCompRecurring
EmpPayCompNonRecurring
EmpEmployment
EmpEmploymentTermination

 

Like other workflow APIs, pending workflow API is also a function import. You can call it using post method, the API call look like

https://<API URL Host>/odata/v2/beta/getWorkflowPendingData?wfRequestId=<wfRequestID>L

where WfRequesID is the workflow request ID which you can also get via WfRequest API.

As a pre-requisite you need to turn the provisioning switch “

  • Old Value
  • New Value
  • Field ID
  • Field Label
  • Paycomponent (specific to paycomponent)

A sample response for a location change workflow is below:

 

 

In case of feedback or question, please feel free to use comment section.

 

Update: API is available as GA, you can find the documentation here

Assigned tags

      9 Comments
      You must be Logged on to comment or reply to a post.
      Author's profile photo Ruchi Tandon
      Ruchi Tandon

      Excellent Blog Naresh. Can we use this in Integration Center to build user reports for the customer?

       

      Author's profile photo Ruchi Tandon
      Ruchi Tandon

      Thanks Naresh, so when it is in GA we can see it then. Also do you know when will go GA with this API.

       

      Author's profile photo Naresh Purohit
      Naresh Purohit
      Blog Post Author

      Update: API is available as GA, you can find the documentation here

      Author's profile photo Kay Loehmann
      Kay Loehmann

      Would be interesting for me too! When does it reach GA?

      Author's profile photo Thejus Prakash
      Thejus Prakash

      Well written and quiet handy, any update on GA Naresh?

      Author's profile photo Naresh Purohit
      Naresh Purohit
      Blog Post Author

      Update: API is available as GA, you can find the documentation here

      Author's profile photo Niels Stockfleth
      Niels Stockfleth

      Hi Naresh, it seems the getWorkflowPendingData API is now officially supported. The ODATA return value looks a bit different, It now returns additional properties like entityName and fieldName. Is there any official API documentation available? Is it possible to translate some properties, e.g. for title and fieldName?

      Thanks!

      Author's profile photo Naresh Purohit
      Naresh Purohit
      Blog Post Author

      You can find the documentation here

      Author's profile photo Zeba Shah
      Zeba Shah

      Hi,

       

      can we take actions on workflow including approval and rejection without  function imports. I'm trying to approve the requests in CPI with one common user , It does not allow any other user to approve the request apart from who is responsible to take actions .Please let me know if there is a way how we can approve the request using POST operation .