sap.successfactors.litmos
Module sap.successfactors.litmos
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_sap.successfactors.litmos_1.3.1.png)
ballerinax/sap.successfactors.litmos Ballerina library
Overview
This is a generated connector for SAP SuccessFactors Litmos API v1.0 OpenAPI specification.
Litmos is a cloud-based solution that unifies virtual, classroom, mobile, and social learning. Our solutions empower training departments, sales and service leaders, safety and compliance managers, and HR teams to collaborate, author, globally distribute, and track web-based training courses, as well as schedule and track instructor-led courses. It automates formerly burdensome tasks so that teams can focus their energy on aligning training with the company's strategic agenda.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create and configure an API key credentials by following this guide.
Clients![](/images/permalink.svg)
sap.successfactors.litmos: Client![](/images/permalink.svg)
This is a generated connector for SAP SuccessFactors Litmos API v1.0 OpenAPI specification. Litmos is a cloud-based solution that unifies virtual, classroom, mobile, and social learning. Our solutions empower training departments, sales and service leaders, safety and compliance managers, and HR teams to collaborate, author, globally distribute, and track web-based training courses, as well as schedule and track instructor-led courses. It automates formerly burdensome tasks so that teams can focus their energy on aligning training with the company's strategic agenda.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials. Create and configure an API key credentials by following this guide.
init (ApiKeysConfig apiKeyConfig, string serviceUrl, ConnectionConfig config)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- serviceUrl string - URL of the target service
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
getAchievements![](/images/permalink.svg)
function getAchievements(string 'source, string? format, int? 'limit, int? 'start, string? sort, string? dir, string? search, string? since) returns Achievements|error
Get Achievements
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- sort string? (default ()) - Field used to sort the records
- dir string? (default ()) - Direction to sort the records
- search string? (default ()) - String value used to the filter the records
- since string? (default ()) - Date-time
Return Type
- Achievements|error - Success.
getaListofRecentUserImportJobs![](/images/permalink.svg)
function getaListofRecentUserImportJobs(string 'source, string? format, int? 'start, int? 'limit) returns UserBulkImports|error
Get a list of recent user import jobs
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'start int? (default ()) - Record number where paging starts
- 'limit int? (default ()) - Total records to return (max 1000)
Return Type
- UserBulkImports|error - Success.
bulkImportUsers![](/images/permalink.svg)
function bulkImportUsers(string 'source, string contentType, UserImports payload, string? format, boolean? sendmessage, boolean? skipfirstlogin) returns UserBulkImport|error
Bulk import user records
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload UserImports -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- sendmessage boolean? (default ()) - set to "True" to send login emails to new users
- skipfirstlogin boolean? (default ()) - set to "True" to have users skip setting a password after logging in
Return Type
- UserBulkImport|error - Success.
gettheStatusofaUserImportJob![](/images/permalink.svg)
function gettheStatusofaUserImportJob(string bulkImportId, string 'source, string? format) returns UserBulkImport|error
Get the status of a user record import
Parameters
- bulkImportId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- UserBulkImport|error - Success.
gettheUserImportErrors![](/images/permalink.svg)
function gettheUserImportErrors(string bulkImportId, string 'source, string? format, int? 'limit, int? 'start, boolean? isAPI) returns InlineResponse200|error
Get the list of user errors for an import
Parameters
- bulkImportId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- isAPI boolean? (default ()) - Set to "false" to fetch import errors for an import performed from the user interface. Do not include the parameter unless the value is set to "false".
Return Type
- InlineResponse200|error - Success.
bulkImportCourses![](/images/permalink.svg)
function bulkImportCourses(string 'source, string contentType, CourseImports payload, string? format) returns CourseBulkImport|error
Bulk import course records
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload CourseImports -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- CourseBulkImport|error - Success.
getaListofCollections![](/images/permalink.svg)
function getaListofCollections(string 'source, string? format, int? 'limit, int? 'start) returns Collections|error
Get a list of collection records
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- Collections|error - Success.
createaCollection![](/images/permalink.svg)
function createaCollection(string 'source, string contentType, Collection payload, string? format) returns Collections|error
Create a Collection
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Collection -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- Collections|error - Success.
createaCollectionListing![](/images/permalink.svg)
function createaCollectionListing(string 'source, string contentType, Listing payload, string? format) returns Listing|error
Create a Collection Listing
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Listing -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getCollectionListings![](/images/permalink.svg)
function getCollectionListings(string collectionId, string 'source, string? format, int? 'limit, int? 'start) returns Listings|error
Get Collection Listings
Parameters
- collectionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
getUsersAddedtoaListing![](/images/permalink.svg)
function getUsersAddedtoaListing(string listingId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns ListingUsers|error
Get users added to a Listing
Parameters
- listingId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
Return Type
- ListingUsers|error - Success.
postUserstoaListing![](/images/permalink.svg)
function postUserstoaListing(string listingId, string 'source, string contentType, Users payload, string? format) returns Response|error
Add users to a Listing
Parameters
- listingId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Users -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
deleteaUserfromaListing![](/images/permalink.svg)
function deleteaUserfromaListing(string listingId, string userId, string 'source, string contentType, string? format) returns Response|error
Delete a User from a Listing
Parameters
- listingId string -
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getTeamsAddedtoaListing![](/images/permalink.svg)
function getTeamsAddedtoaListing(string listingId, string 'source, string? format, int? 'limit, int? 'start) returns Teams|error
Get Teams Added to a Listing
Parameters
- listingId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
postaTeamtoaListing![](/images/permalink.svg)
function postaTeamtoaListing(string listingId, string teamId, string 'source, string contentType, string? format) returns Response|error
Add a Team to a Listing
Parameters
- listingId string -
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
removeATeamFromListing![](/images/permalink.svg)
function removeATeamFromListing(string listingId, string teamId, string 'source, string contentType, string? format) returns Response|error
Remove a Team from a Listing
Parameters
- listingId string -
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
addCoursestoaCollection![](/images/permalink.svg)
function addCoursestoaCollection(string collectionId, string 'source, string contentType, Body payload, string? format) returns Response|error
Add Courses to a Collection
Parameters
- collectionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Body -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
removeaCoursefromaCollection![](/images/permalink.svg)
function removeaCoursefromaCollection(string collectionId, string 'source, string contentType, string? format) returns Response|error
Remove a Course from a Collection
Parameters
- collectionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
addLearningPathstoaCollection![](/images/permalink.svg)
function addLearningPathstoaCollection(string collectionId, string 'source, string contentType, Body2 payload, string? format) returns Response|error
Add LearningPaths to a Collection
Parameters
- collectionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Body2 -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
removeaLearningPathfromaCollection![](/images/permalink.svg)
function removeaLearningPathfromaCollection(string collectionId, string 'source, string contentType, string? format) returns Response|error
Remove a Learning Path from a Collection
Parameters
- collectionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
deleteCollection![](/images/permalink.svg)
function deleteCollection(string collectionId, string 'source, string contentType, string? format) returns Response|error
Delete Collection
Parameters
- collectionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
deleteCollectionListing![](/images/permalink.svg)
function deleteCollectionListing(string collectionId, string listingId, string 'source, string contentType, string? format) returns Response|error
Delete a Collection Listing
Parameters
- collectionId string -
- listingId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaListofCourses![](/images/permalink.svg)
function getaListofCourses(string 'source, string? format, int? 'limit, string? search, int? 'start) returns Courses|error
Get a List of Courses
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- search string? (default ()) - String value used to the filter the records
- 'start int? (default ()) - Record number where paging starts
getCourse![](/images/permalink.svg)
Get Course
Parameters
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
deleteCourse![](/images/permalink.svg)
function deleteCourse(string courseId, string 'source, string contentType, string? format) returns Response|error
Delete Course
Parameters
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getCourseDetails![](/images/permalink.svg)
function getCourseDetails(string courseId, string 'source, string? format) returns InlineResponse2001|error
Get Course Details
Parameters
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- InlineResponse2001|error - Success.
listAllUsersAssignedtoaCourse![](/images/permalink.svg)
function listAllUsersAssignedtoaCourse(string courseId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns InlineResponse2002|error
List All Users Assigned to a Course
Parameters
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
Return Type
- InlineResponse2002|error - Success.
listAllModulesInaCourse![](/images/permalink.svg)
function listAllModulesInaCourse(string courseId, string 'source, string? format, int? 'limit, string? search) returns Modules|error
List all Modules in a Course
Parameters
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- search string? (default ()) - String value used to the filter the records
listAllCourseResultsforAllUsersSinceaSpecificDate![](/images/permalink.svg)
function listAllCourseResultsforAllUsersSinceaSpecificDate(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse2003|error
List All Course Results for All Users Since a Specific Date
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse2003|error - Success.
getCustomFieldsforaCourse![](/images/permalink.svg)
function getCustomFieldsforaCourse(string courseId, string 'source, string? format) returns InlineResponse2004|error
Get Custom Fields for a Course
Parameters
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- InlineResponse2004|error - Success.
getCourseCustomFields![](/images/permalink.svg)
function getCourseCustomFields(string 'source, string? format) returns CourseCustomFields|error
Get Course Custom Fields
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- CourseCustomFields|error - Success.
getCourseCustomFieldValueonAllCourses![](/images/permalink.svg)
function getCourseCustomFieldValueonAllCourses(string customFieldId, string 'source, string? format) returns CourseCustomField|error
Get Value for Custom Field Id Across All Courses
Parameters
- customFieldId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- CourseCustomField|error - Success.
getModules![](/images/permalink.svg)
function getModules(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse2005|error
Get Modules
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse2005|error - Success.
getCourses![](/images/permalink.svg)
function getCourses(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse2006|error
Get Courses
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse2006|error - Success.
getLearningPaths![](/images/permalink.svg)
function getLearningPaths(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse2007|error
Get Learning Paths
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse2007|error - Success.
getModulesResults![](/images/permalink.svg)
function getModulesResults(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse2008|error
Get Modules Results
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse2008|error - Success.
getCourseResults![](/images/permalink.svg)
function getCourseResults(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse2009|error
Get Course Results
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse2009|error - Success.
getLearningPathResults![](/images/permalink.svg)
function getLearningPathResults(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20010|error
Get Learning Path Results
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20010|error - Success.
getAchievements1![](/images/permalink.svg)
function getAchievements1(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20011|error
Get Achievements
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20011|error - Success.
getCourseModules![](/images/permalink.svg)
function getCourseModules(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20012|error
Get Course Modules
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20012|error - Success.
getLearningPathCourses![](/images/permalink.svg)
function getLearningPathCourses(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20013|error
Get Learning Path Courses
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20013|error - Success.
getUserCourseAssignments![](/images/permalink.svg)
function getUserCourseAssignments(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20014|error
Get User Course Assignments
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20014|error - Success.
getUserLearningPathAssignments![](/images/permalink.svg)
function getUserLearningPathAssignments(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20015|error
Get User Learning Path Assignments
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20015|error - Success.
getTeams![](/images/permalink.svg)
function getTeams(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20016|error
Get Teams
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20016|error - Success.
getTeamUsers![](/images/permalink.svg)
function getTeamUsers(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20017|error
Get Team Users
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20017|error - Success.
getTeamCourses![](/images/permalink.svg)
function getTeamCourses(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20018|error
Get Team Courses
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20018|error - Success.
getTeamLearningPaths![](/images/permalink.svg)
function getTeamLearningPaths(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20019|error
Get Team Learning Paths
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20019|error - Success.
getUserLogins![](/images/permalink.svg)
function getUserLogins(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20020|error
Get User Logins
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20020|error - Success.
getUserDetails![](/images/permalink.svg)
function getUserDetails(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20020|error
Get User Details
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20020|error - Success.
getaListofFutureILTSessionswithinCoursesEnabledforEcommerce![](/images/permalink.svg)
function getaListofFutureILTSessionswithinCoursesEnabledforEcommerce(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns Response|error
Get a List of Future ILT Sessions within Courses Enabled for Ecommerce
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
getaListofCoursesEnabledforEcommerce![](/images/permalink.svg)
function getaListofCoursesEnabledforEcommerce(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20021|error
Get a List of Courses Enabled for Ecommerce
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20021|error - Success.
getaListofLearningPathsEnabledforEcommerce![](/images/permalink.svg)
function getaListofLearningPathsEnabledforEcommerce(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns InlineResponse20022|error
Get a List of Learning Paths Enabled for Ecommerce
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20022|error - Success.
getTotalBadgesandPointsForUser![](/images/permalink.svg)
function getTotalBadgesandPointsForUser(string userId, string 'source, string? format) returns InlineResponse20023|error
Get Total Badges and Points For User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- InlineResponse20023|error - Success.
getTotalBadgesForUser![](/images/permalink.svg)
function getTotalBadgesForUser(string userId, string 'source, string? format, int? 'limit, int? 'start) returns InlineResponse20024|error
Get Total Badges Earned By a User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- InlineResponse20024|error - Success.
getBadgesandPointsEarnedByUser![](/images/permalink.svg)
function getBadgesandPointsEarnedByUser(string userId, string 'source, string? format, int? 'limit) returns Response|error
Get Badges and Points Earned By User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
getBadgesandPointsEarnedbyaTeam![](/images/permalink.svg)
function getBadgesandPointsEarnedbyaTeam(string teamId, string 'source, string? format, int? 'limit, int? 'start) returns Response|error
Get Badges and Points Earned by a Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
resetBadgesandPointsForaUser![](/images/permalink.svg)
function resetBadgesandPointsForaUser(string userId, string 'source, string contentType, string? format) returns Response|error
Reset Badges and Points For a User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaListofFutureSessionsforanILTModule![](/images/permalink.svg)
function getaListofFutureSessionsforanILTModule(string 'source, string? format, int? 'limit, int? 'start, string? sort, string? dir, string? search, string? since) returns Response|error
Get a List of Future Sessions for an ILT Module
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- sort string? (default ()) - Field used to sort the records
- dir string? (default ()) - Direction to sort the records
- search string? (default ()) - String value used to the filter the records
- since string? (default ()) - Date-time
getaListofPastSessionsforanILTModule![](/images/permalink.svg)
function getaListofPastSessionsforanILTModule(string 'source, string? format, int? 'limit, int? 'start, string? sort, string? dir, string? search, string? since) returns Response|error
Get a List of Past Sessions for an ILT Module
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- sort string? (default ()) - Field used to sort the records
- dir string? (default ()) - Direction to sort the records
- search string? (default ()) - String value used to the filter the records
- since string? (default ()) - Date-time
getaListofallILTModulesinaCourse![](/images/permalink.svg)
function getaListofallILTModulesinaCourse(string courseId, string 'source, int? 'limit, int? 'start, string? format) returns Response|error
Get a List of all ILT Modules in a Course
Parameters
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaListofSessionsinanILTModule![](/images/permalink.svg)
function getaListofSessionsinanILTModule(string courseId, string moduleId, string 'source, string? format, int? 'limit, int? 'start) returns Response|error
Get a List of Sessions in an ILT Module
Parameters
- courseId string -
- moduleId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
createaNewILTSessionforaModule![](/images/permalink.svg)
function createaNewILTSessionforaModule(string courseId, string moduleId, string 'source, string contentType, Session payload, string? format) returns Response|error
Create a New ILT Session for a Module
Parameters
- courseId string -
- moduleId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Session -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaSpecificSessioninanILTModule![](/images/permalink.svg)
function getaSpecificSessioninanILTModule(string courseId, string moduleId, string sessionId, string 'source, string? format) returns Response|error
Get a Specific Session in an ILT Module
Parameters
- courseId string -
- moduleId string -
- sessionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
updateaSessioninanILTModule![](/images/permalink.svg)
function updateaSessioninanILTModule(string courseId, string moduleId, string sessionId, string 'source, string contentType, Session payload, string? format) returns Response|error
Update a Session in an ILT Module
Parameters
- courseId string -
- moduleId string -
- sessionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Session -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
deleteaSessioninanILTModule![](/images/permalink.svg)
function deleteaSessioninanILTModule(string courseId, string moduleId, string sessionId, string 'source, string contentType, string? format) returns Response|error
Delete a Session in an ILT Module.
Parameters
- courseId string -
- moduleId string -
- sessionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaListofAllInstructors![](/images/permalink.svg)
function getaListofAllInstructors(string 'source, string? format, int? 'limit, int? 'start, string? search) returns Response|error
Get a List of All Instructors
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
getaListofSessionsforaSpecificInstructor![](/images/permalink.svg)
function getaListofSessionsforaSpecificInstructor(string instructorId, string 'source, string? format, int? 'limit, int? 'start) returns Response|error
Get a List of Sessions for a Specific Instructor
Parameters
- instructorId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
getSessionRollCallforaSession![](/images/permalink.svg)
function getSessionRollCallforaSession(string courseId, string moduleId, string sessionId, string 'source, string? format, int? 'limit, int? 'start) returns Response|error
Get Session Roll Call for a Session
Parameters
- courseId string -
- moduleId string -
- sessionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
markanILTSessionCompleteandAddScore![](/images/permalink.svg)
function markanILTSessionCompleteandAddScore(string courseId, string moduleId, string sessionId, string 'source, string contentType, EventUsers payload, string? format) returns Response|error
Mark an ILT Session Complete and Add Score
Parameters
- courseId string -
- moduleId string -
- sessionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload EventUsers -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getalistofUsersRegisteredtoaSession![](/images/permalink.svg)
function getalistofUsersRegisteredtoaSession(string courseId, string moduleId, string 'source, string? format, int? 'limit, int? 'start) returns Response|error
Get a list of Users Registered to a Session
Parameters
- courseId string -
- moduleId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
registeraUsertoaSession![](/images/permalink.svg)
function registeraUsertoaSession(string courseId, string moduleId, string sessionId, string userId, string 'source, string contentType, string? format) returns Response|error
Register a User to a Session
Parameters
- courseId string -
- moduleId string -
- sessionId string -
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
registeraListofUserstoaSession![](/images/permalink.svg)
function registeraListofUserstoaSession(string courseId, string moduleId, string sessionId, string 'source, string contentType, Users payload, string? format) returns UserSessionRegistrationStatus|error
Register a List of Users to a Session
Parameters
- courseId string -
- moduleId string -
- sessionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Users -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- UserSessionRegistrationStatus|error - Success.
getuserAttendanceforaSession![](/images/permalink.svg)
function getuserAttendanceforaSession(string courseId, string moduleId, string sessionId, string 'source, string? format, int? 'limit, int? 'start) returns Response|error
Get user Attendance for a Session
Parameters
- courseId string -
- moduleId string -
- sessionId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
markAttendanceforUsersRegisteredtoaSession![](/images/permalink.svg)
function markAttendanceforUsersRegisteredtoaSession(string courseId, string moduleId, string sessiondayId, string userId, string attended, string 'source, string contentType, string? format) returns Response|error
Mark Attendance for a User Registered to a Session
Parameters
- courseId string -
- moduleId string -
- sessiondayId string -
- userId string -
- attended string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getAllLearningPaths![](/images/permalink.svg)
function getAllLearningPaths(string 'source, string? format, int? 'limit, int? 'start, string? search) returns LearningPaths|error
Get All Learning Paths
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
Return Type
- LearningPaths|error - Success.
getaSpecificLearningPath![](/images/permalink.svg)
function getaSpecificLearningPath(string learningpathId, string 'source, string? format) returns LearningPath|error
Get a learning path
Parameters
- learningpathId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- LearningPath|error - Success.
deleteLearningPath![](/images/permalink.svg)
function deleteLearningPath(string learningpathId, string 'source, string contentType, string? format) returns Response|error
Delete Learning Path
Parameters
- learningpathId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaListofCoursesinaLearningPath![](/images/permalink.svg)
function getaListofCoursesinaLearningPath(string learningpathId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns Response|error
Get a List of Courses in a Learning Path
Parameters
- learningpathId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
getaListofUsersAssignedtoaLearningPath![](/images/permalink.svg)
function getaListofUsersAssignedtoaLearningPath(string learningpathId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns Response|error
Get a List of Users Assigned to a Learning Path
Parameters
- learningpathId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
getLearningPathsAssignedtoaTeam![](/images/permalink.svg)
function getLearningPathsAssignedtoaTeam(string teamId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns LearningPaths|error
Get Learning Paths Assigned to a Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
Return Type
- LearningPaths|error - Success.
assignaListofLearningPathstoTeam![](/images/permalink.svg)
function assignaListofLearningPathstoTeam(string teamId, string 'source, string contentType, Body4 payload, string? format) returns Response|error
Assign a List of Learning Paths to Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Body4 -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
unassignaListofLearningPathsfromTeam![](/images/permalink.svg)
function unassignaListofLearningPathsfromTeam(string teamId, string 'source, string contentType, string? format) returns Response|error
Unassign a List of Learning Paths from Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaModule![](/images/permalink.svg)
Get a Module
Parameters
- moduleId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
updateascormTincanmodule![](/images/permalink.svg)
function updateascormTincanmodule(string moduleId, string 'source, string contentType, Module payload, string? format) returns Response|error
Update a SCORM/Tin Can Module
Parameters
- moduleId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Module -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
deleteModule![](/images/permalink.svg)
function deleteModule(string moduleId, string 'source, string contentType, string? format) returns Response|error
Delete Module
Parameters
- moduleId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
markaModuleComplete![](/images/permalink.svg)
function markaModuleComplete(string moduleId, string 'source, string contentType, ModuleResult payload, string? format) returns Response|error
Mark a Module Complete
Parameters
- moduleId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload ModuleResult -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
createascormTincanmodule![](/images/permalink.svg)
function createascormTincanmodule(string 'source, string contentType, Module payload, string? format) returns Response|error
Create a SCORM/Tin Can Module
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Module -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
copyscormTincanmoduletoacourse![](/images/permalink.svg)
function copyscormTincanmoduletoacourse(string courseId, string 'source, string contentType, Modules payload, string? format) returns Response|error
Copy SCORM/Tin Can Module to a Course
Parameters
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Modules -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
linkscormTincanmoduletoacourse![](/images/permalink.svg)
function linkscormTincanmoduletoacourse(string courseId, string 'source, string contentType, Modules payload, string? format) returns Response|error
Link SCORM/Tin Can Module to a Course
Parameters
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Modules -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
mirrorscormTincanmoduletoacourse![](/images/permalink.svg)
function mirrorscormTincanmoduletoacourse(string courseId, string 'source, string contentType, Modules payload, string? format) returns Response|error
Mirror SCORM/Tin Can Module to a Course
Parameters
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Modules -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
removescormTincanmodulefromacourse![](/images/permalink.svg)
function removescormTincanmodulefromacourse(string courseId, string moduleId, string 'source, string contentType, string? format) returns Response|error
Remove SCORM/Tin Can Module from a Course
Parameters
- courseId string -
- moduleId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaToken![](/images/permalink.svg)
Get a Token
Parameters
- tokenId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getAListofTokens![](/images/permalink.svg)
function getAListofTokens(string 'source, string? format, int? 'limit, int? 'start, string? search) returns Tokens|error
Get A List of Tokens
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
updateaToken![](/images/permalink.svg)
function updateaToken(string 'source, string contentType, Tokens payload, string? format) returns Response|error
Update a Token
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Tokens -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
createaToken![](/images/permalink.svg)
function createaToken(string 'source, string contentType, Tokens payload, string? format) returns Response|error
Create a Token
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Tokens -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getActionsActivity![](/images/permalink.svg)
function getActionsActivity(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns ActionActivitys|error
Get Actions Activity
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- ActionActivitys|error - Success.
getAssignmentsActivity![](/images/permalink.svg)
function getAssignmentsActivity(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns AssignmentActivitys|error
Get Assignments Activity
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- AssignmentActivitys|error - Success.
getContentActivity![](/images/permalink.svg)
function getContentActivity(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns ContentActivitys|error
Get Content Activity
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- ContentActivitys|error - Success.
getLoginActivity![](/images/permalink.svg)
function getLoginActivity(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns LoginActivitys|error
Get Login Activity
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- LoginActivitys|error - Success.
getSettingsActivity![](/images/permalink.svg)
function getSettingsActivity(string 'source, string since, string to, string? format, int? 'limit, int? 'start) returns SettingsActivitys|error
Get Settings Activity
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- since string -
- to string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
Return Type
- SettingsActivitys|error - Success.
listofUsers![](/images/permalink.svg)
function listofUsers(string 'source, string? format, int? 'limit, int? 'start, string? sort, string? dir, string? search, boolean? showInactive) returns InlineResponse20025|error
List of Users
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- sort string? (default ()) - Field used to sort the records
- dir string? (default ()) - Direction to sort the records
- search string? (default ()) - String value used to the filter the records
- showInactive boolean? (default ()) - boolean value used to the filter active/inactive records
Return Type
- InlineResponse20025|error - Success.
createUser![](/images/permalink.svg)
function createUser(string 'source, User payload, string? format, boolean? sendmessage, boolean? skipfirstlogin) returns Response|error
Create User
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- payload User -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- sendmessage boolean? (default ()) - set to "True" to send login emails to new users
- skipfirstlogin boolean? (default ()) - set to "True" to have users skip setting a password after logging in
listofUsersPaginated![](/images/permalink.svg)
function listofUsersPaginated(string 'source, string? format, int? 'limit, int? 'start, string? sort, string? dir, string? search, boolean? showInactive) returns UserCollection|error
List of Users With Summary of User Pagination Details
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- sort string? (default ()) - Field used to sort the records
- dir string? (default ()) - Direction to sort the records
- search string? (default ()) - String value used to the filter the records
- showInactive boolean? (default ()) - boolean value used to the filter active/inactive records
Return Type
- UserCollection|error - Success.
getUserbyUserId![](/images/permalink.svg)
Get User by User Id
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
updateUser![](/images/permalink.svg)
function updateUser(string userId, string 'source, string contentType, User payload, string? format) returns Response|error
Update User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload User -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
deleteaUser![](/images/permalink.svg)
function deleteaUser(string userId, string 'source, string contentType, string? format) returns Response|error
Delete a User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaListofUserswithDetails![](/images/permalink.svg)
function getaListofUserswithDetails(string 'source, string? format, int? 'limit, int? 'start, string? sort, string? dir, string? search, string? since) returns InlineResponse20026|error
Get a List of Users with Details
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- sort string? (default ()) - Field used to sort the records
- dir string? (default ()) - Direction to sort the records
- search string? (default ()) - String value used to the filter the records
- since string? (default ()) - Date-time
Return Type
- InlineResponse20026|error - Success.
getAdvancedCustomFieldsforUser![](/images/permalink.svg)
function getAdvancedCustomFieldsforUser(string userId, string 'source, string? format) returns InlineResponse20027|error
Get Advanced Custom Fields for User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
Return Type
- InlineResponse20027|error - Success.
addAdvancedCustomFieldsforUser![](/images/permalink.svg)
function addAdvancedCustomFieldsforUser(string userId, string 'source, string contentType, Body5 payload, string? format) returns Response|error
Add Advanced Custom Fields for User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Body5 -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
listAllCoursesAssignedtoaUser![](/images/permalink.svg)
function listAllCoursesAssignedtoaUser(string userId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns InlineResponse20028|error
List All Courses Assigned to a User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
Return Type
- InlineResponse20028|error - Success.
assignCoursestoUser![](/images/permalink.svg)
function assignCoursestoUser(string userId, string 'source, string contentType, Body6 payload, string? format, boolean? sendmessage) returns Response|error
Assign Courses to User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Body6 -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- sendmessage boolean? (default ()) -
resetCourseResults![](/images/permalink.svg)
function resetCourseResults(string userId, string courseId, string 'source, string contentType, string? format) returns Response|error
Reset Course Results
Parameters
- userId string -
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
unassignCoursefromUser![](/images/permalink.svg)
function unassignCoursefromUser(string userId, string courseId, string 'source, string contentType, string? format) returns Response|error
Unassign Course from User
Parameters
- userId string -
- courseId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getCourseAssignmentsForListOfUsers![](/images/permalink.svg)
function getCourseAssignmentsForListOfUsers(string 'source, string contentType, Body7 payload, string? format) returns Response|error
Get Courses Assigned For a List of Users
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Body7 -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaListofLearningPathsAssignedtoaUser![](/images/permalink.svg)
function getaListofLearningPathsAssignedtoaUser(string userId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns InlineResponse20029|error
Get a List of Learning Paths Assigned to a User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
Return Type
- InlineResponse20029|error - Success.
assignLearningPathsToUser![](/images/permalink.svg)
function assignLearningPathsToUser(string userId, string 'source, string contentType, Body8 payload, string? format) returns Response|error
Assign Learning Paths to User
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Body8 -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
unAssignusersfromalearningpath![](/images/permalink.svg)
function unAssignusersfromalearningpath(string userId, string learningpathId, string 'source, string contentType, string? format) returns Response|error
Un-Assign Users from a Learning Path
Parameters
- userId string -
- learningpathId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getalistofAllTeamsaUserisAssignedto![](/images/permalink.svg)
function getalistofAllTeamsaUserisAssignedto(string userId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns Teams|error
Get a list of All Teams a User is Assigned to
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
assignaUsertoaListofTeams![](/images/permalink.svg)
function assignaUsertoaListofTeams(string userId, string 'source, string contentType, Teams payload, string? format, boolean? sendmessage) returns Response|error
Assign a User to a List of Teams
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Teams -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- sendmessage boolean? (default ()) - set to "True" to send login emails to new users
unassignaUserfromAllTeams![](/images/permalink.svg)
function unassignaUserfromAllTeams(string userId, string 'source, string contentType, string? format) returns Response|error
Unassign a User from All Teams
Parameters
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
addaStatement![](/images/permalink.svg)
function addaStatement(string contentType, string litmosDomain, string dBinstance, string payload) returns json|error
Add a Statement
Return Type
- json|error - Ok
updateaStatement![](/images/permalink.svg)
function updateaStatement(string contentType, string litmosDomain, string dBinstance, string statementId, string payload) returns Response|error
Update a Statement
Parameters
- contentType string -
- litmosDomain string -
- dBinstance string -
- statementId string -
- payload string -
getaStatement![](/images/permalink.svg)
function getaStatement(string litmosDomain, string dBinstance, string statementId) returns json|error
Get a Statement
Return Type
- json|error - OK
getaListofallCoursesAssignedtoTeam![](/images/permalink.svg)
function getaListofallCoursesAssignedtoTeam(string teamId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns Courses|error
Get a List of all Courses Assigned to Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
assignaListofCoursestoTeam![](/images/permalink.svg)
function assignaListofCoursestoTeam(string teamId, string 'source, string contentType, Body9 payload, string? format, boolean? includesubteams) returns Response|error
Assign a List of Courses to Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Body9 -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- includesubteams boolean? (default ()) -
unassignaListofCoursesfromTeam![](/images/permalink.svg)
function unassignaListofCoursesfromTeam(string teamId, string 'source, string contentType, string? format) returns Response|error
Unassign a List of Courses from Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getTeamAdministratorsforaTeam![](/images/permalink.svg)
function getTeamAdministratorsforaTeam(string teamId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns InlineResponse20030|error
Get Team Administrators for a Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
Return Type
- InlineResponse20030|error - Success.
promoteaUsertoTeamAdminforaTeam![](/images/permalink.svg)
function promoteaUsertoTeamAdminforaTeam(string teamId, string userId, string 'source, string contentType, string? format) returns Response|error
Promote a User to Team Admin for a Team
Parameters
- teamId string -
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
demoteaTeamAdministratoronaTeam![](/images/permalink.svg)
function demoteaTeamAdministratoronaTeam(string teamId, string userId, string 'source, string contentType, string? format) returns Response|error
Demote a Team Administrator on a Team
Parameters
- teamId string -
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getTeamLeadersforaTeam![](/images/permalink.svg)
function getTeamLeadersforaTeam(string teamId, string 'source, string? format, int? 'limit, int? 'start, string? search) returns InlineResponse20031|error
Get Team Leaders for a Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
Return Type
- InlineResponse20031|error - Success.
promoteaUsertoTeamLeaderforaTeam![](/images/permalink.svg)
function promoteaUsertoTeamLeaderforaTeam(string teamId, string userId, string 'source, string contentType, string? format) returns Response|error
Promote a User to Team Leader for a Team
Parameters
- teamId string -
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
demoteaTeamLeaderonaTeam![](/images/permalink.svg)
function demoteaTeamLeaderonaTeam(string teamId, string userId, string 'source, string contentType, string? format) returns Response|error
Demote a Team Leader on a Team
Parameters
- teamId string -
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getUsersinaTeam![](/images/permalink.svg)
function getUsersinaTeam(string teamId, string 'source, string? format, int? 'limit, string? search) returns InlineResponse20030|error
Get Users in a Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- search string? (default ()) - String value used to the filter the records
Return Type
- InlineResponse20030|error - Success.
assignUserstoaTeam![](/images/permalink.svg)
function assignUserstoaTeam(string teamId, string 'source, string contentType, Body10 payload, string? format, boolean? sendmessage) returns Response|error
Assign Users to a Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Body10 -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- sendmessage boolean? (default ()) - set to "True" to send login emails to new users
unassignUsersfromaTeam![](/images/permalink.svg)
function unassignUsersfromaTeam(string teamId, string userId, string 'source, string contentType, string? format) returns Response|error
Unassign Users from a Team
Parameters
- teamId string -
- userId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaListofAllTeams![](/images/permalink.svg)
function getaListofAllTeams(string 'source, string? format, int? 'limit, int? 'start, string? search) returns Teams|error
Get a List of All Teams
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- 'start int? (default ()) - Record number where paging starts
- search string? (default ()) - String value used to the filter the records
createaTeam![](/images/permalink.svg)
function createaTeam(string 'source, string contentType, Team payload, string? format) returns Response|error
Create a Team
Parameters
- 'source string - Custom identifier used to identify an API user, API program, etc.
- contentType string -
- payload Team -
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getaTeam![](/images/permalink.svg)
Get a Team
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
getSubTeamId![](/images/permalink.svg)
function getSubTeamId(string teamId, string 'source, string? format, int? 'limit, string? search) returns Response|error
Get SubTeam Id
Parameters
- teamId string -
- 'source string - Custom identifier used to identify an API user, API program, etc.
- format string? (default ()) - set to "json" if the response body is to be formatted in JavaScript Object Notation
- 'limit int? (default ()) - Total records to return (max 1000)
- search string? (default ()) - String value used to the filter the records
createasubTeam![](/images/permalink.svg)
function createasubTeam(string teamId, string 'source, string contentType, Team payload, string? format) returns Response|error
Create a Sub-Team
Records![](/images/permalink.svg)
sap.successfactors.litmos: Achievement![](/images/permalink.svg)
Fields
- UserId string? -
- Title string? -
- Description string? -
- AchievementDate string? -
- CourseId string? -
- ComplaintTillDate string? -
- Score int? -
- Result string? -
- Type string? -
- FirstName string? -
- LastName string? -
- AchievementId string? -
- CertificateId string? -
sap.successfactors.litmos: Achievements![](/images/permalink.svg)
Fields
- Course Achievement[]? -
sap.successfactors.litmos: ActionActivity![](/images/permalink.svg)
Fields
- ActivityType string? -
- ObjectType string? -
- ObjectId string? -
- OriginalObjectId string? -
- ObjectName string? -
- TargetObjectType string? -
- TargetObjectId string? -
- OriginalTargetObjectId string? -
- TargetObjectName string? -
- ActivityBy string? -
- ActivityByUserName string? -
- ActivityDate string? -
sap.successfactors.litmos: ActionActivitys![](/images/permalink.svg)
Fields
- ActionActivity ActionActivity[] -
sap.successfactors.litmos: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- aPIKey string - Every user in Litmos has a unique API key. Only Account Owners are able to view user record API keys, and access to operations via API are restricted by access levels.
sap.successfactors.litmos: AssignmentActivity![](/images/permalink.svg)
Fields
- ActivityType string? -
- ObjectType string? -
- ObjectId string? -
- OriginalObjectId string? -
- ObjectName string? -
- TargetObjectType string? -
- TargetObjectId string? -
- OriginalTargetObjectId string? -
- TargetObjectName string? -
- ActivityBy string? -
- ActivityByUserName string? -
- ActivityDate string? -
sap.successfactors.litmos: AssignmentActivitys![](/images/permalink.svg)
Fields
- AssignmentActivity AssignmentActivity[] -
sap.successfactors.litmos: Body![](/images/permalink.svg)
Fields
- Course CollectionscollectionidcoursesCourse[]? -
sap.successfactors.litmos: Body1![](/images/permalink.svg)
Fields
- Id string? -
sap.successfactors.litmos: Body10![](/images/permalink.svg)
Fields
- User InlineResponse20030User[]? -
sap.successfactors.litmos: Body2![](/images/permalink.svg)
Fields
- LearningPath CollectionscollectionidlearningpathsLearningpath[]? -
sap.successfactors.litmos: Body3![](/images/permalink.svg)
Fields
- Id string? -
sap.successfactors.litmos: Body4![](/images/permalink.svg)
Fields
- LearningPath TeamsteamidlearningpathsLearningpath[]? -
sap.successfactors.litmos: Body5![](/images/permalink.svg)
Fields
- 'parameter string? -
sap.successfactors.litmos: Body6![](/images/permalink.svg)
Fields
- Course UsersuseridcoursesCourse[]? -
sap.successfactors.litmos: Body7![](/images/permalink.svg)
Fields
- User UserscoursesUser[]? -
sap.successfactors.litmos: Body8![](/images/permalink.svg)
Fields
- LearningPath UsersuseridcoursesCourse[]? -
sap.successfactors.litmos: Body9![](/images/permalink.svg)
Fields
- Course TeamsteamidcoursesCourse[]? -
sap.successfactors.litmos: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
sap.successfactors.litmos: Collection![](/images/permalink.svg)
Fields
- Name string -
- Description string -
- DefaultListing boolean? -
- ImageURL string? -
sap.successfactors.litmos: Collections![](/images/permalink.svg)
Fields
- ListingUser Collection[]? -
sap.successfactors.litmos: CollectionscollectionidcoursesCourse![](/images/permalink.svg)
Fields
- CourseId string? -
- SeqId int? -
sap.successfactors.litmos: CollectionscollectionidlearningpathsLearningpath![](/images/permalink.svg)
Fields
- LearnigPathId string? -
- SeqId int? -
sap.successfactors.litmos: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
sap.successfactors.litmos: ContentActivity![](/images/permalink.svg)
Fields
- ActivityType string? -
- ObjectType string? -
- ObjectId string? -
- OriginalObjectId string? -
- ObjectName string? -
- TargetObjectType string? -
- TargetObjectId string? -
- OriginalTargetObjectId string? -
- TargetObjectName string? -
- ActivityBy string? -
- ActivityByUserName string? -
- ActivityDate string? -
sap.successfactors.litmos: ContentActivitys![](/images/permalink.svg)
Fields
- ContentActivity ContentActivity[] -
sap.successfactors.litmos: Course![](/images/permalink.svg)
Fields
- Id string -
- Code string? -
- Name string? -
- Active boolean? -
- ForSale boolean? -
- OriginalId string? -
- Description string? -
- EcommerceShortDescription string? -
- EcommerceLongDescription string? -
- CourseCodeForBulkImport string? -
- Price int? -
- AccessTillDate string? -
- AccessTillDays int? -
- CourseTeamLibrary boolean? -
- CreatedBy string? -
- Tags string? -
sap.successfactors.litmos: CourseBulkImport![](/images/permalink.svg)
Fields
- ImportId string? -
- ImportDate string? -
- Status string? -
- TotalRecords int? -
- TotalCoursesCreated int? -
- Failed int? -
sap.successfactors.litmos: CourseCustomField![](/images/permalink.svg)
Fields
- CustomFieldId string? -
- Label string? -
- DefaultValue string? -
- Mandatory boolean? -
- VisibleToLearner boolean? -
- Type string? -
- Dropdown record {}[]? -
sap.successfactors.litmos: CourseCustomFields![](/images/permalink.svg)
Fields
- CourseCustomField CourseCustomField[] -
sap.successfactors.litmos: CourseImport![](/images/permalink.svg)
Fields
- CourseTitle string -
- Description string? -
- CourseCode string? -
- Active boolean -
- ContentLibrary boolean? -
- Notifications string? -
- ModuleOrder boolean? -
- CourseInactivationDate string? -
- CourseAccessExpirationDate string? -
- CourseAccessExpirationDateSpan int? -
- DueDate string? -
- DueDateSpan int? -
- ComplianceDateSpan int? -
- ComplianceRetake boolean? -
- Topic1 string? -
- Topic2 string? -
- Topic3 string? -
- Social string? -
- DiscussionForum boolean? -
- CoursePrerequisite1 string? -
- CoursePrerequisite2 string? -
- CoursePrerequisite3 string? -
- LearningPathPrerequisite1 string? -
- LearningPathPrerequisite2 string? -
- LearningPathPrerequisite3 string? -
- Language string? -
- Tags string? -
- AdvCourseCustomField1 string? -
- AdvCourseCustomField2 string? -
- AdvCourseCustomField3 string? -
- AdvCourseCustomField4 string? -
- AdvCourseCustomField5 string? -
- AdvCourseCustomField6 string? -
- AdvCourseCustomField7 string? -
- AdvCourseCustomField8 string? -
- AdvCourseCustomField9 string? -
- AdvCourseCustomField10 string? -
- ReferenceCode string? -
sap.successfactors.litmos: CourseImports![](/images/permalink.svg)
Fields
- CourseImport CourseImport[]? -
sap.successfactors.litmos: Courses![](/images/permalink.svg)
Fields
- Course Course[]? -
sap.successfactors.litmos: Day![](/images/permalink.svg)
Fields
- Id string -
- StartDate string -
- EndDate string -
- StartTime string -
- EndTime string -
- SendReminder boolean -
- ReminderValue int -
- ReminderMetric string -
sap.successfactors.litmos: EventUser![](/images/permalink.svg)
Fields
- Id string -
- EventStatus int -
- FirstName string -
- LastName string -
- Email string -
- CompanyName string -
- Score int -
- Completed boolean -
sap.successfactors.litmos: EventUsers![](/images/permalink.svg)
Fields
- Team EventUser[]? -
sap.successfactors.litmos: InlineResponse200![](/images/permalink.svg)
Fields
- Username string? -
- ImporStatus string? -
sap.successfactors.litmos: InlineResponse2001![](/images/permalink.svg)
Fields
- Id string? -
- OriginalId string? -
- Code string? -
- Name string? -
- Description string? -
- CourseCode string? -
- Active boolean? -
- IncludeInLibrary boolean? -
- CompleteInOrder boolean? -
- CourseImageURL string? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
- ForSale boolean? -
- EcommerceShortDescription string? -
- EcommerceLongDescription string? -
- Price string? -
- AccessTillDate string? -
- AccessTillDays string? -
- DueDate string? -
- DueDateSpan string? -
- ComplianceDate string? -
- ComplianceDateSpan string? -
- ComplianceRetake string? -
- Languages string[]? -
- Topics string? -
- Tags string? -
- CoursePreRequisites string? -
- LearningPathPreRequisites string? -
- Skills string? -
- Social boolean? -
- DiscussionForum boolean? -
- AdvCourseCustomField1 string? -
- AdvCourseCustomField2 string? -
- AdvCourseCustomField3 string? -
- AdvCourseCustomField4 string? -
- AdvCourseCustomField5 string? -
- AdvCourseCustomField6 string? -
- AdvCourseCustomField7 string? -
- AdvCourseCustomField8 string? -
- AdvCourseCustomField9 string? -
- AdvCourseCustomField10 string? -
- AllModulesNewWindow boolean? -
- Certificate boolean? -
- BoostsReleased int? -
- BoostsFrequency int? -
sap.successfactors.litmos: InlineResponse20010![](/images/permalink.svg)
Fields
- LearningPathResult InlineResponse20010Learningpathresult[]? -
sap.successfactors.litmos: InlineResponse20010Learningpathresult![](/images/permalink.svg)
Fields
- Id string? -
- UserId string? -
- OriginalLearningPathId string? -
- OriginalUserId string? -
- Active boolean? -
- Name string? -
- PercentageComplete int? -
- Completed boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CompliantTillDate string? -
- StartDate string? -
- FinishDate string? -
- CreatedBy string? -
sap.successfactors.litmos: InlineResponse20011![](/images/permalink.svg)
Fields
- Achievement InlineResponse20011Achievement[]? -
sap.successfactors.litmos: InlineResponse20011Achievement![](/images/permalink.svg)
Fields
- Id string? -
- UserId string? -
- CourseId string? -
- LearningPathId string? -
- OriginalAchievementId string? -
- OriginalUserId string? -
- OriginalCourseId string? -
- OriginalLearningPathId string? -
- ComplaintTillDate string? -
- Title string? -
- AchievementDate string? -
- Type string? -
- CertificateId string? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse20012![](/images/permalink.svg)
Fields
- CourseModule InlineResponse20012Coursemodule[]? -
sap.successfactors.litmos: InlineResponse20012Coursemodule![](/images/permalink.svg)
Fields
- CourseId string? -
- Id string? -
- OriginalCourseId string? -
- OriginalModuleId string? -
- Active boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse20013![](/images/permalink.svg)
Fields
- LearningPathCourse InlineResponse20013Learningpathcourse[]? -
sap.successfactors.litmos: InlineResponse20013Learningpathcourse![](/images/permalink.svg)
Fields
- LearningPathId string? -
- Id string? -
- OriginalLearningPathId string? -
- OriginalCourseId string? -
- Active boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse20014![](/images/permalink.svg)
Fields
- UserCourse InlineResponse20014Usercourse[]? -
sap.successfactors.litmos: InlineResponse20014Usercourse![](/images/permalink.svg)
Fields
- UserId string? -
- Id string? -
- OriginalUserId string? -
- OriginalCourseId string? -
- Active boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse20015![](/images/permalink.svg)
Fields
- LearningPathUser InlineResponse20015Learningpathuser[]? -
sap.successfactors.litmos: InlineResponse20015Learningpathuser![](/images/permalink.svg)
Fields
- LearningPathId string? -
- Id string? -
- OriginalLearningPathId string? -
- Active boolean? -
- OriginalUserId string? -
- CreatedBy string? -
- CreatedDate string? -
- UpdatedBy string? -
- UpdatedDate string? -
sap.successfactors.litmos: InlineResponse20016![](/images/permalink.svg)
Fields
- Team InlineResponse20016Team[]? -
sap.successfactors.litmos: InlineResponse20016Team![](/images/permalink.svg)
Fields
- Id string? -
- Name string? -
- OriginalTeamId string? -
- Active boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
- ParentTeamId string? -
- TeamCodeForBulkImport string? -
sap.successfactors.litmos: InlineResponse20017![](/images/permalink.svg)
Fields
- TeamUser InlineResponse20017Teamuser[]? -
sap.successfactors.litmos: InlineResponse20017Teamuser![](/images/permalink.svg)
Fields
- TeamId string? -
- Id string? -
- OriginalTeamId string? -
- OriginalUserId string? -
- Active boolean? -
- IsTeamLeader boolean? -
- IsTeamAdmin boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse20018![](/images/permalink.svg)
Fields
- TeamCourse InlineResponse20018Teamcourse[]? -
sap.successfactors.litmos: InlineResponse20018Teamcourse![](/images/permalink.svg)
Fields
- TeamId string? -
- Id string? -
- OriginalCourseId string? -
- OriginalTeamId string? -
- Active boolean? -
- IsInTeamLibrary boolean? -
- LearningPathAssignment boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse20019![](/images/permalink.svg)
Fields
- TeamLearningPath InlineResponse20019Teamlearningpath[]? -
sap.successfactors.litmos: InlineResponse20019Teamlearningpath![](/images/permalink.svg)
Fields
- TeamId string? -
- Id string? -
- OriginalLearningPathId string? -
- OriginalTeamId string? -
- Active boolean? -
- IsInTeamLibrary boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse2002![](/images/permalink.svg)
Fields
- Id string? -
- UserName string? -
- FirstName string? -
- LastName string? -
- Completed boolean? -
- PercentageComplete string? -
- CompliantTill string? -
- DueDate string? -
sap.successfactors.litmos: InlineResponse20020![](/images/permalink.svg)
Fields
- User InlineResponse20020User[]? -
sap.successfactors.litmos: InlineResponse20020User![](/images/permalink.svg)
Fields
- Id string? -
- UserName string? -
- FirstName string? -
- LastName string? -
- FullName string? -
- Email string? -
- AccessLevel string? -
- DisableMessages boolean? -
- Active boolean? -
- Skype string? -
- PhoneWork string? -
- PhoneMobile string? -
- LastLogin string? -
- LoginKey string? -
- IsCustomUsername boolean? -
- TimeZone string? -
- SalesforceId string? -
- OriginalUserId string? -
- Street1 string? -
- Street2 string? -
- City string? -
- State string? -
- PostalCode string? -
- Country string? -
- CompanyName string? -
- JobTitle string? -
- CustomField1 string? -
- CustomField2 string? -
- CustomField3 string? -
- CustomField4 string? -
- CustomField5 string? -
- CustomField6 string? -
- CustomField7 string? -
- CustomField8 string? -
- CustomField9 string? -
- CustomField10 string? -
- SalesforceContactId string? -
- SalesforceAccountId string? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
- Brand string? -
- ManagerId string? -
- ManagerName string? -
- EnableTextNotification boolean? -
- Website string? -
- Twitter string? -
- ExpirationDate string? -
- ExternalEmployeeId string? -
- ProfileType string? -
sap.successfactors.litmos: InlineResponse20021![](/images/permalink.svg)
Fields
- Courses InlineResponse20021Courses[]? -
sap.successfactors.litmos: InlineResponse20021Course![](/images/permalink.svg)
Fields
- Id string? -
- Code string? -
- Name string? -
- Active boolean? -
- UpdatedBy string? -
- OriginalId string? -
- Description string? -
- EcommerceShortDescription string? -
- EcommerceLongDescription string? -
- Skills string? -
- Price int? -
- AccessTillDate string? -
- AccessTillDays int? -
- CoursePreRequisites string? -
- LearningPathPreRequisites string? -
- Currency string? -
- Languages string? -
- Topics string? -
- Tags string? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
sap.successfactors.litmos: InlineResponse20021Courses![](/images/permalink.svg)
Fields
- Course InlineResponse20021Course? -
sap.successfactors.litmos: InlineResponse20022![](/images/permalink.svg)
Fields
- LearningPaths InlineResponse20022Learningpaths[]? -
sap.successfactors.litmos: InlineResponse20022Learningpath![](/images/permalink.svg)
Fields
- Id string? -
- Name string? -
- Description string? -
- Active boolean? -
- OriginalId string? -
- Price int? -
- EcommerceShortDescription string? -
- EcommerceLongDescription string? -
- AccessTillDate string? -
- AccessTillDays int? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- Code string? -
- Currency string? -
- Languages string? -
- Topics string? -
- Tags string? -
- CoursePreRequisites string? -
- LearningPathPreRequisites string? -
- Skills string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse20022Learningpaths![](/images/permalink.svg)
Fields
- LearningPath InlineResponse20022Learningpath? -
sap.successfactors.litmos: InlineResponse20023![](/images/permalink.svg)
Fields
- TotalBadgesEarned int? -
- TotalPointsEarned int? -
sap.successfactors.litmos: InlineResponse20024![](/images/permalink.svg)
Fields
- Id string? -
- Title string? -
- Description string? -
- Icon string? -
- IconBadgeColor string? -
sap.successfactors.litmos: InlineResponse20025![](/images/permalink.svg)
Fields
- User InlineResponse20025User[]? -
sap.successfactors.litmos: InlineResponse20025User![](/images/permalink.svg)
Fields
- Id string? -
- Username string? -
- FirstName string? -
- LastName string? -
- Active boolean? -
- Email string? -
- AccessLevel string? -
- Brand string? -
sap.successfactors.litmos: InlineResponse20026![](/images/permalink.svg)
Fields
- User InlineResponse20026User[]? -
sap.successfactors.litmos: InlineResponse20026User![](/images/permalink.svg)
Fields
- Id string? -
- UserName string? -
- FirstName string? -
- LastName string? -
- FullName string? -
- Email string? -
- AccessLevel string? -
- DisableMessages boolean? -
- Active boolean? -
- Skype string? -
- PhoneWork string? -
- PhoneMobile string? -
- LastLogin string? -
- LoginKey string? -
- IsCustomUsername boolean? -
- SkipFirstLogin boolean? -
- TimeZone string? -
- SalesforceId string? -
- OriginalId string? -
- Street1 string? -
- Street2 string? -
- City string? -
- State string? -
- PostalCode string? -
- Country string? -
- CompanyName string? -
- JobTitle string? -
- CustomField1 string? -
- CustomField2 string? -
- CustomField3 string? -
- CustomField4 string? -
- CustomField5 string? -
- CustomField6 string? -
- CustomField7 string? -
- CustomField8 string? -
- CustomField9 string? -
- CustomField10 string? -
- SalesforcecontactId string? -
- SalesforceAccountId string? -
- CreatedDate string? -
- Points int? -
- Brand string? -
- ManagerId string? -
- ManagerName string? -
- EnableTextNotifications boolean? -
- Website string? -
- Twitter string? -
- ExpirationDate string? -
- JobRole string? -
- ExternalEmployeeId string? -
- ProfileType string? -
sap.successfactors.litmos: InlineResponse20027![](/images/permalink.svg)
Fields
- 'parameter string? -
sap.successfactors.litmos: InlineResponse20028![](/images/permalink.svg)
Fields
- Course InlineResponse20028Course[]? -
sap.successfactors.litmos: InlineResponse20028Course![](/images/permalink.svg)
Fields
- Id string? -
- Code string? -
- Name string? -
- Active boolean? -
- Complete boolean? -
- PercentageComplete int? -
- AssignedDate string? -
- StartDate string? -
- CompletedDate string? -
- UpToDate boolean? -
- Overdue boolean? -
- ComplaintTill string? -
- IsLearningPath boolean? -
- CourseCreatedDate string? -
- CourseCreator string? -
- OriginalId string? -
- ResultId string? -
- AccessTillDate string? -
sap.successfactors.litmos: InlineResponse20029![](/images/permalink.svg)
Fields
- LearningPath InlineResponse20029Learningpath[]? -
sap.successfactors.litmos: InlineResponse20029Learningpath![](/images/permalink.svg)
Fields
- Id string? -
- Name string? -
- Active boolean? -
- OriginalId string? -
- Complete boolean? -
- PercentageComplete int? -
- AssignedDate string? -
- StartDate string? -
- CompletedDate string? -
- ResultId string? -
- AccessTillDate string? -
sap.successfactors.litmos: InlineResponse2003![](/images/permalink.svg)
Fields
- Id string? -
- UserOriginalId string? -
- UserName string? -
- FirstName string? -
- LastName string? -
- Active boolean? -
- Email string? -
- AccessLevel string? -
- LoginKey string? -
- CourseId string? -
- CourseOriginalId string? -
- UpdatedDate string? -
- Code string? -
- CourseName string? -
- Complete boolean? -
- PercentageComplete string? -
- CompletedDate string? -
- UpToDate boolean? -
- Overdue boolean? -
- CompliantTillDate string? -
sap.successfactors.litmos: InlineResponse20030![](/images/permalink.svg)
Fields
- User InlineResponse20030User[]? -
sap.successfactors.litmos: InlineResponse20030User![](/images/permalink.svg)
Fields
- Id string? -
- UserName string? -
- FirstName string? -
- LastName string? -
- Active boolean? -
- Email string? -
- AccessLevel string? -
- Brand string? -
sap.successfactors.litmos: InlineResponse20031![](/images/permalink.svg)
Fields
- User InlineResponse20030User[]? -
sap.successfactors.litmos: InlineResponse2004![](/images/permalink.svg)
Fields
- 'parameter string? -
sap.successfactors.litmos: InlineResponse2005![](/images/permalink.svg)
Fields
- Module InlineResponse2005Module[]? -
sap.successfactors.litmos: InlineResponse2005Module![](/images/permalink.svg)
Fields
- Id string? -
- OriginalId string? -
- Name string? -
- Description string? -
- Active boolean? -
- Passmark int? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- ModuleType string? -
sap.successfactors.litmos: InlineResponse2006![](/images/permalink.svg)
Fields
- Course InlineResponse2006Course[]? -
sap.successfactors.litmos: InlineResponse2006Course![](/images/permalink.svg)
Fields
- Id string? -
- Code string? -
- Name string? -
- Active boolean? -
- ForSale boolean? -
- OriginalCourseId string? -
- Description string? -
- EcommerceShortDescription string? -
- EcommerceLongDescription string? -
- CourseCodeForBulkImport string? -
- Price int? -
- AccessTillDate string? -
- AccessTillDays int? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
- CompliantTillDays int? -
- TimeLimitDate string? -
- TimeLimitDays int? -
- DisplayOrder int? -
- IncludeInLibrary boolean? -
- CourseImageURL string? -
sap.successfactors.litmos: InlineResponse2007![](/images/permalink.svg)
Fields
- LearningPath InlineResponse2007Learningpath[]? -
sap.successfactors.litmos: InlineResponse2007Learningpath![](/images/permalink.svg)
Fields
- Id string? -
- Name string? -
- Description string? -
- Active boolean? -
- OriginalId string? -
- ForSale boolean? -
- Price int? -
- EcommerceShortDescription string? -
- EcommerceLongDescription string? -
- AccessTillDate string? -
- AccessTillDays int? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- DisplayOrder int? -
- IncludeInLibrary boolean? -
- IsCourseOptionalOrder boolean? -
- ImageURL string? -
sap.successfactors.litmos: InlineResponse2008![](/images/permalink.svg)
Fields
- ModuleResult InlineResponse2008Moduleresult[]? -
sap.successfactors.litmos: InlineResponse2008Moduleresult![](/images/permalink.svg)
Fields
- Id string? -
- UserId string? -
- OriginalModuleId string? -
- OriginalUserId string? -
- ModuleResultId string? -
- Active boolean? -
- Name string? -
- Passmark int? -
- Score int? -
- UserName string? -
- Completed boolean? -
- AttemptNumber int? -
- CreatedBy string? -
- FinishedDate string? -
- CreatedDate string? -
- StartedDate string? -
- TimeTaken string? -
- UpdatedDate string? -
- Code string? -
sap.successfactors.litmos: InlineResponse2009![](/images/permalink.svg)
Fields
- UserResult InlineResponse2009Userresult[]? -
sap.successfactors.litmos: InlineResponse2009Userresult![](/images/permalink.svg)
Fields
- Id string? -
- UserId string? -
- OriginalCourseId string? -
- OriginalUserId string? -
- Name string? -
- Active boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- StartedDate string? -
- Completed boolean? -
- PercentageComplete int? -
- CompletedDate string? -
- UpToDate string? -
- Overdue boolean? -
- CompliantTillDate string? -
- DueDate string? -
- LastAttemptDate string? -
- CreatedBy string? -
- UpdatedBy string? -
- Code string? -
- UserName string? -
- LearningPathAssignment boolean? -
- TeamAssignment boolean? -
sap.successfactors.litmos: LearningPath![](/images/permalink.svg)
Fields
- Id string -
- Name string? -
- Description string? -
- Active boolean? -
- OriginalId string? -
- ForSale boolean? -
- Price int? -
- EcommerceShortDescription string? -
- EcommerceLongDescription string? -
- AccessTillDate string? -
- AccessTillDays int? -
- IsEquivalency boolean? -
- LearningPathTeamLibrary boolean? -
sap.successfactors.litmos: LearningPaths![](/images/permalink.svg)
Fields
- LearningPath LearningPath[] -
sap.successfactors.litmos: Listing![](/images/permalink.svg)
Fields
- Id string -
- Name string -
- Active boolean -
- DurationType string -
- MaxUsers string -
- DurationDays int -
- FixedDate string -
- CollectionId string -
sap.successfactors.litmos: Listings![](/images/permalink.svg)
Fields
- Listings Listing[] -
sap.successfactors.litmos: ListingUser![](/images/permalink.svg)
Fields
- Id string -
- UserName string -
- FirstName string -
- LastName string -
- Active boolean? -
- Email string -
- AccessLevel string -
- Brand string -
sap.successfactors.litmos: ListingUsers![](/images/permalink.svg)
Fields
- ListingUser ListingUser[] -
sap.successfactors.litmos: LoginActivity![](/images/permalink.svg)
Fields
- ActivityType string? -
- UserId string? -
- OriginalUserId string? -
- UserName string? -
- IPAddress string? -
- LoginDate string? -
sap.successfactors.litmos: LoginActivitys![](/images/permalink.svg)
Fields
- LoginActivity LoginActivity[] -
sap.successfactors.litmos: Module![](/images/permalink.svg)
Fields
- Id string -
- Name string -
- Description string? -
- ModuleType int -
- Active boolean -
- Code string? -
- HideDescription boolean? -
- NewWindow boolean? -
- ReviewMode boolean? -
- ContentURL string -
sap.successfactors.litmos: ModuleResult![](/images/permalink.svg)
Fields
- CourseId string -
- UserId string -
- Score int -
- Completed boolean -
- UpdatedAt string -
- Note string -
- Attempts int -
sap.successfactors.litmos: Modules![](/images/permalink.svg)
Fields
- Module Module[] -
sap.successfactors.litmos: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
sap.successfactors.litmos: Session![](/images/permalink.svg)
Fields
- Id string -
- Name string -
- InstructorUserId string -
- SessionType int -
- Days Day[] -
- TimeZone string -
- Location string -
- LocationId int -
- StartDate string? -
- EndDate string? -
- Slots int? -
- Accepted string? -
- EnableWaitList boolean? -
sap.successfactors.litmos: SettingsActivity![](/images/permalink.svg)
Fields
- ActivityType string? -
- Category string? -
- ObjectType string? -
- ObjectId string? -
- OriginalObjectId string? -
- ObjectName string? -
- TargetObjectType string? -
- TargetObjectId string? -
- OriginalTargetObjectId string? -
- TargetObjectName string? -
- OldValue string? -
- NewValue string? -
- ActivityBy string? -
- ActivityByUserName string? -
- ActivityDate string? -
sap.successfactors.litmos: SettingsActivitys![](/images/permalink.svg)
Fields
- SettingsActivity SettingsActivity[] -
sap.successfactors.litmos: Team![](/images/permalink.svg)
Fields
- Id string -
- Name string -
- Description string? -
- TeamCodeForBulkImport string? -
- ParentTeamId string? -
sap.successfactors.litmos: Teams![](/images/permalink.svg)
Fields
- Team Team[] -
sap.successfactors.litmos: TeamsteamidcoursesCourse![](/images/permalink.svg)
Fields
- CourseId string? -
sap.successfactors.litmos: TeamsteamidlearningpathsLearningpath![](/images/permalink.svg)
Fields
- LearningPathId string? -
sap.successfactors.litmos: Token![](/images/permalink.svg)
Fields
- TokenId string -
- TokenCode string -
- TokenType int -
- TokenTypeId string -
- Active boolean -
- MaximumActivations int -
- TokenExpiration string -
sap.successfactors.litmos: Tokens![](/images/permalink.svg)
Fields
- Token Token[] -
sap.successfactors.litmos: User![](/images/permalink.svg)
Fields
- Id string -
- UserName string -
- FirstName string? -
- LastName string -
- FullName string? -
- Email string -
- AccessLevel string -
- DisableMessages boolean -
- Active boolean -
- Skype string? -
- PhoneWork string? -
- PhoneMobile string? -
- LastLogin string? -
- LoginKey string? -
- IsCustomUsername boolean -
- Password string? -
- SkipFirstLogin boolean -
- TimeZone string -
- SalesforceId string? -
- OriginalId string? -
- Street1 string? -
- Street2 string? -
- City string? -
- State string? -
- PostalCode string? -
- Country string? -
- SalesforceContactId string? -
- SalesforceAccountId string? -
- CreatedDate string? -
- Points int? -
- CompanyName string? -
- JobTitle string? -
- CustomField1 string? -
- CustomField2 string? -
- CustomField3 string? -
- CustomField4 string? -
- CustomField5 string? -
- CustomField6 string? -
- CustomField7 string? -
- CustomField8 string? -
- CustomField9 string? -
- CustomField10 string? -
- Culture string? -
- Brand string? -
- ManagerId string? -
- ManagerName string? -
- EnableTextNotification boolean? -
- Website string? -
- Twitter string? -
- ExpirationDate string? -
- JobRole string? -
- ExternalEmployeeId string? -
- ProfileType string? -
sap.successfactors.litmos: UserBulkImport![](/images/permalink.svg)
Fields
- Id string? -
- ImportDate string? -
- Status string? -
- TotalRecords int? -
- TotalUsersCreated int? -
- Failed int? -
- Duplicate int? -
- InvalidEmail int? -
- SendEmails boolean? -
- SkipFirstLogin boolean? -
sap.successfactors.litmos: UserBulkImports![](/images/permalink.svg)
Fields
- UserBulkImport UserBulkImport[] -
sap.successfactors.litmos: UserCollection![](/images/permalink.svg)
Fields
- Pagination record {} -
- Item Users[]? -
sap.successfactors.litmos: UserImport![](/images/permalink.svg)
Fields
- Username string? -
- Email string -
- FirstName string -
- LastName string -
- Password string? -
- Phone string? -
- Mobile string? -
- Skype string? -
- Title string? -
- CompanyName string? -
- WebSite string? -
- Twitter string? -
- Team1 string? -
- Team2 string? -
- Team3 string? -
- Team4 string? -
- Team5 string? -
- Course1 string? -
- Course2 string? -
- Course3 string? -
- Address1 string? -
- Address2 string? -
- City string? -
- State string? -
- Zip string? -
- Country string? -
- CustomField1 string? -
- CustomField2 string? -
- CustomField3 string? -
- CustomField4 string? -
- CustomField5 string? -
- CustomField6 string? -
- CustomField7 string? -
- CustomField8 string? -
- CustomField9 string? -
- CustomField10 string? -
- SalesforceId string? -
- SalesforceContactId string? -
- SalesforceAccountId string? -
- Active boolean? -
- InActiveDate string? -
- AccessLevel int? -
- Brand string? -
- Culture string? -
- Manager string? -
- UserCustomField1 string? -
- UserCustomField2 string? -
- UserCustomField3 string? -
- UserCustomField4 string? -
- UserCustomField5 string? -
- UserCustomField6 string? -
- UserCustomField7 string? -
- UserCustomField8 string? -
- UserCustomField9 string? -
- UserCustomField10 string? -
- UserCustomField11 string? -
- UserCustomField12 string? -
- UserCustomField13 string? -
- UserCustomField14 string? -
- UserCustomField15 string? -
- UserCustomField16 string? -
- UserCustomField17 string? -
- UserCustomField18 string? -
- UserCustomField19 string? -
- UserCustomField20 string? -
- UserCustomField21 string? -
- UserCustomField22 string? -
- UserCustomField23 string? -
- UserCustomField24 string? -
- UserCustomField25 string? -
- JobRole string? -
- ExternalEmployeeId string? -
sap.successfactors.litmos: UserImports![](/images/permalink.svg)
Fields
- UserImport UserImport[] -
sap.successfactors.litmos: Users![](/images/permalink.svg)
Fields
- User User[] -
sap.successfactors.litmos: UserscoursesUser![](/images/permalink.svg)
Fields
- Id string? -
sap.successfactors.litmos: UserSessionRegistrationStatus![](/images/permalink.svg)
Fields
- TotalUsersRegistered int? -
- Failed int? -
sap.successfactors.litmos: UsersuseridcoursesCourse![](/images/permalink.svg)
Fields
- Id string? -
Import
import ballerinax/sap.successfactors.litmos;
Metadata
Released date: about 1 year ago
Version: 1.3.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 0
Weekly downloads
Keywords
Human Resources/HRMS
Cost/Paid
Contributors