Introduction to Instances
Instances#
Introduction to Instances#
In the context of our Learning Management System (LMS), an instance represents a customized, parameterized version of a learning experience. A learning experience serves as a template—defining the structure, content, and core components (e.g., course outlines, materials, exams, or cohort frameworks). Instances allow authorized users or providers to create specific, configurable versions of these templates by populating or overriding predefined parameters.What is an Instance?#
An instance is a concrete realization of a learning experience, tailored to a specific use case. It is created by an authorized user or provider through an instantiator—a process that enables the configuration of the learning experience with specific inputs. These inputs can include:Dates (e.g., start/end dates for a course or exam)
Participant groups (e.g., cohorts of learners)
Custom settings (e.g., localized content, access restrictions, or grading criteria)
Use Cases for Instances#
A learning experience defines the course structure, materials, and assessments.
An instance configures the course for a specific semester, instructor, or student group.
A learning experience outlines the collaborative learning framework.
An instance assigns a specific group of learners to work through the framework together.
A learning experience defines the exam content and rules.
An instance sets the exam dates, time limits, and participant eligibility.
4.
Workshops or Training Sessions
A learning experience provides the agenda, resources, and objectives.
An instance customizes the session for a particular audience or location.
Key Features of Instances#
Parameterization: Instances are created by filling in or overriding parameters defined in the learning experience.
Isolation: Each instance operates independently, allowing for unique configurations and participant registrations.
Flexibility: Instances can be created, retrieved, deleted, and monitored via webhooks for real-time updates.
API Endpoints for Instances#
The following endpoints are available to manage instances programmatically:| Endpoint | Description |
|---|
POST /instances | Create a new instance of a learning experience. |
GET /instances/{id} | Retrieve details of a specific instance. |
DELETE /instances/{id} | Delete an existing instance. |
| Webhooks | |
instance.created | Triggered when a new instance is created. |
instance.updated | Triggered when an instance is updated. |
instance.deleted | Triggered when an instance is deleted. |
Why Use Instances?#
Scalability: Deploy the same learning experience across multiple contexts without duplication.
Customization: Tailor learning experiences to specific needs (e.g., regional requirements, language preferences).
Tracking: Monitor and manage each deployment independently for analytics, reporting, and compliance.
Modified at 2026-06-17 08:55:07
