canvas types

Types in canvas namespace.

access_tokens__workflow_state

Bases: Enum

Type for column access_tokens.workflow_state.

• active = 'active'

• deleted = 'deleted'

• pending = 'pending'

• unspecified = '_dap_unspecified_'

account_users__workflow_state

Bases: Enum

Type for column account_users.workflow_state.

• active = 'active'

• deleted = 'deleted'

• unspecified = '_dap_unspecified_'

accounts__workflow_state

Bases: Enum

Type for column accounts.workflow_state.

• active = 'active'

The only state an end customer will ever see.

• deleted = 'deleted'

• suspended = 'suspended'

A state only site admins can see.

• unspecified = '_dap_unspecified_'

assessment_question_banks__context_type

Bases: Enum

Discriminator for column assessment_question_banks.context_type.

• account = 'Account'

• course = 'Course'

• unspecified = '_dap_unspecified_'

assessment_question_banks__workflow_state

Bases: Enum

Type for column assessment_question_banks.workflow_state.

• active = 'active'

• deleted = 'deleted'

• unspecified = '_dap_unspecified_'

assessment_questions__workflow_state

Bases: Enum

Type for column assessment_questions.workflow_state.

• active = 'active'

• independently_edited = 'independently_edited'

• deleted = 'deleted'

• unspecified = '_dap_unspecified_'

asset_user_accesses__context_type

Bases: Enum

Discriminator for column asset_user_accesses.context_type.

• account = 'Account'

• assessment_question = 'AssessmentQuestion'

• course = 'Course'

• group = 'Group'

• user = 'User'

• unspecified = '_dap_unspecified_'

asset_user_accesses__action_level

Bases: Enum

Type for column asset_user_accesses.action_level.

• view = 'view'

• participate = 'participate'

• unspecified = '_dap_unspecified_'

asset_user_accesses__asset_category

Bases: Enum

Type for column asset_user_accesses.asset_category.

• announcements = 'announcements'

• assignments = 'assignments'

• calendar_feed = 'calendar_feed'

• collaborations = 'collaborations'

• conferences = 'conferences'

• files = 'files'

• grades = 'grades'

• home = 'home'

• modules = 'modules'

• outcomes = 'outcomes'

• pages = 'pages'

• quizzes = 'quizzes'

• roster = 'roster'

• speed_grader = 'speed_grader'

• syllabus = 'syllabus'

• topics = 'topics'

• calendar = 'calendar'

• external_tools = 'external_tools'

• wiki = 'wiki'

• external_urls = 'external_urls'

• unspecified = '_dap_unspecified_'

asset_user_accesses__membership_type

Bases: Enum

Type for column asset_user_accesses.membership_type.

• TeacherEnrollment = 'TeacherEnrollment'

• AccountUser = 'AccountUser'

• Other = 'Other'

• User = 'User'

• NilClass = 'NilClass'

• TaEnrollment = 'TaEnrollment'

• DesignerEnrollment = 'DesignerEnrollment'

• ObserverEnrollment = 'ObserverEnrollment'

• GroupMembership = 'GroupMembership'

• StudentEnrollment = 'StudentEnrollment'

• StudentViewEnrollment = 'StudentViewEnrollment'

• unspecified = '_dap_unspecified_'

assignment_groups__context_type

Bases: Enum

Discriminator for column assignment_groups.context_type.

• course = 'Course'

• unspecified = '_dap_unspecified_'

assignment_groups__rules

Type extracted from column assignment_groups.rules.

Parameters:

• drop_highest (int32 | None) – Number of highest scores to be dropped for each user.

• drop_lowest (int32 | None) – Number of lowest scores to be dropped for each user.

• never_drop (List[int32]) – Assignment IDs that should never be dropped. E.g.: [33, 17, 24].

assignment_groups__workflow_state

Bases: Enum

Type for column assignment_groups.workflow_state.

• available = 'available'

Equivalent to active state in other tables.

• deleted = 'deleted'

• active = 'active'

• unspecified = '_dap_unspecified_'

assignment_override_students__workflow_state

Bases: Enum

Type for column assignment_override_students.workflow_state.

• active = 'active'

