SAP Knowledge Base Article - Public

3008355 - ToDoEntryV2 returns Null value for linkURL when querying categoryId = 14, 17 and 18

Symptom

When querying CategoryId ‘14, 17 or 18’ (workflow request) in entity ToDoEntryV2 it returns 'null' value for linkUrl.

This URL is required for users to approve and pending Workflow Requests.

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

Environment

  • SAP SuccessFactors HCM Suite
    • OData API

Reproducing the Issue

1. Run the following query in Postman

https://<API-Server>/odata/v2/TodoEntryV2?$top=10&$format=json&$filter=categoryId eq '14'&status eq '2'&$expand=userNav&$select=todoEntryId,categoryId,status,linkUrl,userNav/userId,userNav/defaultFullName,todoEntryName,categoryLabel,subjectId

2. Query returns 'null' value for linkUrl

Cause

All validations queried for the category 14 do not have the linkURL field populated.

According to OData API Developer Guide Category 14 asks to expand the wfRequestNav.

Resolution

To get the required URL to navigate to the pending workflow, please call the following query:

https://<API-Server>/odata/v2/TodoEntryV2?$top=10&$format=json&$filter=categoryId eq '14'&status eq '2'&$expand=userNav,wfRequestNav&$select=todoEntryId,categoryId,status,linkUrl,userNav/userId,userNav/defaultFullName,todoEntryName,categoryLabel,subjectId,wfRequestNav/url,wfRequestNav,status,wfRequestNav/wfRequestid

With this query we can return the URL under the url field, but not the linkUrl. linkUrl filed will still return 'null'

In the query above, we can see the url under another field expanded.

"https://salesdemo4.successfactors.com/sf/hrisworkflowapprovelink?workflowRequestId=V2-iXRdZSm9lZIzLrnwqi%2FF%2FQ%3D%3D&prevPage=HOME&company=SFPART038041&username=sfadmin"
 
 

Using this URL, it open in the browser:



Please Note: Check if the RBP  "Manage Workflows->Manage Workflow Requests" is enabled for this API user

Keywords

ToDoEntryV2, linkUrl, null, OData API, categoryId eq '14', wfRequest, RBP , KBA , LOD-SF-INT-ODATA , OData API Framework , LOD-SF-INT , Integrations , Problem

Product

SAP SuccessFactors HCM Suite all versions

Attachments

image.png
image.png
image.png
image.png
image.png