Jump to Content
Home
API Reference
Guides
Home
Guides
API Reference
Changelog
v1.0
Home
API Reference
Guides
Log In
API Reference
Log In
v1.0
API Reference
OpenIdProvider
All
Pages
Start typing to search…
JUMP TO
OttoLearn OData API Reference
Reward
Create a new Reward.
post
List Rewards.
get
Get a Reward.
get
Update a Reward.
patch
List a User's Rewards.
post
List Rewards for Learners.
get
Redeem a Reward.
post
Check Reward Order Status.
get
Get User Reward.
get
Rewards
List Reward items for a specific Reward.
get
Add Reward items to an existing Reward.
post
Get a specific Reward Item.
get
Update a Reward Item.
patch
List Reward Contents.
get
Add Reward Content.
post
Get Reward Content.
get
Update Reward Content.
patch
Analytics
Get historical Learner Concept assignment data grouped by Concept.
post
Get historical Learner Topic assignment data grouped by Topic.
post
Get the Knowledge Gap and Knowledge Lift grouped by Concept.
post
Get the Knowledge Gap and Knowledge Lift grouped by Topic.
post
Get Engagement and Assignment stats for Learners.
post
Get Knowledge Card stats for a requested date range.
post
Get the current count of assigned Knowledge Cards from a given Content level and below.
post
Get the Knowledge Gap and Knowledge Lift grouped by Module.
post
Get Knowledge Card stats grouped by Mastery Level at a specific Content level.
post
Get the Knowledge Gap and Knowledge Lift grouped by Module Mastery Levels
post
Get the Knowledge Gap and Knowledge Lift for a date range.
post
Get historical Knowledge Card stats grouped by Content.
post
Get historical Learner Module assignment data grouped by Module.
post
Get historical Learner Module assignment data grouped by month.
post
Get historical Engagement data grouped by month.
post
Get historical Engagement data for a specific date range.
post
List current Learner Module Assignment stats grouped by Module.
post
Get current Learner Module Assignment stats.
post
List Learner Module assignment stats for requested dates.
post
Activity
List all Activity drafts within an Organization.
get
Create a new Activity draft
post
Get the details of a specific Activity draft.
get
Update an existing Activity draft.
patch
Get the content of a specific Activity draft.
get
Add Activity Draft Content
post
Get specific content of an Activity Draft.
get
Update existing content for an Activity Draft.
patch
Publish an Activity draft
post
Publish an Activity draft (Bound to an Activity Draft entity)
post
Get Activity Answers Drafts
get
Add an Activity Answer draft
post
Get the details of a specific Activity Draft's Answer
get
Update an existing Activity Answer draft
patch
Get the content of a specific Activity draft Answer.
get
Add content to an Activity Answer draft.
post
List all published Activities.
get
Get a published Activity.
get
Get the next available Activity Identifier.
get
Attribute
List all Custom Attributes.
get
Create a new custom Attribute.
post
Get a custom Attribute.
get
Update an existing custom Attribute.
patch
Delete an existing custom Attribute.
del
List all System Attributes.
get
Get a System Attribute.
get
AttributeList
List all Attribute lists.
get
Create a new Attribute list.
post
Get an existing Attribute List.
get
Update an existing Attribute list.
put
Add an item to an Attribute List.
post
Update an Attribute list item.
put
Remove an existing List item.
del
Concept
List all Concepts.
get
Create a new Concept.
post
Get an existing Concept.
get
Update an existing Concept.
put
List contents of a specific Concept.
get
Add Concept Content.
post
Get specific content of a Concept.
get
Update Concept Content.
patch
Remove Concept Content.
del
List the prerequisites of an existing Concept.
get
Add a prerequisite to an existing Concept.
post
Get the details of a single Concept prerequisite.
get
Update the details of a Concept prerequisite.
put
Remove a Concept prerequisite.
del
Get the next available Concept Identifier.
get
Mastery
List all Mastery Profiles assigned to a User.
get
List all Modules of a User's assigned Mastery Profile.
get
List all Topics of a User's assigned Module.
get
List all Concepts of a User's assigned Topic.
get
List all Activities of a User's assigned Concepts.
get
List all User's assigned Knowledge Card Contents.
get
Get the authenticated User's Mastery.
get
Get the Mastery summary of a Mastery Profile.
get
Get the Mastery summary of a Module.
get
Get the Mastery summary of a Topic.
get
Get the Mastery summary of a Concept.
get
List User Mastery Profiles Mastery Summaries
get
List User Modules Mastery Summaries
get
List User Topics Mastery Summaries
get
List User Concepts Mastery Summaries
get
List User Activities Mastery Summaries
get
Search for Mastery content.
get
Get the authenticated User's Recommended Learning
get
Get Mastery Report
get
Track Knowledge Card Event.
post
MasteryMoment
Create a new Mastery Moment.
post
Update the results of a Mastery Moment Activity.
post
Set the feedback duration of a Mastery Moment Activity.
post
MasteryProfile
List all Mastery Profiles within an Organization.
get
Create a new Mastery Profile
post
Get an individual Mastery Profile by Id.
get
Update an existing Mastery Profile.
patch
List contents of a specific Mastery Profile.
get
Add Mastery Profile Content.
post
Get specific content of a Mastery Profile.
get
Update Mastery Profile Content.
patch
Remove Mastery Profile Content.
del
List all Modules of a specific Mastery Profile.
get
Add a Module to a Mastery Profile.
post
Get Mastery Profile Module data.
get
Update a Mastery Profile's Module relationship.
put
Remove a Module from a Mastery Profile.
del
List all child Modules of a specified Mastery Profile Module.
get
Get a specific child Module.
get
Add a prerequisite Module to a Mastery Profile Module.
post
Remove an existing parent Module.
del
List all Mastery Profile exports.
get
Create Mastery Profile export.
post
Get Mastery Profile export.
get
Module
List all Modules in the Organization.
get
Create a Module.
post
Get an individual Module.
get
Update an existing Module.
patch
Get a specific Module language.
get
Update an existing Module language.
patch
Remove a Module language.
del
List all Module languages.
get
Add a Module language.
post
List contents of a specific Module.
get
Add Module Content.
post
Get specific content of a Module.
get
Update Module Content.
patch
Remove Module Content.
del
Get the next Module identifier.
get
Organization
Get information for the authenticated Organization.
get
Update Organization settings.
patch
Get the Metadata for an Organization
get
Get Account Information.
get
Timezone
List all Timezones.
get
Get a Timezone.
get
Topic
List all Topics.
get
Create a new Topic.
post
Get a Topic.
get
Update a Topic.
patch
List contents of a specific Topic.
get
Add Topic Content.
post
Get specific content of a Topic.
get
Update Topic Content.
patch
Remove Topic Content.
del
List Topic prerequisites.
get
Add a Topic prerequisite.
post
Get a Topic prerequisite (parent Topic).
get
Remove a Topic prerequisite (parent Topic).
del
Get the next available Topic identifier.
get
User
List all Users.
get
Create a new User.
post
Batch update Users.
patch
Get a single User.
get
Update an existing User.
patch
List all Mastery Profiles assigned to a User.
get
Unassign Mastery Profiles.
del
Assign Mastery Profiles to a User.
post
Bulk Update Mastery Profiles Assignments
patch
Get the Mastery summary for a User.
get
List a User's Mastery Profiles Mastery summary.
get
Get the Mastery summary for a User's Mastery Profile.
get
List the Mastery summary for a User's Modules.
get
Get the Mastery summary for a User's Module.
get
List the Mastery summary for a User's Topics.
get
Get the Mastery summary for a User's Topic.
get
List the Mastery summary for a User's Concepts.
get
Get the Mastery summary for a User's Concept.
get
Get a User's engagement summary.
get
List all User's Collections.
get
Assign Collections to a User.
post
Unassign Collections.
del
Engagement
List all Engagement Schedules.
get
Create an Engagement Schedule.
post
Get an Engagement Schedule.
get
Update an Engagement Schedule.
patch
Media
Get a media library item.
get
Update an existing media item.
patch
List all media items.
get
Create a media item.
post
List all media libraries within the Organization.
get
Create a new media library.
post
Get an individual media library.
get
Update an existing media library.
put
OpenIdProvider
List all OpenId providers.
get
Create a new OpenID provider.
post
Update an existing OpenID provider.
patch
Get an OpenId provider.
get
Language
Translate
post
Lists all languages
get
KnowledgeCard
List all Knowledge Cards.
get
Create a new Knowledge Card.
post
Get a Knowledge Card.
get
Update an existing Knowledge Card.
patch
Collection
List Collections
get
Create a new Collection
post
Get the next available Collection Identifier.
get
Get a Collection
get
Update an existing Collection.
patch
List all contents of a specific Collection.
get
Add a Content in a specific Collection.
post
Get a specific content of a specific Collection.
get
Update a Content in a specific Collection.
patch
Remove Collection Content.
del
List all assigned Leaderboards of a specific Collection.
get
Assign an existing leaderboard to a specific Collection.
post
Get a specific leaderboard of a specific Collection.
get
Update assigned Leaderboard in a specific Collection.
post
Unassign a Leaderboard from a specific Collection.
del
Get the count of Active Collections.
get
Leaderboard
List all Leaderboards.
get
Create a Leaderboard.
post
Get a Leaderboard
get
Update an existing Leaderboard.
patch
List specific Leaderboard Contest.
get
Create a Contest of specific Leaderboard.
post
Get the Contest of a Leaderboard
get
Update an existing Leaderboard's Contest.
patch
List contents of a specific Leaderboard's Contest.
get
Add Content in a specific Leaderboard's Contest.
post
Get a specific content of a specific Leaderboard's Contest.
get
Update a Content in a specific Leaderboard's Contest.
patch
Remove Leaderboard's Contest Content.
del
List specific Leaderboard Standings.
get
Get Results of a specific Leaderboard's Contest.
get
List Open Learner Leaderboards.
get
List already Closed Learner Leaderboards.
get
List Leaderboards User Summaries.
get
Update User value in specific Leaderboard.
post
Get the next available Leaderboard Identifier.
get
Action
List all Actions.
get
Create a new Action.
post
Get a specific Action.
get
Update an Action.
patch
List all Action Instructions.
get
Create a new Action Instruction.
post
Get a specific Action Instruction.
get
Update an existing Action Instruction .
patch
List all Actions Trigger Rule.
get
Create a new Action Trigger Rule.
post
Get a specific Action Trigger Rule.
get
Update an existing Action Trigger Rule.
patch
Points
List all Point Action Keys.
get
List all User Point Journals.
get
Get specific User Point Journal.
get
List all Entries of specific User Point Journal.
get
Get specific Entry of User Point Journal.
get
Update specific Entry of User Point Journal.
patch
Add new Entry in User Point Journal.
patch
Category
List all Categories.
get
Create a Category.
post
Get a Category
get
Update an existing Category.
patch
Remove a Category.
del
List all contents of a specific Category.
get
Add a Content in a specific Category.
post
Get a specific content of a specific Category.
get
Update a Content in a specific Category.
patch
Remove Category Content.
del
List Mastery Profiles of a Category
get
Add Mastery Profile to a Category.
post
Update Category's Mastery Profile settings.
patch
Remove a Mastery Profile from a Category.
del
Get the next available Category Identifier.
get
OttoLearn Authentication API Reference
Authentication
Login to OttoLearn.
post
Logout of OttoLearn.
post
OpenIdConnect
Login to OttoLearn.
post
Powered by
OpenIdProvider
Ask AI