• deleted = 'deleted'

• unspecified = '_dap_unspecified_'

assignment_overrides__set_type

Bases: Enum

Discriminator for column assignment_overrides.set_type.

• Group = 'Group'

• CourseSection = 'CourseSection'

• ADHOC = 'ADHOC'

• Noop = 'Noop'

• Course = 'Course'

• unspecified = '_dap_unspecified_'

assignment_overrides__workflow_state

Bases: Enum

Type for column assignment_overrides.workflow_state.

• active = 'active'

• deleted = 'deleted'

• unspecified = '_dap_unspecified_'

assignments__workflow_state

Bases: Enum

Type for column assignments.workflow_state.

• unpublished = 'unpublished'

• published = 'published'

• deleted = 'deleted'

• duplicating = 'duplicating'

• fail_to_import = 'fail_to_import'

• failed_to_duplicate = 'failed_to_duplicate'

• failed_to_import = 'failed_to_import'

• failed_to_migrate = 'failed_to_migrate'

• importing = 'importing'

• migrating = 'migrating'

• outcome_alignment_cloning = 'outcome_alignment_cloning'

• failed_to_clone_outcome_alignment = 'failed_to_clone_outcome_alignment'

• unspecified = '_dap_unspecified_'

assignments__context_type

Bases: Enum

Type for column assignments.context_type.

• Course = 'Course'

• unspecified = '_dap_unspecified_'

assignments__turnitin_settings__exclude_small_matches_type

Bases: Enum

Type for column assignments__turnitin_settings.exclude_small_matches_type.

• off = 'off'

• words = 'words'

• percent = 'percent'

• unspecified = '_dap_unspecified_'

assignments__turnitin_settings__originality_report_visibility

Bases: Enum

Type for column assignments__turnitin_settings.originality_report_visibility.

• immediate = 'immediate'

• after_grading = 'after_grading'

• after_due_date = 'after_due_date'

• never = 'never'

• unspecified = '_dap_unspecified_'

assignments__turnitin_settings

Type extracted from column assignments.turnitin_settings.

Parameters:

• exclude_small_matches_value (int32 | None) – If exclude_small_matches_type is set to percent or number then the value will be will be a number (of words or a percent).

• s_paper_check (bool | None) – If set to TRUE, will allow to compare submission against other students’ papers.

• s_view_report (bool | None) – If set to TRUE students will be able to access their originality report.

• internet_check (bool | None) – Select the content you’d like to compare papers against: current and archived website content.

• journal_check (bool | None) – Select the content you’d like to compare papers against: periodicals, journals and publications.

• exclude_biblio (bool | None) – Selecting this option will exclude text appearing in the bibliography, works cited, or references sections of student papers from being checked for matches when generating Similarity Reports.

• exclude_quoted (bool | None) – Selecting this option will exclude text in student papers that is enclosed in quotation marks or is part of a block quotation (an indented block of text) from being checked for matches when generating Similarity Reports.

• submit_papers_to (bool | None) – If set to FALSE, a similarity report will still be generated for paper submissions but students’ papers will not be stored in the Turnitin standard paper repository or the institution’s paper repository for future comparison.

assignments__grading_type

Bases: Enum

Type for column assignments.grading_type.

• gpa_scale = 'gpa_scale'

• letter_grade = 'letter_grade'

• not_graded = 'not_graded'

• pass_fail = 'pass_fail'

• percent = 'percent'

• points = 'points'

• default = 'default'

• unspecified = '_dap_unspecified_'

assignments__submission_types

Bases: Enum

Type for column assignments.submission_types.

• discussion_topic = 'discussion_topic'

• online_quiz = 'online_quiz'

• on_paper = 'on_paper'

• none = 'none'

• external_tool = 'external_tool'

• online = 'online'

• online_text_entry = 'online_text_entry'

• online_url = 'online_url'

• online_upload = 'online_upload'

• media_recording = 'media_recording'

• not_graded = 'not_graded'

• wiki_page = 'wiki_page'

• student_annotation = 'student_annotation'

• default_external_tool = 'default_external_tool'

• unspecified = '_dap_unspecified_'

assignments__type

Bases: Enum

Type for column assignments.type.

