sap.successfactors.litmos
Module sap.successfactors.litmos
API
Definitions
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
sap.successfactors.litmos: Client
This is a generated connector for SAP SuccessFactors Litmos API v1.7 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
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials. Create and configure an OAuth2 client credentials by following this guide.
init (ApiKeysConfig apiKeyConfig, string serviceUrl, ClientConfiguration clientConfig)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- serviceUrl string - URL of the target service
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
getAchievements
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
function addaStatement(string contentType, string litmosDomain, string dBinstance, string payload) returns json|error
Add a Statement
Return Type
- json|error - Ok
updateaStatement
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
function getaStatement(string litmosDomain, string dBinstance, string statementId) returns json|error
Get a Statement
Return Type
- json|error - OK
getaListofallCoursesAssignedtoTeam
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
function createasubTeam(string teamId, string 'source, string contentType, Team payload, string? format) returns Response|error
Create a Sub-Team
Records
sap.successfactors.litmos: Achievement
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
Fields
- Course Achievement[]? -
sap.successfactors.litmos: ActionActivity
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
Fields
- ActionActivity ActionActivity[] -
sap.successfactors.litmos: ApiKeysConfig
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
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
Fields
- AssignmentActivity AssignmentActivity[] -
sap.successfactors.litmos: Body
Fields
- Course CollectionscollectionidcoursesCourse[]? -
sap.successfactors.litmos: Body1
Fields
- Id string? -
sap.successfactors.litmos: Body10
Fields
- User InlineResponse20030User[]? -
sap.successfactors.litmos: Body2
Fields
- LearningPath CollectionscollectionidlearningpathsLearningpath[]? -
sap.successfactors.litmos: Body3
Fields
- Id string? -
sap.successfactors.litmos: Body4
Fields
- LearningPath TeamsteamidlearningpathsLearningpath[]? -
sap.successfactors.litmos: Body5
Fields
- 'parameter string? -
sap.successfactors.litmos: Body6
Fields
- Course UsersuseridcoursesCourse[]? -
sap.successfactors.litmos: Body7
Fields
- User UserscoursesUser[]? -
sap.successfactors.litmos: Body8
Fields
- LearningPath UsersuseridcoursesCourse[]? -
sap.successfactors.litmos: Body9
Fields
- Course TeamsteamidcoursesCourse[]? -
sap.successfactors.litmos: Collection
Fields
- Name string -
- Description string -
- DefaultListing boolean? -
- ImageURL string? -
sap.successfactors.litmos: Collections
Fields
- ListingUser Collection[]? -
sap.successfactors.litmos: CollectionscollectionidcoursesCourse
Fields
- CourseId string? -
- SeqId int? -
sap.successfactors.litmos: CollectionscollectionidlearningpathsLearningpath
Fields
- LearnigPathId string? -
- SeqId int? -
sap.successfactors.litmos: ContentActivity
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
Fields
- ContentActivity ContentActivity[] -
sap.successfactors.litmos: Course
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
Fields
- ImportId string? -
- ImportDate string? -
- Status string? -
- TotalRecords int? -
- TotalCoursesCreated int? -
- Failed int? -
sap.successfactors.litmos: CourseCustomField
Fields
- CustomFieldId string? -
- Label string? -
- DefaultValue string? -
- Mandatory boolean? -
- VisibleToLearner boolean? -
- Type string? -
- Dropdown record {}[]? -
sap.successfactors.litmos: CourseCustomFields
Fields
- CourseCustomField CourseCustomField[] -
sap.successfactors.litmos: CourseImport
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
Fields
- CourseImport CourseImport[]? -
sap.successfactors.litmos: Courses
Fields
- Course Course[]? -
sap.successfactors.litmos: Day
Fields
- Id string -
- StartDate string -
- EndDate string -
- StartTime string -
- EndTime string -
- SendReminder boolean -
- ReminderValue int -
- ReminderMetric string -
sap.successfactors.litmos: EventUser
Fields
- Id string -
- EventStatus int -
- FirstName string -
- LastName string -
- Email string -
- CompanyName string -
- Score int -
- Completed boolean -
sap.successfactors.litmos: EventUsers
Fields
- Team EventUser[]? -
sap.successfactors.litmos: InlineResponse200
Fields
- Username string? -
- ImporStatus string? -
sap.successfactors.litmos: InlineResponse2001
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
Fields
- LearningPathResult InlineResponse20010Learningpathresult[]? -
sap.successfactors.litmos: InlineResponse20010Learningpathresult
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
Fields
- Achievement InlineResponse20011Achievement[]? -
sap.successfactors.litmos: InlineResponse20011Achievement
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
Fields
- CourseModule InlineResponse20012Coursemodule[]? -
sap.successfactors.litmos: InlineResponse20012Coursemodule
Fields
- CourseId string? -
- Id string? -
- OriginalCourseId string? -
- OriginalModuleId string? -
- Active boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse20013
Fields
- LearningPathCourse InlineResponse20013Learningpathcourse[]? -
sap.successfactors.litmos: InlineResponse20013Learningpathcourse
Fields
- LearningPathId string? -
- Id string? -
- OriginalLearningPathId string? -
- OriginalCourseId string? -
- Active boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse20014
Fields
- UserCourse InlineResponse20014Usercourse[]? -
sap.successfactors.litmos: InlineResponse20014Usercourse
Fields
- UserId string? -
- Id string? -
- OriginalUserId string? -
- OriginalCourseId string? -
- Active boolean? -
- CreatedDate string? -
- UpdatedDate string? -
- CreatedBy string? -
- UpdatedBy string? -
sap.successfactors.litmos: InlineResponse20015
Fields
- LearningPathUser InlineResponse20015Learningpathuser[]? -
sap.successfactors.litmos: InlineResponse20015Learningpathuser
Fields
- LearningPathId string? -
- Id string? -
- OriginalLearningPathId string? -
- Active boolean? -
- OriginalUserId string? -
- CreatedBy string? -
- CreatedDate string? -
- UpdatedBy string? -
- UpdatedDate string? -
sap.successfactors.litmos: InlineResponse20016
Fields
- Team InlineResponse20016Team[]? -
sap.successfactors.litmos: InlineResponse20016Team
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
Fields
- TeamUser InlineResponse20017Teamuser[]? -
sap.successfactors.litmos: InlineResponse20017Teamuser
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
Fields
- TeamCourse InlineResponse20018Teamcourse[]? -
sap.successfactors.litmos: InlineResponse20018Teamcourse
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
Fields
- TeamLearningPath InlineResponse20019Teamlearningpath[]? -
sap.successfactors.litmos: InlineResponse20019Teamlearningpath
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
Fields
- Id string? -
- UserName string? -
- FirstName string? -
- LastName string? -
- Completed boolean? -
- PercentageComplete string? -
- CompliantTill string? -
- DueDate string? -
sap.successfactors.litmos: InlineResponse20020
Fields
- User InlineResponse20020User[]? -
sap.successfactors.litmos: InlineResponse20020User
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
Fields
- Courses InlineResponse20021Courses[]? -
sap.successfactors.litmos: InlineResponse20021Course
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
Fields
- Course InlineResponse20021Course? -
sap.successfactors.litmos: InlineResponse20022
Fields
- LearningPaths InlineResponse20022Learningpaths[]? -
sap.successfactors.litmos: InlineResponse20022Learningpath
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
Fields
- LearningPath InlineResponse20022Learningpath? -
sap.successfactors.litmos: InlineResponse20023
Fields
- TotalBadgesEarned int? -
- TotalPointsEarned int? -
sap.successfactors.litmos: InlineResponse20024
Fields
- Id string? -
- Title string? -
- Description string? -
- Icon string? -
- IconBadgeColor string? -
sap.successfactors.litmos: InlineResponse20025
Fields
- User InlineResponse20025User[]? -
sap.successfactors.litmos: InlineResponse20025User
Fields
- Id string? -
- Username string? -
- FirstName string? -
- LastName string? -
- Active boolean? -
- Email string? -
- AccessLevel string? -
- Brand string? -
sap.successfactors.litmos: InlineResponse20026
Fields
- User InlineResponse20026User[]? -
sap.successfactors.litmos: InlineResponse20026User
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
Fields
- 'parameter string? -
sap.successfactors.litmos: InlineResponse20028
Fields
- Course InlineResponse20028Course[]? -
sap.successfactors.litmos: InlineResponse20028Course
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
Fields
- LearningPath InlineResponse20029Learningpath[]? -
sap.successfactors.litmos: InlineResponse20029Learningpath
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
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
Fields
- User InlineResponse20030User[]? -
sap.successfactors.litmos: InlineResponse20030User
Fields
- Id string? -
- UserName string? -
- FirstName string? -
- LastName string? -
- Active boolean? -
- Email string? -
- AccessLevel string? -
- Brand string? -
sap.successfactors.litmos: InlineResponse20031
Fields
- User InlineResponse20030User[]? -
sap.successfactors.litmos: InlineResponse2004
Fields
- 'parameter string? -
sap.successfactors.litmos: InlineResponse2005
Fields
- Module InlineResponse2005Module[]? -
sap.successfactors.litmos: InlineResponse2005Module
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
Fields
- Course InlineResponse2006Course[]? -
sap.successfactors.litmos: InlineResponse2006Course
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
Fields
- LearningPath InlineResponse2007Learningpath[]? -
sap.successfactors.litmos: InlineResponse2007Learningpath
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
Fields
- ModuleResult InlineResponse2008Moduleresult[]? -
sap.successfactors.litmos: InlineResponse2008Moduleresult
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
Fields
- UserResult InlineResponse2009Userresult[]? -
sap.successfactors.litmos: InlineResponse2009Userresult
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
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
Fields
- LearningPath LearningPath[] -
sap.successfactors.litmos: Listing
Fields
- Id string -
- Name string -
- Active boolean -
- DurationType string -
- MaxUsers string -
- DurationDays int -
- FixedDate string -
- CollectionId string -
sap.successfactors.litmos: Listings
Fields
- Listings Listing[] -
sap.successfactors.litmos: ListingUser
Fields
- Id string -
- UserName string -
- FirstName string -
- LastName string -
- Active boolean? -
- Email string -
- AccessLevel string -
- Brand string -
sap.successfactors.litmos: ListingUsers
Fields
- ListingUser ListingUser[] -
sap.successfactors.litmos: LoginActivity
Fields
- ActivityType string? -
- UserId string? -
- OriginalUserId string? -
- UserName string? -
- IPAddress string? -
- LoginDate string? -
sap.successfactors.litmos: LoginActivitys
Fields
- LoginActivity LoginActivity[] -
sap.successfactors.litmos: Module
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
Fields
- CourseId string -
- UserId string -
- Score int -
- Completed boolean -
- UpdatedAt string -
- Note string -
- Attempts int -
sap.successfactors.litmos: Modules
Fields
- Module Module[] -
sap.successfactors.litmos: Session
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
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
Fields
- SettingsActivity SettingsActivity[] -
sap.successfactors.litmos: Team
Fields
- Id string -
- Name string -
- Description string? -
- TeamCodeForBulkImport string? -
- ParentTeamId string? -
sap.successfactors.litmos: Teams
Fields
- Team Team[] -
sap.successfactors.litmos: TeamsteamidcoursesCourse
Fields
- CourseId string? -
sap.successfactors.litmos: TeamsteamidlearningpathsLearningpath
Fields
- LearningPathId string? -
sap.successfactors.litmos: Token
Fields
- TokenId string -
- TokenCode string -
- TokenType int -
- TokenTypeId string -
- Active boolean -
- MaximumActivations int -
- TokenExpiration string -
sap.successfactors.litmos: Tokens
Fields
- Token Token[] -
sap.successfactors.litmos: User
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
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
Fields
- UserBulkImport UserBulkImport[] -
sap.successfactors.litmos: UserCollection
Fields
- Pagination record {} -
- Item Users[]? -
sap.successfactors.litmos: UserImport
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
Fields
- UserImport UserImport[] -
sap.successfactors.litmos: Users
Fields
- User User[] -
sap.successfactors.litmos: UserscoursesUser
Fields
- Id string? -
sap.successfactors.litmos: UserSessionRegistrationStatus
Fields
- TotalUsersRegistered int? -
- Failed int? -
sap.successfactors.litmos: UsersuseridcoursesCourse
Fields
- Id string? -
Import
import ballerinax/sap.successfactors.litmos;
Metadata
Released date: almost 3 years ago
Version: 1.0.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 2
Current verison: 0
Weekly downloads
Keywords
Human Resources/HRMS
Cost/Paid
Contributors