SAP Knowledge Base Article - Public

2804150 - Unable to retrieve segment details through an API call

Symptom

Admin would like to retrieve segments information of the class and gets below error

Response Error::

{

"error": {
"code": null,
"message": "The property 'criteria', used in a query expression, is not defined in type 'com.sap.lms.odata.Segment'."
}
}

Environment

SuccessFactors Learning Management System (LMS)

Reproducing the Issue

In POSTMAN set API call to get information about the segment of class as below:

/learning/odatav4/public/admin/scheduledoffering-service/v1/Segments?$filter=criteria/scheduleID eq XXXXX

/learning/odatav4/public/admin/scheduledoffering-service/v1/Segments?$filter=criteria/segmentNumber eq 1

/learning/odatav4/public/admin/scheduledoffering-service/v1/Segments(XXX)

/learning/odatav4/public/admin/scheduledoffering-service/v1/Segments('XXX')

/learning/odatav4/public/admin/scheduledoffering-service/v1/Segments("XXX")

Resolution

As per confirmation from Product Management, we currently don't have an API to retrieve the class segment details.

Please contact Professional Services for such an API call or create an enhancement request.

See Also

2318897 - LMS ODATA Webservices Knowledge Support and Tips

2446471 - SAP SuccessFactors Learning OData Webservices - User Assistance Documentation link

2421933 - LMS - Scheduled Offering ODATA API -- Support Cancellation Reason (Product Enhancement b1702 - LRN-15619)

Keywords

Odata; API; com.sap.lms.odata.Segment; segments; class; odatav4 , KBA , LOD-SF-LMS-ODA , Web Services OData , LOD-SF-LMS , Learning Management System , Product Enhancement

Product

SAP SuccessFactors Learning all versions