Skip to end of metadata
Go to start of metadata

Purpose

The following WIKI links below will provide comprehensive user guides on how to implement many of our Learning OData APIs; providing typical use cases as well as some example calls. Whilst this guide will predominantly focus in on the more commonly used APIs, we will also provide examples and specifications of less commonly used services so as to provide a reference guide for customers and partners implementing our API. 

Overview

  • Background Knowledge

  • OAuth Token Server - Authorization

  • Common Use Cases of LMS OData API

  • Less commonly used Learning APIs/Microservices

Background

We will details some useful background knowledge on Learning OData API 'Background Knowledge' WIKI above, including (but not limited to): Throttling/Call Limiting, Pagination, Entity Arrays, Entities, Properties, Search filters, Unique identifiers, Olingo Libraries, Custom Columns and Typical Error Codes.

OAuth Authorization & Access Tokens

You obtain an OAuth Access Token at the beginning of every web service session by using the client secret that an SAP SuccessFactors Learning administrator generated for you (Either on their admin page or on OAuth Token Server page inside LMS Admin). Please view 'OAuth Token Server - Authorization' WIKI page above for steps on how to request an access token as well as details of some key implementation considerations.  

Common Use Cases

Some of our more commonly used APIs and use cases will be detailed in WIKI page 'Common Use Cases of LMS OData API' above. This WIKI will contain common use cases, API specifications as well as example calls (including sample API URL endpoints and payload bodies).

More Available Microservices

Some of our less commonly used APIs and use cases will be detailed in WIKI page 'Less commonly used Learning APIs/Microservices'  above. This WIKI will contain common use cases, API specifications as well as some example calls (including sample API URL endpoints and payload bodies).

Related Content

Related Documents

Learning OData API Reference Guide - SAP Help Portal

Related SAP Notes/KBAs

 

SAP KBA 12345: This is an example KBA link

(Use the following Hyperlink with SAP Note/KBA number at end: https://launchpad.support.sap.com/#/notes/123456)
__________________________________________________________________________________________________________

Use this structure to help you compose your contributions for WIKI and at the same time will ensure spelling and grammar.

  • No labels