Entities
- Academic Term
- Annotation
- Conversation
- Conversation Message
- Course Grade
- Course Offering
- Course Section
- Course Section Enrollment
- Discussion
- Discussion Entry
- File
- Grading Period
- Grading Period Grade
- Grading Period Group
- Learner Activity
- Learner Activity Group
- Learner Activity Group Grade
- Learner Activity Override
- Learner Activity Result
- Learner Group
- Learner Group Membership
- Learning Environment Organization
- Learning Outcome
- Learning Outcome Group
- Learning Outcome Item Response
- Learning Outcome Result
- Learning Outcome Rubric Criteria
- Module
- Module Item
- Module Item Completion
- Module Progression
- Participant Session
- Participant Session Role
- Person
- Quiz
- Quiz Item
- Quiz Item Group
- Quiz Item Response
- Quiz Result
- Role
- Wiki
- Wiki Page
Academic Term
This entity is required.
Entity filename: academic_term.csv
.
A calendar session in which classes are instructed.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Academic Term. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Academic Term, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
sis_ext_id |
A global key generated by the SIS used match records between the LMS and SIS. See the SIS's Academic Term Entity . | No | No | text |
name |
The human readable name for the academic term. | No | No | text |
le_term_begin_date |
From the learning environment, the date and time when the academic term formally begins. | No | No | date |
le_term_end_date |
From the learning environment, the date and time when the academic term formally ends. | No | No | date |
term_type |
The type of Academic term. (option set) | No | No | text |
Annotation
This entity is required.
Entity filename: annotation.csv
.
A web resource with a body, which is a comment or other descriptive resource, and a single target that the body is somehow about.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Annotation. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Annotation, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
learner_activity_result_id |
The Learner activity result in which this Annotation was made. See Learner Activity Result. | No | Yes | integer |
author_id |
The Person record who originally authored the Annotation. See Person. | No | Yes | integer |
author_name |
The name of the Person who originally authored the Annotation. | No | No | text |
body_value |
The contents of the Annotation's body. | No | No | text |
created_date |
The date on which the Annotation was originally created. | No | No | timestamp |
updated_date |
The date on which the Annotation was last updated. | No | No | timestamp |
is_anonymous |
Denotes whether the Annotation was made anonymously. | No | No | boolean |
has_teacher_only_comments |
Indicates whether the Annotation is from a teacher ('true') or not ('false'). | No | No | boolean |
is_hidden |
Indicates whether the Annotation is hidden from view by students. | No | No | boolean |
message_size_bytes |
The message size, in bytes, of the Annotation. | No | No | integer |
message_character_count |
The number of characters in the Annotation. | No | No | integer |
message_word_count |
The number of words in the Annotation. | No | No | integer |
message_line_count |
The number of lines in the Annotation. | No | No | integer |
Conversation
This entity is required.
Entity filename: conversation.csv
.
An interchange of concepts or ideas between two or more actors in an unstructured manner without a defined topic.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Conversation. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Conversation, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
course_offering_id |
The Course offering context in which the conversation took place, if any. See Course Offering. | No | Yes | integer |
learner_group_id |
The Learner group context in which the conversation took place, if any. See Learner Group. | No | Yes | integer |
has_attachments |
Denotes whether the Conversation has any attachments. | No | No | boolean |
has_media_objects |
Denotes whether the Conversation has any media objects. | No | No | boolean |
subject |
The subject of the conversation, if any. | No | No | text |
Conversation Message
This entity is required.
Entity filename: conversation_message.csv
.
A discrete piece of information sent as part of a Conversation.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Conversation Message. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Conversation Message, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
conversation_id |
The Conversation in which the message took place. See Conversation. | No | Yes | integer |
course_offering_id |
The Course offering context in which the Conversation message took place, if any. See Course Offering. | No | Yes | integer |
learner_group_id |
The Learner group context in which the Conversation message took place, if any. See Learner Group. | No | Yes | integer |
author_id |
The author of the message. See Person. | No | Yes | integer |
created_date |
The date on which the message was first created. | No | No | timestamp |
is_system_generated |
Denotes whether the message was automatically generated by a system, rather than a Person. | No | No | boolean |
has_attachments |
Denotes whether the message contains any attachments. | No | No | boolean |
has_media_objects |
Denotes whether the message contains any media objects. | No | No | text |
body |
The contents of the message. | No | No | text |
message_size_bytes |
The message size in bytes. | No | No | integer |
message_character_count |
The message length in characters. | No | No | integer |
message_word_count |
The message length in words. | No | No | integer |
message_line_count |
The message length in lines. | No | No | integer |
Course Grade
This entity is required.
Entity filename: course_grade.csv
.
The grade that a learner receives as part of their participation in a given Course section enrollment.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
person_id |
The Person to whom this Course grade is given. See Person. | Yes | Yes | integer |
course_section_id |
The Course section for which the Course grade is given. See Course Section. | Yes | Yes | integer |
created_date |
The date on which the Course grade was first created. | No | No | timestamp |
updated_date |
The date on which the Course grade was most recently updated. | No | No | timestamp |
le_current_score |
The most recently calculated and visible score. | No | No | decimal |
le_final_score |
The final calculated and visible score. | No | No | decimal |
le_hidden_current_score |
The most recently calculated score that is not yet visible. | No | No | decimal |
le_hidden_final_score |
The final calculated score that is not yet visible. | No | No | decimal |
le_final_score_status |
The status of the Course grade (option set) | No | No | text |
Course Offering
This entity is required.
Entity filename: course_offering.csv
.
An institutional offering of organized subject matter and learner activities chosen by learners in an academic term.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Course Offering. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Course Offering, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
sis_ext_id |
A global key generated by the SIS used match records between the LMS and SIS. See the SIS's Course Offering Entity . | No | No | text |
learning_environment_organization_id |
The Learning environment organization to which this course belongs. See Learning Environment Organization. | No | Yes | integer |
academic_term_id |
The Academic term in which the Learning outcome item response exists. See Academic Term. | No | Yes | integer |
le_code |
The course code associated with the course in the learning environment. | No | No | text |
title |
The title of the Course Offering. | No | No | text |
le_status |
From the learning environment, the workflow state of the Course offering, usually in relation to its availability for teaching and learning. (option set) | No | No | text |
created_date |
The date the Course offering was created. | No | No | timestamp |
le_start_date |
Per the learning environment, the date and time when the Course offering formally begins. | No | No | date |
le_end_date |
Per the learning environment, the date and time when the Course offering formally ends. | No | No | date |
is_public |
Indicates whether the Course offering is publicly visible. | No | No | boolean |
syllabus_content |
The syllabus content for this Course offering. | No | No | text |
Course Section
This entity is required.
Entity filename: course_section.csv
.
An administrative and instructional sub-organization of a Course offering. Instructors may be assigned to one or more sections of a particular Course offering.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Course Section. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Course Section, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
sis_ext_id |
A global key generated by the SIS used match records between the LMS and SIS. See the SIS's Course Section Entity . | No | No | text |
course_offering_id |
The course offering to which this Course section belongs. See Course Offering. | Yes | Yes | integer |
le_current_course_offering_id |
In the learning environment, cross listing can happen that is not reflected in the SIS. le_current_course_offering_id is a non-coalesced value showing the current course shell hierarchy in the LMS. See Course Offering. | No | Yes | integer |
le_original_course_offering_id |
In the learning environment, an instructor may cross-list a course section under a course offering separate from the one assigned by the SIS. In this case, the course offering ID from the learning environment changes. When an instructor cross-lists their course section under another course offering, the original_course_offering_id captures the original course_offering_id for this course_section (which should be identical to the one provided by the SIS). See Course Offering. | No | Yes | integer |
le_name |
The name of the course section in the learning environment. | No | No | text |
status |
The workflow state of the Course section, usually in relation to its availability for teaching and learning. (option set) | No | No | text |
created_date |
The date & time that the Course section was created. | No | No | timestamp |
updated_date |
The date & time that the Course section was updated. | No | No | timestamp |
is_accepting_enrollments |
If true, the Course section is accepting enrollments. | No | No | boolean |
is_default |
If true, the Course section is the default Course section. | No | No | boolean |
Course Section Enrollment
This entity is required.
Entity filename: course_section_enrollment.csv
.
The association of a Person to a Course section, usually defined by a particular role.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
person_id |
The Person to whom this Course section enrollment applies. See Person. | Yes | Yes | integer |
course_section_id |
The foreign key to the Course section to which this Course section enrollment belongs. See Course Section. | Yes | Yes | integer |
role |
The role of the Person in the Section, as defined by a UCDM option set. (option set) | Yes | No | text |
role_status |
The status of the Person in their role as a member of this Course section. (option set) | Yes | No | text |
enrollment_status |
The status of the enrollment in the learning environment of this Course section. (option set) | No | No | text |
le_is_self_enrolled |
True or false, derived from the learning environment; if true, then the student enrolled himself or herself in the course section via the learning environment as opposed to being enrolled through an official institutional roster. | No | No | boolean |
created_date |
The date & time that the Course section enrollment was created. | No | No | timestamp |
updated_date |
The date & time that the Course section enrollment was updated. | No | No | timestamp |
entry_date |
The timestamp when the Person started this role in the Course section. | No | No | timestamp |
exit_date |
The timestamp indicating when the Person ended this role in the Course section. | No | No | timestamp |
completed_date |
The date & time that the Course section enrollment was completed by the student. | No | No | timestamp |
Discussion
This entity is required.
Entity filename: discussion.csv
.
An interchange of concepts or ideas between two or more actors in a structured manner with a defined topic.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Discussion. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Discussion, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
author_id |
The Person who originally authored the Discussion. See Person. | No | Yes | integer |
editor_id |
The Person who most recently edited the Discussion. See Person. | No | Yes | integer |
course_offering_id |
The Course offering in which the Discussion is delivered. See Course Offering. | No | Yes | integer |
learner_group_id |
The Learner group in which the Discussion is delivered. See Learner Group. | No | Yes | integer |
learner_activity_id |
The Learner activity of which the Discussion is part. See Learner Activity. | No | Yes | integer |
title |
The title of the Discussion. | No | No | text |
body |
The body (content) of the Discussion. | No | No | text |
message_length |
The number of characters of the Discussion's Body. | No | No | integer |
type |
The Discussion topic type, values can include 'blank' and 'announcement'. (option set) | No | No | text |
status |
The current status of the Discussion. (option set) | No | No | text |
last_reply_date |
The date on which the Discussion's most recent Discussion entry was created. | No | No | timestamp |
created_date |
The date on which the Discussion was first created. | No | No | timestamp |
updated_date |
The date on which the Discussion was last updated. | No | No | timestamp |
delayed_post_date |
The date on which the Discussion was delayed posting. | No | No | timestamp |
posted_date |
The date on which the Discussion was posted. | No | No | timestamp |
deleted_date |
The date on which the Discussion was deleted. | No | No | timestamp |
discussion_type |
The type of discussion: 'default(blank)', 'side_comment', 'threaded'. Threaded indicates that replies are threaded where side_comment indicates that replies in the discussion are flat. (option set) | No | No | text |
is_pinned |
Denotes whether the Discussion is pinned or not. | No | No | boolean |
is_locked |
Denotes whether the Discussion is locked or not. | No | No | boolean |
Discussion Entry
This entity is required.
Entity filename: discussion_entry.csv
.
A response to a given Discussion, given by a single Person.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Discussion Entry. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Discussion Entry, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
parent_discussion_entry_id |
The parent Discussion entry of the current Discussion entry, if applicable in a threaded discussion. See Discussion Entry. | No | Yes | integer |
person_id |
The Discussion entry author. See Person. | No | Yes | integer |
discussion_id |
The Discussion in which this entry is located. See Discussion. | No | Yes | integer |
body |
The body (content) of the Discussion entry. | No | No | text |
message_length |
The length of the Discussion entry's Body, in number of characters. | No | No | integer |
status |
The current status of the Discussion entry. (option set) | No | No | text |
position |
The position of the Discussion entry relative to other Discussion entries for this Discussion. | No | No | integer |
created_date |
The date on which the Discussion entry was first created. | No | No | timestamp |
updated_date |
The date on which the Discussion entry was most recently updated. | No | No | timestamp |
deleted_date |
The date on which the Discussion entry was deleted. | No | No | timestamp |
File
This entity is required.
Entity filename: file.csv
.
An object that contains information in a self-contained manner. Files may be documents, images, recordings, and so on.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this File. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this File, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
uploader_id |
The Person who originally uploaded the File. See Person. | No | Yes | integer |
owner_id |
The Person who owns the File, if different than the uploader. See Person. | No | Yes | integer |
learner_activity_id |
The Learner activity to which the File is associated. See Learner Activity. | No | Yes | integer |
learner_activity_result_id |
The learner activity result to which the File is associated. See Learner Activity Result. | No | Yes | integer |
learner_activity_group_id |
The learner activity group to which the File is associated. See Learner Activity Group. | No | Yes | integer |
quiz_id |
The Quiz with which the File is associated. See Quiz. | No | Yes | integer |
quiz_result_id |
The Quiz result with which the File is associated. See Quiz Result. | No | Yes | integer |
conversation_id |
The Conversation in which the File was attached. See Conversation. | No | Yes | integer |
conversation_message_id |
The particular Conversation message in which the File was attached. See Conversation Message. | No | Yes | integer |
conversation_person_id |
The Person who uploaded the File in the Conversation. See Person. | No | Yes | integer |
course_offering_id |
The Course offering to which the File is associated. See Course Offering. | No | Yes | integer |
learner_group_id |
The Learner group with which the File is associated. See Learner Group. | No | Yes | integer |
replacement_file_id |
The File for which this File is a replacement. See File. | No | Yes | integer |
root_file_id |
The File of which the given File is a child. See File. | No | Yes | integer |
display_name |
The name displayed for the File. | No | No | text |
owner_entity_type |
The type of Entity that owns the File. Values may include: learner activity, conversation message, course offering, learner group, quiz, quiz result, learner activity result, and person. | No | No | text |
content_type |
The type of content that defines the File. | No | No | text |
md5 |
The MD5 hash that uniquely identifies the contents of the File. | No | No | text |
status |
The current status of the File. (option set) | No | No | text |
can_be_locked |
Denotes whether the File may be locked or not. | No | No | boolean |
is_locked |
Denotes whether the File is locked or not. | No | No | boolean |
locked_date |
The date on which the File was locked. | No | No | timestamp |
unlocked_date |
The date on which the File was unlocked. | No | No | timestamp |
viewed_date |
The date on which the File was last viewed. | No | No | timestamp |
created_date |
The date on which the File was initially created. | No | No | timestamp |
updated_date |
The date on which the File was last updated. | No | No | timestamp |
deleted_date |
The date on which the File was deleted. | No | No | timestamp |
wiki_id |
The Wiki with which the File is associated. See Wiki. | No | Yes | integer |
size |
The size, in bytes, of the File. | No | No | decimal |
Grading Period
This entity is required.
Entity filename: grading_period.csv
.
A defined length of time that will culminate in a grade.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Grading Period. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Grading Period, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
grading_period_group_id |
The group to which the Grading period belongs. See Grading Period Group. | No | Yes | integer |
title |
The title of the Grading period. | No | No | text |
close_date |
The date on which the Grading period closes. | No | No | timestamp |
created_date |
The date on which the Grading period was initially created. | No | No | timestamp |
end_date |
The date on which the Grading period ends. | No | No | timestamp |
start_date |
The date on which the Grading period begins. | No | No | timestamp |
updated_date |
The date on which the Grading period was most recently updated. | No | No | timestamp |
status |
The status of the Grading period. | No | No | text |
weight |
The weighting of the Grading period against other Grading periods in the Course offering. | No | No | text |
Grading Period Grade
This entity is required.
Entity filename: grading_period_grade.csv
.
The grade awarded to a Person for a given Grading period.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Grading Period Grade. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Grading Period Grade, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
person_id |
The Person to whom this Grading period grade is given. See Person. | No | Yes | integer |
course_section_id |
The Course section for which the grading period grade is given. See Course Section. | No | Yes | integer |
grading_period_id |
The Grading period for which the grade is given. See Grading Period. | No | Yes | integer |
grading_period_group_id |
The Grading period group for which the grade is given. See Grading Period Group. | No | Yes | integer |
le_current_score |
The most recent and visible calculated grade. | No | No | text |
le_final_score |
The finalized and visible calculated grade. | No | No | text |
le_hidden_current_score |
The most recent calculated grade, before it is made visible. | No | No | text |
le_hidden_final_score |
The finalized calculated grade, before it is made visible. | No | No | text |
created_date |
The date on which the Grading period grade was first created. | No | No | timestamp |
updated_date |
The date on which the Grading period grade was last updated. | No | No | timestamp |
status |
The current status of the Grading period grade. (option set) | No | No | text |
Grading Period Group
This entity is required.
Entity filename: grading_period_group.csv
.
A grouping of related Grading periods.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Grading Period Group. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Grading Period Group, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
course_offering_id |
The Course offering in which the Grading period group exists. See Course Offering. | No | Yes | integer |
created_date |
The date on which the Grading period group was first created. | No | No | timestamp |
title |
The title of the Grading period group. | No | No | text |
updated_date |
The date on which the Grading period group was last updated. | No | No | timestamp |
status |
The current status of the Grading period group. (option set) | No | No | text |
Learner Activity
This entity is required.
Entity filename: learner_activity.csv
.
An assignment, task, piece of work, or other activity that is as part of a course of study.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learner Activity. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learner Activity, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
course_offering_id |
The Course offering Id to which this learner activity belongs. See Course Offering. | Yes | Yes | integer |
learner_activity_group_id |
The identifier of the Learner activity group to which this Learner activity belongs. See Learner Activity Group. | No | Yes | integer |
title |
The title or name of the learner activity. | No | No | text |
description |
The description of the learner activity, described in a way that the learner can understand. | No | No | text |
is_lockable |
True, false; if true, then the module may be locked by authorized roles. | No | No | boolean |
due_date |
The date the learner activity is due. | No | No | timestamp |
unlocked_date |
The date and time on which the learner activity is unlocked. | No | No | timestamp |
locked_date |
The date and time on which the learner activity is locked. | No | No | timestamp |
grade_type |
The method used to assess the learner activity. This is a metric type from which a score is derived. (option set) | No | No | text |
allowable_submission_types |
The valid submission type(s) for the Learner activity. Presented as a comma-separated list if more than one type is allowed. | No | No | text |
status |
Current status of the learner activity (option set) | No | No | text |
created_date |
The date & time the learner activity was created. | No | No | timestamp |
updated_date |
The date & time the learner activity was updated. | No | No | timestamp |
peer_review_count |
The number of peers assigned to review a Learner activity result for this Learner activity, if using algorithmic assignment. | No | No | integer |
peer_reviews_due_date |
The date & time when peer reviews of the Learner activity's Learner activity results must be completed. | No | No | timestamp |
has_peer_reviews_assigned |
Indicates whether peer reviewing is enabled for this Learner activity. | No | No | boolean |
has_peer_reviews |
Indicates whether peer reviewing is enabled for this Learner activity. | No | No | boolean |
is_automatic_peer_reviews |
Indicates whether peer reviews are automatically assigned via an algorithm (as opposed to instructor-assigned peer review.) | No | No | boolean |
is_all_day |
Indicates whether the student has all day to complete the Learner activity, in which case the Learner activity result must be submitted before midnight. | No | No | boolean |
all_day_date |
The date which the Learner activity is due. | No | No | timestamp |
is_grade_group_students_individually |
Indicates whether students who submit Learner activity results for this Learner activity as a group will still receive an individual grade. | No | No | boolean |
is_anonymous_peer_reviews |
Indicates whether the Learner activity results for this Learner activity are anonymously peer reviewed. | No | No | boolean |
is_hidden |
Indicates whether students can see grades on the Learner activity or not. | No | No | boolean |
position |
The position of the Learner activity in a Learner activity group. | No | No | integer |
visibility |
The visibility of the Learner activity to students in a Course section. Possible values can include, for example, that the Learner activity is visible to everyone or to only subsets of students. (option set) | No | No | text |
points_possible |
The maximum number of points that can be earned on this Learner activity. | No | No | decimal |
drop_rule |
Indicates whether and how the Learner activity can be dropped from a Learner activity group. | No | No | text |
Learner Activity Group
This entity is required.
Entity filename: learner_activity_group.csv
.
A group of learner activities as part of a course design.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learner Activity Group. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learner Activity Group, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
course_offering_id |
The Course offering Id to which this Learner activity group belongs. See Course Offering. | Yes | Yes | integer |
name |
Name of the Learner activity group. | No | No | text |
default_learner_activity_name |
The default name to assign to the Learner activities that fall under this group. | No | No | text |
status |
Current state of the learner activity group. (option set) | No | No | text |
position |
The position of the Learner activity group in a Course offering. | No | No | integer |
created_date |
The date on which the Learner activity group was first created. | No | No | timestamp |
updated_date |
The date on which the Learner activity group was last updated. | No | No | timestamp |
group_weight |
The weighting of the Learner activity group against other groups in the Course offering. | No | No | integer |
drop_lowest_amount |
Number of lowest scored assignments which can be dropped from the group. Set to '0' when none should be dropped. Defauts to '0'. | No | No | integer |
drop_highest_amount |
Number of highest scored assignments which can be dropped form the group. Set to '0' when none should be dropped. Defaults to '0'. | No | No | integer |
Learner Activity Group Grade
This entity is required.
Entity filename: learner_activity_group_grade.csv
.
The score awarded to a Person in a particular Learner activity group.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learner Activity Group Grade. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learner Activity Group Grade, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
learner_activity_group_id |
The Learner activity group for which the group score is given. See Learner Activity Group. | No | Yes | integer |
person_id |
The learner that received the group grade See Person. | Yes | Yes | integer |
created_date |
The date on which the Learner activity group grade was first created. | No | No | timestamp |
updated_date |
The date on which the Learner activity group grade was last updated. | No | No | timestamp |
status |
The current status of the Learner activity group grade. (option set) | No | No | text |
le_current_score |
The most recently calculated and visible grade. | No | No | text |
le_final_score |
The final and visible grade. | No | No | text |
le_hidden_current_score |
The most recently calculated grade that is not yet visible. | No | No | text |
le_hidden_final_score |
The finalized grade that is not yet visible. | No | No | text |
Learner Activity Override
This entity is required.
Entity filename: learner_activity_override.csv
.
A rule or set of rules that overrides the default conditions of a learner activity for a particular audience of students.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learner Activity Override. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learner Activity Override, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
learner_activity_id |
Foreign key to the learner activity with which the override is associated. See Learner Activity. | No | Yes | integer |
course_section_id |
Foreign key to the Course section with which the override is associated. See Course Section. | No | Yes | integer |
learner_group_id |
Foreign key to the the Learner group with which the override is associated. See Learner Group. | No | Yes | integer |
quiz_id |
Foreign key to the assessment with which the override is associated. See Quiz. | No | Yes | integer |
all_day_type |
Indicates whether this Learner activity override's "Due date as a day" value overrides the Learner activity's "Due date as a day" value. (option set) | No | No | text |
all_day_date |
The date version of the due date if the IsDueOnDay attribute is true. | No | No | timestamp |
learner_activity_version |
The version of the learner activity to which this override applies. | No | No | text |
created_date |
The date on which the learner activity override was created. | No | No | timestamp |
due_date |
The new due date if the "Due date is overridden" value is True. | No | No | timestamp |
overridden_due_date |
True if a learner activity's original "Due date" value has been overridden. | No | No | boolean |
locked_date |
The new Locked date if the "Locked date is overridden" value is true. | No | No | timestamp |
overridden_locked_date |
True if a learner activity's original "Locked date" value has been overridden. | No | No | boolean |
type |
Defines to which Entity the learner activity override is applied. (option set) | No | No | text |
title |
The title of the learner activity override. | No | No | text |
unlocked_date |
The new Unlocked date if the "Unlocked date is overridden" value is True. | No | No | timestamp |
overridden_unlocked_date |
True if a learner activity's original "Unlocked date" value has been overridden. | No | No | boolean |
updated_date |
The date & time the learner activity override was updated. | No | No | timestamp |
quiz_version |
The version of the assessment to which this override applies. | No | No | text |
status |
Current state of the learner activity override. (option set) | No | No | text |
Learner Activity Result
This entity is required.
Entity filename: learner_activity_result.csv
.
The result of a learner engagement with a learner activity.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learner Activity Result. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learner Activity Result, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
learner_activity_id |
Foreign key to Learner activity of which this is a result. See Learner Activity. | Yes | Yes | integer |
person_id |
Foreign key to person who submitted the learner activity result. See Person. | Yes | Yes | integer |
grader_id |
Foreign key to the person who graded the learner activity result. See Person. | No | Yes | integer |
learner_group_id |
Foreign key to the learner group table See Learner Group. | No | Yes | integer |
quiz_id |
Foreign key to the Quiz with which this Learner activity result is associated. See Quiz. | No | Yes | integer |
quiz_result_id |
Foreign key to the Quiz result Id to which this Learner activity result is associated. See Quiz Result. | No | Yes | integer |
body |
Text content for the Learner activity result. | No | No | text |
url |
URL content for the Learner activity result. | No | No | text |
grade |
Letter grade mapped from the score by the grading scheme. | No | No | text |
response_date |
Timestamp of when the Learner activity result was was submitted | No | No | timestamp |
type |
Type of Learner activity result. Possible values are 'discussion_topic', 'external_tool', 'media_recording', 'online_file_upload', 'online_quiz', 'online_text_entry', 'online_upload' and 'online_url'. (option set) | No | No | text |
grading_status |
Denotes where the Learner activity result is in the grading process. (option set) | No | No | text |
created_date |
The date on which the Learner activity result was created. | No | No | timestamp |
updated_date |
The date & time the Learner activity result was updated. | No | No | timestamp |
is_processed |
Pertinent when there is a File associated with the Learner activity result. By default, this attribute is 'false'. When a Learner activity result has a File associated with it, upon submitting the Learner activity a snapshot is saved and its value is set to 'true'. Defaults to 'NULL'. | No | No | boolean |
process_attempts |
The number of times Learner activity results have been attempted. | No | No | integer |
gradebook_status |
Indicates whether the current result is the one used in calculating gradebook scores. (option set) | No | No | text |
published_grade |
Strings that reflect the grading type used. | No | No | text |
graded_date |
Timestamp of when the Learner activity result was graded. | No | No | timestamp |
has_rubric_assessment |
Pertinent only for graded Learner activity results. Its value is set to 'true' if the Learner activity result is associated with a Rubric that has been assessed for at least one student, otherwise is set to 'false'. Defaults to 'NULL'. | No | No | boolean |
attempt |
The number of attempts made to submit the Learner activity result, including this one. | No | No | integer |
has_admin_comment |
Indicates whether the Learner activity result has an administrator comment attached to it. | No | No | boolean |
is_excused |
Indicates whether this Learner activity result is excused or not. | No | No | boolean |
is_grade_anonymously |
Indicates whether the Learner activity result was graded anonymously or not. | No | No | boolean |
grade_state |
Indicates the state of the grade for this Learner activity result. Values may include, for example, not graded, auto graded, and human graded. | No | No | text |
score |
Numberic grade given to the Learner activity result. | No | No | decimal |
what_if_score |
The most recent score that the student projected for themselves to earn in a "what if" scenario for the learner activity to which this learner activity result belongs. If the student doesn't enter a "what if" score, this value is NULL. (option set) | No | No | text |
published_score |
Numerical value of the actual score. | No | No | decimal |
submission_comments_count |
The number of comment(s) written by the grader on the Learner activity result. | No | No | integer |
posted_at |
The date and time that the learner activity result was posted to the student. Value is null if it has not been posted. | No | No | timestamp |
Learner Group
This entity is required.
Entity filename: learner_group.csv
.
A pedagogically-oriented group of learners in a course. This concept is distinct from Course section, which is an administrative grouping of learners.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learner Group. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learner Group, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
course_offering_id |
The Course offering Id to which this learner activity belongs. See Course Offering. | No | Yes | integer |
name |
The name of the Learner group. | No | No | text |
description |
A description of the particular Learner group. | No | No | text |
created_date |
The date on which the learner group was created. | No | No | timestamp |
updated_date |
The date on which the learner group was updated. | No | No | timestamp |
deleted_date |
The date on which the learner group was deleted. | No | No | timestamp |
is_public_contents |
Indicates whether any user may access the contents of the group (e.g., files). | No | No | boolean |
status |
Status of the learner group. (option set) | No | No | text |
context_type |
The type of learning context in which this Learner group is situated. This could be a Course, Account, etc. | No | No | text |
category |
The group's description by its users. | No | No | text |
join_level |
The criteria required to join a Learner group. This can be automatic joining, by invitation only, etc. | No | No | text |
default_view |
The default presentation view for Learner groups. | No | No | text |
max_membership |
Maximum number of users that can be accommodated in a group. | No | No | integer |
storage_quota |
Storage limit allowed per group. | No | No | text |
Learner Group Membership
This entity is required.
Entity filename: learner_group_membership.csv
.
The role in which a Person participates in a Learner group.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learner Group Membership. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learner Group Membership, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
learner_group_id |
The Learner group in which the role exists. See Learner Group. | No | Yes | integer |
person_id |
The Person participating in the Leaner group. See Person. | No | Yes | integer |
is_moderator |
Denotes if the Person is a moderator for the Learner group. | No | No | boolean |
status |
The current status of the Learner group membership. | No | No | text |
created_date |
The date on which the Learner group membership was first created. | No | No | timestamp |
updated_date |
The date on which the Learner group membership was last updated. | No | No | timestamp |
Learning Environment Organization
This entity is required.
Entity filename: learning_environment_organization.csv
.
The learning environment organization or account.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learning Environment Organization. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learning Environment Organization, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
name |
The name of the learning environment organization. | No | No | text |
status |
The status of the learning environment organization. Takes an option. set. (option set) | No | No | text |
parent_learning_environment_organization_id |
The parent learning environment organization for this learning environment organization. See Learning Environment Organization. | No | Yes | integer |
grandparent_learning_environment_organization_id |
The grandparent learning environment organization for this learning environment organization. See Learning Environment Organization. | No | Yes | integer |
Learning Outcome
This entity is required.
Entity filename: learning_outcome.csv
.
Measurable statements that express student knowledge or a student skill.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learning Outcome. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learning Outcome, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
course_offering_id |
The Course offering in which the Learning outcome is assessed. See Course Offering. | No | Yes | integer |
academic_term_id |
The Academic term in which the Learning outcome is assessed. See Academic Term. | No | Yes | integer |
learning_environment_organization_id |
The Learning environment organization to which this Learning outcome belongs. See Learning Environment Organization. | No | Yes | integer |
short_desc |
A short description or title of the Learning outcome. | No | No | text |
description |
A fully-formed description of the Learning outcome and its objectives. | No | No | text |
status |
The current status of the Learning outcome. | No | No | text |
created_date |
The date on which the Learner outcome was first created. | No | No | timestamp |
updated_date |
The date on which the Learner outcome was last updated. | No | No | timestamp |
vendor_guid |
The globally unique id (GUID) by which the Learning outcome is referred to. | No | No | text |
display_name |
The name of the Learning outcome, as displayed in the LMS. | No | No | text |
calculation_method |
The method by which the Learning outcome is calculated. | No | No | text |
calculation_int |
If needed for the calculation method, the value of the variable. | No | No | text |
mastery_points |
The minimum number of points the learner must receive to achieve mastery in the Learning outcome. | No | No | integer |
points_possible |
The maximum number of points that a learner can receive on a Learning outcome. | No | No | decimal |
Learning Outcome Group
This entity is required.
Entity filename: learning_outcome_group.csv
.
A grouping of related Learning outcomes.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learning Outcome Group. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learning Outcome Group, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
parent_learning_outcome_group_id |
The parent Learning outcome group for this Learning outcome group. See Learning Outcome Group. | No | Yes | integer |
learning_environment_organization_id |
The Learning environment organization to which this Learning outcome group belongs. See Learning Environment Organization. | No | Yes | integer |
course_offering_id |
The Course offering in which the Learning outcome group exists. See Course Offering. | No | Yes | integer |
academic_term_id |
The Academic term in which the Learning outcome group exists See Academic Term. | No | Yes | integer |
title |
The title of the Learning outcome group. | No | No | text |
parent_group_id |
The Learning outcome group that is the parent of this group. See Learning Outcome Group. | No | Yes | integer |
root_group_id |
The Learning outcome group that is associated with the root group in the group hierarchy. See Learning Outcome Group. | No | Yes | integer |
status |
The workflow status of the learning outcome. Possible values are 'active' and 'deleted'. Defaults to 'active'. | No | No | text |
description |
The description of the learning outcome group. | No | No | text |
created_date |
The date & time the Learning outcome group was created. | No | No | timestamp |
updated_date |
The date & time the Learning outcome group was updated. | No | No | timestamp |
vendor_guid |
A custom GUID for the learning standard. | No | No | text |
Learning Outcome Item Response
This entity is required.
Entity filename: learning_outcome_item_response.csv
.
The result of a learner responding to a Learning outcome question.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learning Outcome Item Response. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learning Outcome Item Response, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
person_id |
The Person in which the Learning outcome item response exists. See Person. | No | Yes | integer |
course_offering_id |
The Course offering in which the Learning outcome item response exists. See Course Offering. | No | Yes | integer |
academic_term_id |
The Academic term in which the Learning outcome item response exists. See Academic Term. | No | Yes | integer |
learning_outcome_id |
The Learning outcome in which the Learning outcome item response exists. See Learning Outcome. | No | Yes | integer |
quiz_id |
The Quiz with which the Learning outcome item response is associated. See Quiz. | No | Yes | integer |
quiz_item_id |
The Quiz item with which the Learning outcome item response is associated. See Quiz Item. | No | Yes | integer |
title |
The title of the Learning outcome item response. | No | No | text |
created_date |
The date & time the Learning outcome item response was created. | No | No | timestamp |
updated_date |
The date & time the Learning outcome item response was updated. | No | No | timestamp |
assessed_date |
The date & time the Learning outcome item response was assessed. | No | No | timestamp |
submitted_date |
The date & time the Learning outcome item response was submitted. | No | No | timestamp |
has_mastery |
A boolean indicating whether user achieved mastery for this question | No | No | boolean |
score |
The student's score on the question. | No | No | text |
number_attempts |
The total number of attempts, or learner activity results. | No | No | integer |
points_possible |
Total number of points possible. | No | No | decimal |
original_score |
The student's score on the first attempt. | No | No | text |
has_original_mastery |
A boolean value indicating whether user achieved mastery. | No | No | boolean |
percent |
Percent of maximum points possible for a Learning outcome, scaled to reflect any custom mastery levels that differ from the learning outcome. | No | No | integer |
Learning Outcome Result
This entity is required.
Entity filename: learning_outcome_result.csv
.
The result of a learner being assessed on a Learner outcome.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learning Outcome Result. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learning Outcome Result, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
course_offering_id |
The Course offering in which the Learning outcomes result takes place. See Course Offering. | No | Yes | integer |
academic_term_id |
The Academic term in which the Learning outcome result takes place. See Academic Term. | No | Yes | integer |
learner_activity_id |
Foreign key to the Learner activity with which the Learning outcome result exists. See Learner Activity. | No | Yes | integer |
quiz_id |
The Quiz with which the Learning outcome result is associated. See Quiz. | No | Yes | integer |
learning_outcome_id |
The Learning outcome with which the Learning outcome result is associated See Learning Outcome. | No | Yes | integer |
person_id |
The Person who made the Learning activity result against which this Learning outcome is related. See Person. | No | Yes | integer |
created_date |
The date & time the Learning outcome result was created. | No | No | timestamp |
updated_date |
The date & time the Learning outcome result was update. | No | No | timestamp |
assessed_date |
The date & time the Learning outcome result was assessed. | No | No | timestamp |
submitted_date |
The date & time the Learning outcome result was submitted. | No | No | timestamp |
is_hide_points |
A boolean value indicating if Learning outcome result points should be hidden in the Learning Mastery Gradebook and reports. If enabled, then replace the points with the description of the highest scoring outcome criterion rating. | No | No | boolean |
is_hidden |
A boolean value indicating whether the Learning outcome result should be hidden from the Learning Mastery Gradebook and reports. | No | No | boolean |
has_mastery |
A boolean indicating whether user achieved mastery. | No | No | boolean |
score |
The user's score on the Lerning outcome result. | No | No | text |
attempts |
The total number of attempts, or learning activity results, by the user. | No | No | integer |
points_possible |
Total number of points possible. | No | No | decimal |
original_score |
The student's score on the first attempt. | No | No | text |
original_possible |
The total nubmer of possible points on the student's first attempt. | No | No | integer |
has_original_mastery |
A boolean value indicating whether user achieved mastery. | No | No | boolean |
percent |
Percent of maximum points possible for a Learning outcome, scaled to reflect any custom mastery levels that differ from the learning outcome. | No | No | integer |
Learning Outcome Rubric Criteria
This entity is required.
Entity filename: learning_outcome_rubric_criteria.csv
.
The criteria by which a learner will be assessed on a given Learning outcome.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Learning Outcome Rubric Criteria. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Learning Outcome Rubric Criteria, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
learning_outcome_id |
The Learning outcome in which the Learning outcome rubric criteria exists. See Learning Outcome. | No | Yes | integer |
course_offering_id |
The Course offering in which the Learning outcome rubric criteria is used. See Course Offering. | No | Yes | integer |
academic_term_id |
The Academic term in which the Learning outcome rubric criteria is used. See Academic Term. | No | Yes | integer |
description |
A description of the rubric Learning outcome criterion. | No | No | text |
points_possible |
The total number of possible points associated with the rubric criterion. | No | No | decimal |
Module
This entity is required.
Entity filename: module.csv
.
A means of organizing content to help control the flow of a course.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Module. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Module, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
course_offering_id |
The Course offering in relation to which the Module exists. See Course Offering. | No | Yes | integer |
sequential |
A value indicating whether the Module items of this Module must be completed sequentially? Valid values are 'required', 'not_required', 'unspecified'. | No | No | text |
status |
The workflow state for the Module. Possible values are 'locked', 'completed', 'unlocked' and 'started'. (option set) | No | No | text |
position |
The position of the Module among other Modules in the Course offering. | No | No | integer |
name |
The name of the Module. | No | No | text |
created_date |
The date & time the Module was created. | No | No | timestamp |
deleted_date |
The date & time the Module was deleted. | No | No | timestamp |
unlocked_date |
The date & time the Module was unlocked. | No | No | timestamp |
updated_date |
The date & time the Module was updated. | No | No | timestamp |
prerequisite_module_id |
The prerequisite Module for the Module. See Module. | No | Yes | integer |
Module Item
This entity is required.
Entity filename: module_item.csv
.
A specific piece of course content in a Module.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Module Item. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Module Item, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
learner_activity_id |
The Learner activity referenced by the Module item. See Learner Activity. | No | Yes | integer |
course_offering_id |
The Course offering in which this Module item is located. See Course Offering. | No | Yes | integer |
discussion_id |
The Discussion referenced by the Module item. See Discussion. | No | Yes | integer |
person_id |
If the Module item is associated with a Discussion, File, Quiz, or Page, then this Person Id references the author of the Discussion, File, Quiz, or Page. See Person. | No | Yes | integer |
file_id |
The File referenced by the Module item. See File. | No | Yes | integer |
module_id |
The parent Module of the the Module item. See Module. | No | Yes | integer |
quiz_id |
The Quiz referenced by the Module item. See Quiz. | No | Yes | integer |
wiki_page_id |
The Page referenced by the Module item. See Wiki Page. | No | Yes | integer |
type |
The type of content linked to from this Module item. This can be a Learner activity, Attachment, Discussion topic, External tool, External URL, Learning outcome, Quiz, Rubric, Page, or Module subheader. (option set) | No | No | text |
status |
The workflow status of the Module item. (option set) | No | No | text |
position |
The position of the Module item among other Module items in the Module. | No | No | integer |
title |
The title of the Module item. | No | No | text |
url |
The URL associated with the Module item, if the Module item is an External URL or External tool. | No | No | text |
created_date |
The date & time the Module item was created. | No | No | timestamp |
updated_date |
The date & time the Module item was updated. | No | No | timestamp |
completion_type |
Describes the type of completion event that must be achieved to consider item complete. | No | No | text |
min_score |
If the completion type requires a minimum score, then this is the score that must be attained for completion. | No | No | text |
Module Item Completion
This entity is required.
Entity filename: module_item_completion.csv
.
An indication that a Person has completed a particular Module item.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Module Item Completion. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Module Item Completion, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
module_progression_id |
The Module progression referenced by the Module item completion. See Module Progression. | No | Yes | integer |
module_item_id |
The Module item referenced by the Module item completion. See Module Item. | No | Yes | integer |
requirement_type |
Describes the type of completion event that must be achieved to consider item complete. | No | No | text |
completion_status |
Denotes whether the completion event is complete or not. Possible values are 'complete' and 'incomplete'. | No | No | text |
min_score |
If the completion type requires a minimum score, then this is the score that must be attained for completion. | No | No | text |
score |
If the completion type requires a minimum score, this is the score that the user has currently achieved for completion. | No | No | text |
Module Progression
This entity is required.
Entity filename: module_progression.csv
.
The progress that a Person has made towards completing a specific Module.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Module Progression. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Module Progression, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
module_id |
The Module for the Module progression. See Module. | No | Yes | integer |
person_id |
The Person whose Module progression this is. See Person. | No | Yes | integer |
is_collapsed |
Whether or not the Module progression is collapsed for the user. | No | No | boolean |
is_current |
The current state of the Module progression for the user. | No | No | boolean |
status |
The workflow state of the Module progression for the user (option set) | No | No | text |
current_position |
The user's current position in the Module. | No | No | integer |
lock_version |
The lock version of the Module progression. | No | No | text |
created_date |
The date & time the Module progression was created. | No | No | timestamp |
completed_date |
The date & time the Module progression was completed. | No | No | timestamp |
evaluated_date |
The date & time the Module progression was evaluated. | No | No | timestamp |
updated_date |
The date & time the Module progression was updated. | No | No | timestamp |
Participant Session
This entity is required.
Entity filename: participant_session.csv
.
A session in which Persons participate, such as a conference.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Participant Session. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Participant Session, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
learner_group_id |
The Learner group referenced by the Participant session. See Learner Group. | No | Yes | integer |
course_offering_id |
The Course offering referenced by the Participant session See Course Offering. | No | Yes | integer |
title |
The title of the Participant session. | No | No | text |
type |
The Participant session type – usually, this refers to the type of tool used to deliver the Participant session. | No | No | text |
scheduled_start_time |
The date & time that the Participant session is scheduled to start. | No | No | timestamp |
actual_start_time |
The date & time that the Participant session actually started. | No | No | timestamp |
scheduled_end_time |
The date & time that the Participant session is scheduled to end. | No | No | timestamp |
actual_end_time |
The date & time that the Participant session actually ended. | No | No | timestamp |
created_date |
The date & time the Participant session was created. | No | No | timestamp |
updated_date |
The date & time the Participant session was updated. | No | No | timestamp |
duration |
The actual duration, in milliseconds, of the Participant session. | No | No | integer |
Participant Session Role
This entity is required.
Entity filename: participant_session_role.csv
.
The role in which a Person acts in a given Participant session.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Participant Session Role. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Participant Session Role, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
person_id |
The Person who participanted in the Participation session. See Person. | No | Yes | integer |
participant_session_id |
The Participant session in which the participant participated. See Participant Session. | No | Yes | integer |
role |
The role of the Person who participated in the Participant session. (option set) | No | No | text |
created_date |
The date & time the Participant session role was created. | No | No | timestamp |
updated_date |
The date & time the Participant session role was updated. | No | No | timestamp |
Person
This entity is required.
Entity filename: person.csv
.
An individual participating, in any capacity, in the design, delivery, or evaluation of teaching and learning processes and environments.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Person. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Person, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
sis_ext_id |
A global key generated by the SIS used match records between the LMS and SIS. See the SIS's Person Entity . | No | No | text |
le_account_status |
The status of the Person's account in the learning environment. (option set) | No | No | text |
name |
The name of the person in the learning environment. This may be a full name, a given name, or any other identifier such a nickname or email. | No | No | text |
Quiz
This entity is required.
Entity filename: quiz.csv
.
A class of learner activity used to assess learner content mastery.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Quiz. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Quiz, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
learner_activity_id |
Foreign key to Learner activity of this Quiz. See Learner Activity. | No | Yes | integer |
course_offering_id |
The Course offering to which this Quiz belongs. See Course Offering. | Yes | Yes | integer |
title |
The title of the Quiz. | No | No | text |
points_possible |
The maximum number of points that can be earned. | No | No | decimal |
description |
The description of the Quiz. | No | No | text |
type |
The type of Quiz. (option set) | No | No | text |
status |
Denotes where the Quiz is in its workflow. (option set) | No | No | text |
scoring_policy |
Scoring policy for a Quiz that students can take multiple times. Is required and only valid if allowed_attempts > 1. (option set) | No | No | text |
is_allow_anonymous_submissions |
Indicates whether students are allowed to submit the quiz anonymously. | No | No | boolean |
is_display_multiple_questions |
Indicates whether multiple Quiz items are displayed at a time. | No | No | boolean |
is_shuffled_answer_display_order |
Indicates whether the answers for Quiz items are displayed in a consistent order or shuffled. | No | No | boolean |
is_allow_go_back_to_previous_question |
Indicates whether the user may go back to previous Quiz items or may only go forward. Only valid if Display multiple Quiz items? is 'false'. | No | No | boolean |
is_can_be_locked |
Indicates whether the Quiz can be locked. | No | No | boolean |
is_browser_lockdown_required |
Indicates whether the browser must be locked-down when the Quiz is taken. | No | No | boolean |
is_browser_lockdown_required_to_display_results |
True or false; if true, the browser must be locked down to display the results. | No | No | boolean |
is_browser_lockdown_monitor_required |
True or false; if true, a browser lockdown monitor is required. | No | No | boolean |
ip_filter |
Restricts access to the Quiz to computers in a specified IP address range. | No | No | text |
show_results |
Indicates whether Quiz results are shown to students. If Quiz results are always shown, then students can see their results after any attempt. If Quiz results are never shown, then students can never see their results. If students are allowed more than one Quiz attempt, then if Quiz results are always shown after the last attempt, students can always see their results but only after the last attempt. If students are allowed to see their Quiz results and the value is set to only show students once after their last attempt, then students are show their Quiz results once after their last attempt. | No | No | text |
correct_answers_display_policy |
The policy on displaying correct answers to students; takes an option set. (option set) | No | No | text |
show_correct_answers_date |
The date and time when the correct answers are shown to students. | No | No | timestamp |
hide_correct_answers_date |
The date and time when the correct answers are hidden from students. | No | No | timestamp |
created_date |
The date & time that the Quiz was created. | No | No | timestamp |
updated_date |
The date & time that the Quiz was updated. | No | No | timestamp |
published_date |
The date & time that the Quiz was published. | No | No | timestamp |
unlocked_date |
The date & time that the Quiz was unlocked for studnets. | No | No | timestamp |
locked_date |
The date & time that the Quiz was locked for students. | No | No | timestamp |
due_date |
The date & time that the Quiz was due. | No | No | timestamp |
deleted_date |
The date & time that the Quiz was deleted. | No | No | timestamp |
time_limit |
The amount of time, in minutes, that the student is given to complete the Quiz. If there is no limit, the value is set to -1 or NULL. | No | No | integer |
allowed_attempts |
The number of attempts the student is allowed to try the Quiz. If there is not attempt limit, then the value is set to -1 or NULL. | No | No | integer |
quiz_item_count |
The number of Quiz items in the Quiz. | No | No | integer |
unpublished_quiz_item_count |
Number of questions in the current unpublished version of the quiz. | No | No | integer |
Quiz Item
This entity is required.
Entity filename: quiz_item.csv
.
A particular quiz item in a particular quiz.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Quiz Item. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Quiz Item, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
quiz_id |
Foreign key to the Quiz of which this Quiz item is a part. See Quiz. | Yes | Yes | integer |
learner_activity_id |
Foreign key to the Learner activity of which this Quiz item's Quiz is a part. See Learner Activity. | No | Yes | integer |
quiz_item_group_id |
Foreign key to the Quiz item group of which this Quiz item is a part. See Quiz Item Group. | No | Yes | integer |
position |
The position of the Quiz item in the Quiz item group. | No | No | integer |
status |
The status of the Quiz item. | No | No | text |
created_date |
The date & time that the Quiz item was created. | No | No | timestamp |
updated_date |
The date & time that the Quiz item was updated. | No | No | timestamp |
name |
The name of the Quiz item. | No | No | text |
quiz_item_type |
The type of Quiz item. (option set) | No | No | text |
body |
The body content of the Quiz item. | No | No | text |
is_regrade_option_available |
Indicates whether regrading is available for the Quiz item. | No | No | boolean |
correct_comments |
Comments to be displayed if the student answers the Quiz item correctly. | No | No | text |
incorrect_comments |
Comments to be displayed if the student answers the Quiz item incorrectly. | No | No | text |
neutral_comments |
Comments to be displayed regardless of how the student answers the Quiz item. | No | No | text |
points_possible |
The number of points possible on the Quiz question. | No | No | decimal |
Quiz Item Group
This entity is required.
Entity filename: quiz_item_group.csv
.
A group of Quiz items.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Quiz Item Group. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Quiz Item Group, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
quiz_id |
The Quiz to which this Quiz item group belongs. See Quiz. | No | Yes | integer |
name |
The name of the Quiz item group. | No | No | text |
position |
The order in which the Quiz items from this group will be displayed in the Quiz relative to the other Quiz items in the Quiz from other groups. | No | No | integer |
created_date |
The date & time that the Quiz item group was created. | No | No | timestamp |
updated_date |
The date & time that the Quiz item group was updated. | No | No | timestamp |
pick_count |
The number of Quiz items selected from this group that were used in the Quiz. | No | No | integer |
quiz_item_points |
The number of points assigned to each Quiz item in the Quiz item group. | No | No | integer |
Quiz Item Response
This entity is required.
Entity filename: quiz_item_response.csv
.
The learner response given for a particular quiz item.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Quiz Item Response. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Quiz Item Response, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
quiz_item_id |
The Quiz item to which this Quiz item response is responding. See Quiz Item. | No | Yes | integer |
body |
The body of the Quiz item response. | No | No | text |
html |
The HTML markup of the Quiz item response. | No | No | text |
comments |
The contextual comments of a Quiz item response. | No | No | text |
text_after_answers |
When a Quiz item is a fill in the blank question, this is the text that follows the word that is blank. | No | No | text |
answer_match_left |
When a Quiz item is a matching question, then this is the value of the answer that is displayed to the left for students to match. | No | No | text |
answer_match_right |
When a Quiz item is a matching question, then this is the value of the answer that is displayed to the right for students to match. | No | No | text |
incorrect_matches |
When a Quiz item is a matching question, then this is the list of distractors (incorrect answers), delimited by newlines, that will be seeded with the 'Answer match right' values. | No | No | text |
numerical_answer_type |
When a Quiz item is a numerical question, then this denotes the type of numerical answer that is expected. Possible values are 'exact_answer' and 'range_answer'. | No | No | text |
blank |
When a Quiz item is a fill in multiple blanks question, then this refers to the blank(s) in the question text. | No | No | text |
exact |
When the Quiz item is a numerical question and Numeric answer is of type 'exact type', then this is the value the answer must be equal to. | No | No | decimal |
margin |
When the Quiz item is a numerical question and Numeric answer is of type 'exact type', then this is the margin of error allowed for a student's answer. | No | No | decimal |
starting_range |
When the Quiz item is a numerical question and Numeric answer is of type 'range type', then this is the starting value for the range in which the answer must fall. | No | No | decimal |
ending_range |
When the Quiz item is a numerical question and Numeric answer is of type 'range type', then this is the ending value for the range in which the answer must fall. | No | No | decimal |
weight |
A measure of the correctness of the Quiz item response. Incorrect answers should have a measure of 0; correct answers should have a non-negative measure. | No | No | text |
Quiz Result
This entity is required.
Entity filename: quiz_result.csv
.
A learner response to a quiz.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Quiz Result. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Quiz Result, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
quiz_id |
The Quiz for which this is a student Quiz result. See Quiz. | No | Yes | integer |
learner_activity_id |
The Learner activity associated with this Quiz result. See Learner Activity. | No | Yes | integer |
learner_activity_result_id |
The Learner activity result associated with this Quiz result. See Learner Activity Result. | No | Yes | integer |
person_id |
The Person record for the student who submitted this Quiz result. See Person. | No | Yes | integer |
status |
The workflow state of the Quiz result. (option set) | No | No | text |
state_in_submission |
The state of the Quiz at the time it was submitted. The Quiz may have been unlocked after being locked; the Quiz result was submitted on time, which is to say the Quiz was never locked. (option set) | No | No | text |
submission_scoring_policy |
Indicates whether the score was manually overridden by the teacher to reflect the score of the previous attempt. The values will either indicate it was manually overridden, or be the scoring policy for the Quiz. (option set) | No | No | text |
submission_source |
Indicates where the Quiz result was received from – these can be from the student or from an automated process. | No | No | text |
is_student_viewed |
Indicates if the student has viewed the results of their learner activity result | No | No | boolean |
created_date |
The date & time the Quiz result was created. | No | No | timestamp |
updated_date |
The date & time the Quiz result was updated. | No | No | timestamp |
started_date |
The date & time that the user started the Quiz. | No | No | timestamp |
finished_date |
The date & time that the user finished the Quiz. | No | No | timestamp |
due_date |
The date & time that the Quiz was due, after which the Quiz result is marked as late. | No | No | timestamp |
score |
The score of the Quiz result. | No | No | decimal |
kept_score |
If multiple attempts on the Quiz are allowed, then this is the score among the attempts that is kept and used for the student. | No | No | decimal |
result_date |
Identical to the Finished date – the date & time when the user finished the Quiz. | No | No | timestamp |
points_possible |
The maximum number of points that can be earned on the Quiz for this is a result. | No | No | decimal |
score_before_regrade |
The original score of the Quiz result before any regrading. | No | No | decimal |
fudge_points |
The number of points fudged on the Quiz result score. The values can be negative or positive. | No | No | decimal |
total_attempts |
The total number of attempts that the student made on the Quiz for which this is a quiz result. | No | No | integer |
extra_attempts |
The number of times above the allowable threshold the student attempted the learner activity | No | No | integer |
extra_time |
The amount of extra time that the student was given, in minutes, to complete the Quiz. | No | No | integer |
time_taken |
The time taken, in millseconds, for the students to complete the Quiz. | No | No | integer |
Role
This entity is required.
Entity filename: role.csv
.
The function assumed by a Person in a particular situation.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Role. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Role, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
name |
The name of the Role. | No | No | text |
base_role_type |
The fundamental role from which the Role is built. (option set) | No | No | text |
status |
The current status of the Role. (option set) | No | No | text |
created_date |
The date on which the Role was first created. | No | No | timestamp |
updated_date |
The date on which the Role was last updated. | No | No | timestamp |
deleted_date |
The date on which the Role was deleted. | No | No | timestamp |
Wiki
This entity is required.
Entity filename: wiki.csv
.
A site that allows collaborative editing of its content and structure by its users.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Wiki. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Wiki, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
parent_entity_type |
The type of Entity that owns the Wiki. | No | No | text |
title |
The title of the Wiki. | No | No | text |
created_date |
The date on which the the Wiki was first created. | No | No | timestamp |
updated_date |
The date on which the Wiki was last updated. | No | No | timestamp |
front_page_url |
The URL at which the front page of the Wiki resides. | No | No | text |
has_no_front_page |
If true, the Wiki does not have a front page. | No | No | boolean |
course_offering_id |
The Course offering Id of the Wiki page, if the Wiki page is part of a Course offering. See Course Offering. | No | Yes | integer |
learner_group_id |
The Learner group of the Wiki page, if the Wiki page is assocaited with a Learner group. See Learner Group. | No | Yes | integer |
Wiki Page
This entity is required.
Entity filename: wiki_page.csv
.
A particular page in a Wiki.
Code (Header) | Description | Is required | Is foreign key | Datatype |
---|---|---|---|---|
lms_int_id |
The key used within the LMS to identify this Wiki Page. | Yes | No | text |
lms_ext_id |
The global key generated by this LMS to identify this Wiki Page, for use by external tools that are provisioned or launched from the LMS. | Yes | No | text |
wiki_id |
The Wiki to which this Wiki page belongs. See Wiki. | No | Yes | integer |
person_id |
The Person who originally authored the Wiki page. See Person. | No | Yes | integer |
title |
The title of the Wiki page. | No | No | text |
body |
The body (content) of the Wiki page. | No | No | text |
status |
The current status of the Wiki page. (option set) | No | No | text |
created_date |
The date on which the Wiki page was first created. | No | No | timestamp |
updated_date |
The date on which the Wiki page was last updated. | No | No | timestamp |
url |
The URL at which the Wiki page resides. | No | No | text |
is_protected_editing |
Denotes whether the Wiki page only allows certain Person(s) to edit or revise. | No | No | boolean |
editing_roles |
The role(s) in which Persons may contribute to the Wiki page. | No | No | text |
revised_date |
The date on which the Wiki page last had revisions to its Body. | No | No | timestamp |
could_be_locked |
Denotes whether the WIki page could be locked. | No | No | boolean |
comments_count |
The number of comments on the Wiki page. | No | No | integer |
view_count |
The number of times the Wiki page has been viewed. | No | No | integer |