SAP Knowledge Base Article - Public

2980747 - Unable to GET program details in Learning Plan OData API - 2H 2020 [LMS]

Symptom

Unable to retrieve program details in the Learning Plan OData API: “learning/odatav4/public/user/learningPlan/v1/”

Environment

SAP SuccessFactors Learning

Cause

“ProgramDetails” is only available in $expand mode within “UserTodoLearningItems” Entity Set.

Resolution

An example of the correct endpoint for retrieving program details (including: sourceID, thumbnailURI and ProgramDeeplink) from a user's ToDo items in their Learning Plan is as follows:

"/learning/odatav4/public/user/learningPlan/v1/UserTodoLearningItems?$filter=criteria/includeDeeplink eq true&$expand=programDetail&$format=json"

Additional Information:

  • Further enhancements were only made to UserToDoLearningItems in 2H 2020 Release which allows you to filter on sourceID or itemTypeID.
    • For example: "/learning/odatav4/public/user/learningPlan/v1/UserTodoLearningItems?$filter=criteria/sourceID eq "Skillsoft" and criteria/itemTypeID eq "TRNG""
  • From 2H 2020 Release property "thumbnailURI" is now returning in the UserToDoLearningItems Entity Set (this property was previously only available in LearningItemDetails Entity Set).

This relates to 2H2020 product enhancement: Learning Plan API Enhancements

Keywords

SAP, SuccessFactors, Learning, LMS, Learning OData API, Learning Plan API,  UserToDoLearningItems, user/learningPlan/v1/UserTodoLearningItems, $expand mode, b2011 release , KBA , LOD-SF-LMS-ODA , Web Services OData , Problem

Product

SAP SuccessFactors Learning all versions