SAP Knowledge Base Article - Public

2396714 - Odata API: Workflow not triggered from business rule when creating MDF entries via API call


  • Workflow not getting triggered when adding MDF entries via API call
  • Workflow on business rules not getting triggered on MDF when creating data via API call

"Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental."


  • SAP SuccessFactors HCM Suite: Odata API
  • SAP SuccessFactors HCM Suite: Metadata Framework
  • SAP SuccessFactors HCM Suite: Business Rules
  • SAP SuccessFactors HCM Suite: MDF Workflows

Reproducing the Issue

  1. Add a business rule that will trigger a workflow on the MDF Object
  2. Create new entries via Odata API Call
  3. Check the data created for a pending workflow approval request


If the user creating the entry for the MDF object via API call has access to Admin access to MDF OData API granted, then as per the standard behavior for the admin users Workflow execution will be skipped.


When an MDF object is associated with a workflow and if an instance is created via OData API, the workflow may not be triggered and this is a expected behavior if the user is MDF OData Admin .

  • If the user if MDF OData Admin workflow won't be triggered.
  • If the user not MDF OData Admin workflow will be triggered.

This is controlled in MDF OData layer. When creating a MDF entity via Odata API the workflow is called, but gives the follow error message:


<message lang="en-US">In order to trigger workflow, please set the 'workflowConfirmed' flag to true!</message>

This is because there is a step which has been skipped. When the user does a manual trigger from the UI, there's a pop-up for workflow and user must confirm that.

Correspondingly in Odata, workflowConfirmed should be set as true to simulate that operation. Since MDF Workflow can be triggered generically on any MDF entity, every MDF OData entity has this parameter. The above error message will not happen if the requester set 'workflowConfirmed' flag to true

Follow the steps below to check if the user is a MDF Odarta Admin:

  1. Login to the instance and navigate to Manage Permission Roles
  2. Go to the assigned Permission Role for the user that is making the API call
  3. Navigate to Administrator Permissions category --> Metadata Framework



MDF, Metadata Framework, Odata API, Business Rules, Workflows, API call , KBA , LOD-SF-INT-API , API & Adhoc API Framework , LOD-SF-MDF-API , OData APIs & Integrations , Problem


SAP SuccessFactors HXM Core all versions