• assignment = 'Assignment'

• subassignment = 'SubAssignment'

• unspecified = '_dap_unspecified_'

attachment_associations__context_type

Bases: Enum

Discriminator for column attachment_associations.context_type.

• ConversationMessage = 'ConversationMessage'

• Submission = 'Submission'

• Course = 'Course'

• Group = 'Group'

• unspecified = '_dap_unspecified_'

attachments__workflow_state

Bases: Enum

Type for column attachments.workflow_state.

• deleted = 'deleted'

• errored = 'errored'

• pending_upload = 'pending_upload'

• processed = 'processed'

• processing = 'processing'

• to_be_zipped = 'to_be_zipped'

• unattached = 'unattached'

• unattached_temporary = 'unattached_temporary'

• zipped = 'zipped'

• zipping = 'zipping'

• unspecified = '_dap_unspecified_'

attachments__context_type

Bases: Enum

Type for column attachments.context_type.

• Account = 'Account'

• AssessmentQuestion = 'AssessmentQuestion'

• Assignment = 'Assignment'

• Attachment = 'Attachment'

• ContentExport = 'ContentExport'

• ContentMigration = 'ContentMigration'

• Course = 'Course'

• Eportfolio = 'Eportfolio'

• EpubExport = 'EpubExport'

• Folder = 'Folder'

• GradebookUpload = 'GradebookUpload'

• Group = 'Group'

• GroupAndMembershipImporter = 'GroupAndMembershipImporter'

• OutcomeImport = 'OutcomeImport'

• Purgatory = 'Purgatory'

• Quizzes__Quiz = 'Quizzes::Quiz'

• Quizzes__QuizStatistics = 'Quizzes::QuizStatistics'

• Quizzes__QuizSubmission = 'Quizzes::QuizSubmission'

• SisBatch = 'SisBatch'

• Submission = 'Submission'

• User = 'User'

• unspecified = '_dap_unspecified_'

attachments__file_state

Bases: Enum

Type for column attachments.file_state.

• unpublished = 'unpublished'

• published = 'published'

• deleted = 'deleted'

• available = 'available'

• hidden = 'hidden'

• errored = 'errored'

• broken = 'broken'

• public = 'public'

• unspecified = '_dap_unspecified_'

calendar_events__context_type

Bases: Enum

Discriminator for column calendar_events.context_type.

• AppointmentGroup = 'AppointmentGroup'

• Course = 'Course'

• CourseSection = 'CourseSection'

• Group = 'Group'

• User = 'User'

• Account = 'Account'

• unspecified = '_dap_unspecified_'

calendar_events__workflow_state

Bases: Enum

Type for column calendar_events.workflow_state.

• active = 'active'

• locked = 'locked'

Indicates that start_at/end_at cannot be changed (though the event could be deleted). Normally only reservations or time slots with reservations are locked (see the Appointment Groups API).

• deleted = 'deleted'

• unspecified = '_dap_unspecified_'

comment_bank_items__workflow_state

Bases: Enum

Type for column comment_bank_items.workflow_state.

• active = 'active'

Default value.

• deleted = 'deleted'

• unspecified = '_dap_unspecified_'

communication_channels__workflow_state

Bases: Enum

Type for column communication_channels.workflow_state.

• unconfirmed = 'unconfirmed'

• active = 'active'

• retired = 'retired'

• unspecified = '_dap_unspecified_'

communication_channels__path_type

Bases: Enum

Type for column communication_channels.path_type.

• email = 'email'

• push = 'push'

• slack = 'slack'

• sms = 'sms'

• twitter = 'twitter'

• unspecified = '_dap_unspecified_'

content_migrations__workflow_state

Bases: Enum

Type for column content_migrations.workflow_state.

• created = 'created'

• exported = 'exported'

• exporting = 'exporting'

• failed = 'failed'

• imported = 'imported'

• importing = 'importing'

• pre_process_error = 'pre_process_error'

• pre_processed = 'pre_processed'

• pre_processing = 'pre_processing'

• queued = 'queued'

• unspecified = '_dap_unspecified_'

content_migrations__context_type

Bases: Enum

Discriminator for column content_migrations.context_type.

• Course = 'Course'

• Account = 'Account'

• Group = 'Group'

• User = 'User'

• unspecified = '_dap_unspecified_'

content_participation_counts__context_type

Bases: Enum

Discriminator for column content_participation_counts.context_type.

• Course = 'Course'

• unspecified = '_dap_unspecified_'

content_participation_counts__content_type

Bases: Enum

Discriminator for column content_participation_counts.content_type.

• Submission = 'Submission'

• unspecified = '_dap_unspecified_'

content_participations__content_type

Bases: Enum

Discriminator for column content_participations.content_type.

• Submission = 'Submission'

• unspecified = '_dap_unspecified_'

content_participations__workflow_state

Bases: Enum

Type for column content_participations.workflow_state.

• read = 'read'

• unread = 'unread'

• unspecified = '_dap_unspecified_'

content_shares__type

Bases: Enum

Type for column content_shares.type.

• SentContentShare = 'SentContentShare'

• ReceivedContentShare = 'ReceivedContentShare'

• unspecified = '_dap_unspecified_'

content_shares__read_state

Bases: Enum

Type for column content_shares.read_state.

• read = 'read'

• unread = 'unread'

• unspecified = '_dap_unspecified_'

content_tags__workflow_state

Bases: Enum

Type for column content_tags.workflow_state.

• active = 'active'

• unpublished = 'unpublished'

• deleted = 'deleted'

• unspecified = '_dap_unspecified_'

content_tags__context_type

Bases: Enum

Type for column content_tags.context_type.

• Account = 'Account'

• Assignment = 'Assignment'

• Course = 'Course'

• LearningOutcomeGroup = 'LearningOutcomeGroup'

• Quizzes__Quiz = 'Quizzes::Quiz'

• User = 'User'

• unspecified = '_dap_unspecified_'

content_tags__tag_type

Bases: Enum

Type for column content_tags.tag_type.

• context_module = 'context_module'

indicates that the content object is a module item in a course (context_type will have a value of Course); the id value in the content_tags table may also be referred to as item_id; there will be a value in the context_module_id which indicates which module this content object appears under

• default = 'default'

• learning_outcome = 'learning_outcome'

indicates that the content object is aligned with a learning outcome (there will be a value in the learning_outcome_id field)

• learning_outcome_association = 'learning_outcome_association'

with this value, the record will also have a value in the associated_asset_id and associated_asset_type fields; means that the content object is under a learning outcome folder (i.e. Learning Outcome Group)

• unspecified = '_dap_unspecified_'

content_tags__associated_asset_type

Bases: Enum

Type for column content_tags.associated_asset_type.

• LearningOutcomeGroup = 'LearningOutcomeGroup'

• Lti__ResourceLink = 'Lti::ResourceLink'

• unspecified = '_dap_unspecified_'

content_tags__content_type

Bases: Enum

Type for column content_tags.content_type.

• Announcement = 'Announcement'

• AssessmentQuestionBank = 'AssessmentQuestionBank'

• Assignment = 'Assignment'

• Attachment = 'Attachment'

• ContextExternalTool = 'ContextExternalTool'

• ContextModuleSubHeader = 'ContextModuleSubHeader'

• DiscussionTopic = 'DiscussionTopic'

• ExternalUrl = 'ExternalUrl'

• LearningOutcome = 'LearningOutcome'

• LearningOutcomeGroup = 'LearningOutcomeGroup'

• LiveAssessments__Assessment = 'LiveAssessments::Assessment'

• Lti__MessageHandler = 'Lti::MessageHandler'

• Quizzes__Quiz = 'Quizzes::Quiz'

• Rubric = 'Rubric'

• WikiPage = 'WikiPage'

• unspecified = '_dap_unspecified_'

context_external_tools__workflow_state

Bases: Enum

Type for column context_external_tools.workflow_state.

• anonymous = 'anonymous'

no identifying information about the user will be sent to the vendor

• deleted = 'deleted'

• disabled = 'disabled'

• email_only = 'email_only'

the user’s email is the only identifying information sent to the vendor

• name_only = 'name_only'

the user’s name is the only identifying information sent to the vendor

• public = 'public'

various identifying information (name, email, Canvas ID, SIS ID of the course, SIS ID of the user, etc.) is sent to the vendor

• unspecified = '_dap_unspecified_'

context_external_tools__context_type

Bases: Enum

Type for column context_external_tools.context_type.

• Account = 'Account'

• Course = 'Course'

• unspecified = '_dap_unspecified_'

context_external_tools__settings

Type extracted from column context_external_tools.settings.

Parameters:

• course_home_sub_navigation (str | None) – Course home sub navigation placement type.

• course_settings_sub_navigation (str | None) – Course settings sub navigation placement type.

• custom_fields (str | None) – Custom parameters provider request to share on every single LTI launch, each placement column might have its own set of custom_fields.

• discussion_menu (str | None) – Discussion menu placement type.

• discussion_topic_index_menu (str | None) – Discussion topic index menu placement type.

• discussion_topic_menu (str | None) – Discussion topic menu placement type.

• editor_button (str | None) – RCE placement type.

• enabled (str | None) – Controls if the tool is disabled for user to click on, typically tool gets removed altogether but sometimes provider uses this setting to just disable it in the UI.

• file_index_menu (str | None) – File index menu placement type.

• file_menu (str | None) – File menu placement type.

• global_navigation (str | None) – Global navigation placement type.

• grade_passback (str | None) – Grade pass-back placement type.

• homework_selection (str | None) – Homework selection placement type.

• homework_submission (str | None) – Homework submission placement type.

• launch_presentation_document_target (str | None) – Tells us if it should be opened in another window.

• link_selection (str | None) – Link selection placement type.

• migration_selection (str | None) – Migration selection placement type.

• module_group_menu (str | None) – Module group menu placement type.

• module_index_menu (str | None) – Module index menu placement type.

• account_navigation (str | None) – account navigation placement type.

• assignment_group_menu (str | None) – Assignment group menu placement type.

• assignment_index_menu (str | None) – Assignment index menu placement type.

• assignment_menu (str | None) – Assignment menu placement type.

• assignment_selection (str | None) – Assignment selection placement type.

• canvas_caliper_url (str | None) – URL to caliper endpoint if supported by the tool.

• collaboration (str | None) – Collaboration placement type.

• content_migration (str | None) – Content migration placement type.

• course_assignments_menu (str | None) – Course assignments menu placement type.

• course_navigation (str | None) – Course navigation placement type.

• module_menu (str | None) – Module menu placement type.

• post_grades (str | None) – Post grades placement type.

• quiz_index_menu (str | None) – Quiz index menu placement type.

• quiz_menu (str | None) – Quiz menu placement type.

• similarity_detection (str | None) – Plagiarism platform placement.

• student_context_card (str | None) – Student context card placement type.

• text (str | None) – Identifies the name of the tool, default what the user can see if no label is set.

• tool_configuration (str | None) – Identifies the LTI tool configuration dataset.

• use_1_3 (str | None) – LTI 1.3 compliant tool.

• user_navigation (str | None) – User navigation placement type.

• visibility (str | None) – Controls if it is an admin only tool, takes values of admin and members.

• wiki_index_menu (str | None) – Wiki index menu placement type.

• wiki_page_menu (str | None) – Wiki page menu placement type.

context_module_progressions__workflow_state

Bases: Enum

Type for column context_module_progressions.workflow_state.

• completed = 'completed'

• locked = 'locked'

• started = 'started'

• unlocked = 'unlocked'

• unspecified = '_dap_unspecified_'

context_modules__workflow_state

Bases: Enum

Type for column context_modules.workflow_state.

• active = 'active'

• deleted = 'deleted'

• unpublished = 'unpublished'

• unspecified = '_dap_unspecified_'

context_modules__context_type

Bases: Enum

Type for column context_modules.context_type.

• Course = 'Course'

• unspecified = '_dap_unspecified_'

conversation_message_participants__workflow_state

Bases: Enum

Type for column conversation_message_participants.workflow_state.

• active = 'active'

• deleted = 'deleted'

• unspecified = '_dap_unspecified_'

conversation_messages__context_type

Bases: Enum

Type for column conversation_messages.context_type.