Instructure Developer Documentation Portal
Community
  • Introduction
  • Services
    • Elevate Standards Alignment - AB Connect API
      • Introduction
        • Authentication
        • Addressing Object Properties
        • Requesting Additional Properties in the Response
        • Filtering Using ODATA Like Statements
        • Sorting
        • Facets
        • Paging Data
        • Call Throttling
        • Working with Related Object
        • Error Responses
        • Character Set Support
        • How To Articles, Recommendations and Suggestions
        • Examples
        • Using AB Connect's Embeddable Widgets
      • Reference
        • Standards
        • Standard Collections
        • Events
        • Topics
        • Concepts
        • Assets
        • Asset Definitions
        • Asset Collections
        • Managing and Predicting Relationships
        • Providers
    • Canvas LMS
      • Basics
        • GraphQL
        • API Change Log
        • SIS IDs
        • Pagination
        • Throttling
        • Compound Documents
        • File Uploads
        • API Endpoint Attributes
        • Masquerading
      • OAuth2
        • OAuth2 Overview
        • OAuth2 Endpoints
        • Developer Keys
      • Resources
        • Access Tokens
        • Account Calendars
        • Account Domain Lookups
        • Account Notifications
        • Account Reports
        • Accounts
        • Accounts (LTI)
        • Admins
        • Analytics
        • Announcement External Feeds
        • Announcements
        • API Token Scopes
        • Appointment Groups
        • Assignment Extensions
        • Assignment Groups
        • Assignments
        • Authentication Providers
        • Authentications Log
        • Blackout Dates
        • BlockEditorTemplate
        • Blueprint Courses
        • Bookmarks
        • Brand Configs
        • Calendar Events
        • Collaborations
        • CommMessages
        • Communication Channels
        • Conferences
        • Content Exports
        • Content Migrations
        • Content Security Policy Settings
        • Content Shares
        • Conversations
        • Course Audit log
        • Course Pace
        • Course Quiz Extensions
        • Course Reports
        • Courses
        • Custom Gradebook Columns
        • Developer Key Account Bindings
        • Developer Keys
        • Discussion Topics
        • Enrollment Terms
        • Enrollments
        • ePortfolios
        • ePub Exports
        • Error Reports
        • External Tools
        • Favorites
        • Feature Flags
        • Files
        • Grade Change Log
        • Gradebook History
        • Grading Period Sets
        • Grading Periods
        • Grading Standards
        • Group Categories
        • Groups
        • History
        • InstAccess tokens
        • JWTs
        • Late Policy
        • Learning Object Dates
        • Line Items
        • LiveAssessments
        • Logins
        • LTI Launch Definitions
        • LTI Registrations
        • LTI Resource Links
        • Media Objects
        • Moderated Grading
        • Modules
        • Names and Role
        • New Quiz Items
        • New Quizzes
        • New Quizzes Accommodations
        • New Quizzes Reports
        • Notification Preferences
        • Originality Reports
        • Outcome Groups
        • Outcome Imports
        • Outcome Results
        • Outcomes
        • Pages
        • Peer Reviews
        • Planner
        • Poll Sessions
        • PollChoices
        • Polls
        • PollSubmissions
        • Proficiency Ratings
        • Progress
        • Public JWK
        • Quiz Assignment Overrides
        • Quiz Extensions
        • Quiz IP Filters
        • Quiz Question Groups
        • Quiz Questions
        • Quiz Reports
        • Quiz Statistics
        • Quiz Submission Events
        • Quiz Submission Files
        • Quiz Submission Questions
        • Quiz Submission User List
        • Quiz Submissions
        • Quizzes
        • Result
        • Roles
        • Rubrics
        • Sandboxes
        • Score
        • Search
        • Sections
        • Services
        • Shared Brand Configs
        • SIS Import Errors
        • SIS Imports
        • SIS Integration
        • Smart Search
        • Submission Comments
        • Submissions
        • Tabs
        • Temporary Enrollment Pairings
        • User Observees
        • Users
        • What If Grades
      • Outcomes
        • Outcomes CSV Format
      • Group Categories
        • Group Categories CSV Format
      • SIS
        • SIS CSV Format
      • External Tools
        • LTI
          • Introduction
          • Registration
          • Launch Overview
          • Configuring
          • Variable Substitutions
          • Deep Linking
          • Grading
          • Provisioning
          • PostMessage
          • Platform Notification Service
          • Placements
            • Placements Overview
            • Navigation
            • Homework Submission
            • Editor Button
            • Migration Selection
            • Link Selection (Modules)
            • Assignment Selection
            • Collaborations
        • xAPI
        • Canvas Roles
        • Plagiarism Detection Platform
          • Overview
          • Plagiarism Detection Platform Assignments
          • Plagiarism Detection Platform Users
          • Plagiarism Detection Submissions
          • Webhooks Subscriptions for Plagiarism Platform
          • JWT Access Tokens
      • Data Services
        • Live Events
          • Overview
            • Introduction
            • Setup
            • Caliper
            • Metadata
          • Event Format
            • Canvas
              • Account
              • Asset
              • Assignment
              • Attachment
              • Content
              • Conversation
              • Course
              • Discussion
              • Enrollment
              • Grade
              • Group
              • Learning
              • Logged
              • Module
              • Outcome
              • Outcomes
              • Plagiarism
              • Quiz
              • Rubric
              • Sis
              • Submission
              • Syllabus
              • User
              • Wiki
            • Caliper IMS 1.1
              • Assessment
              • Basic
              • Forum
              • Grading
              • Navigation Events
              • Session
    • Catalog
      • APIs
        • Analytics
        • Bulk Enrollments
        • Catalogs
        • Certificates
        • Completed Certificates
        • Courses
        • Email Domain Set
        • Enrollments
        • Orders
        • Programs
        • Progresses
        • Tags
        • User Registrations
        • Users
        • Waitlist Applicants
    • Credentials
      • Getting Started
      • Authentication
        • Password-Based Authentication
        • Authorization Code-Based Authentication
      • Pagination
      • APIs
        • Assertions
        • Backpack
        • Badgeclasses
        • Issuers
        • Organizations
        • Users
      • Release Notes
    • Data Access Platform
      • Key Concepts
      • Data Formats
      • Rate Limits & Policies
      • Datasets
        • Namespaces
          • canvas
            • canvas types
          • canvas_logs
          • catalog
        • Additional Notes
        • Entity Relationship Diagram
      • Query API
        • Authentication
        • Reference
      • Command Line (DAP CLI)
        • Getting Started
        • Secure Connection
        • Reference
          • dap snapshot
          • dap incremental
          • dap list
          • dap schema
          • dap initdb
          • dap syncdb
          • dap dropdb
      • Client Library
        • Examples
        • Reference
      • Release Notes
      • Status
    • DataSync
      • Interop API
      • Interop Data API
      • Grades Exchange API
      • OneRoster API
      • Platform API
    • Instructure Media
      • API Reference
        • Captions
        • Collection
        • Courses
        • Group
        • Insights
        • Media
        • Media Upload
        • Ping
        • Professional Captioning
        • Tags
        • Transfer Media
        • User
    • Quizzes
      • Quiz API
Powered by GitBook

Copyright © 2008-2024 Instructure, Inc. All rights reserved. Various trademarks held by their respective owners.

On this page
  • access_tokens__workflow_state
  • account_users__workflow_state
  • accounts__workflow_state
  • assessment_question_banks__context_type
  • assessment_question_banks__workflow_state
  • assessment_questions__workflow_state
  • asset_user_accesses__context_type
  • asset_user_accesses__action_level
  • asset_user_accesses__asset_category
  • asset_user_accesses__membership_type
  • assignment_groups__context_type
  • assignment_groups__rules
  • assignment_groups__workflow_state
  • assignment_override_students__workflow_state
  • assignment_overrides__set_type
  • assignment_overrides__workflow_state
  • assignments__workflow_state
  • assignments__context_type
  • assignments__turnitin_settings__exclude_small_matches_type
  • assignments__turnitin_settings__originality_report_visibility
  • assignments__turnitin_settings
  • assignments__grading_type
  • assignments__submission_types
  • assignments__type
  • attachment_associations__context_type
  • attachments__workflow_state
  • attachments__context_type
  • attachments__file_state
  • calendar_events__context_type
  • calendar_events__workflow_state
  • comment_bank_items__workflow_state
  • communication_channels__workflow_state
  • communication_channels__path_type
  • content_migrations__workflow_state
  • content_migrations__context_type
  • content_participation_counts__context_type
  • content_participation_counts__content_type
  • content_participations__content_type
  • content_participations__workflow_state
  • content_shares__type
  • content_shares__read_state
  • content_tags__workflow_state
  • content_tags__context_type
  • content_tags__tag_type
  • content_tags__associated_asset_type
  • content_tags__content_type
  • context_external_tools__workflow_state
  • context_external_tools__context_type
  • context_external_tools__settings
  • context_module_progressions__workflow_state
  • context_modules__workflow_state
  • context_modules__context_type
  • conversation_message_participants__workflow_state
  • conversation_messages__context_type
  • conversation_messages__asset_type
  • conversation_messages__media_comment_type
  • conversation_participants__workflow_state
  • conversations__context_type
  • course_sections__workflow_state
  • courses__workflow_state
  • courses__settings
  • custom_gradebook_columns__workflow_state
  • developer_key_account_bindings__workflow_state
  • developer_keys__workflow_state
  • discussion_entries__workflow_state
  • discussion_entry_participants__workflow_state
  • discussion_topic_participants__workflow_state
  • discussion_topics__type
  • discussion_topics__workflow_state
  • discussion_topics__context_type
  • discussion_topics__discussion_type
  • enrollment_dates_overrides__context_type
  • enrollment_dates_overrides__enrollment_type
  • enrollment_states__state
  • enrollment_terms__workflow_state
  • enrollments__workflow_state
  • enrollments__type
  • favorites__context_type
  • folders__context_type
  • folders__workflow_state
  • folders__unique_type
  • grading_period_groups__workflow_state
  • grading_periods__workflow_state
  • grading_standards__context_type
  • grading_standards__workflow_state
  • group_categories__context_type
  • group_categories__role
  • group_memberships__workflow_state
  • groups__workflow_state
  • groups__context_type
  • groups__default_view
  • learning_outcome_groups__workflow_state
  • learning_outcome_groups__context_type
  • learning_outcome_question_results__associated_asset_type
  • learning_outcome_results__context_type
  • learning_outcome_results__associated_asset_type
  • learning_outcome_results__association_type
  • learning_outcome_results__artifact_type
  • learning_outcome_results__workflow_state
  • learning_outcomes__workflow_state
  • learning_outcomes__context_type
  • learning_outcomes__calculation_method
  • lti_line_items__workflow_state
  • lti_resource_links__context_type
  • lti_resource_links__workflow_state
  • lti_results__workflow_state
  • master_courses_child_content_tags__content_type
  • master_courses_child_subscriptions__workflow_state
  • master_courses_master_content_tags__content_type
  • master_courses_master_migrations__workflow_state
  • master_courses_master_templates__workflow_state
  • master_courses_migration_results__import_type
  • master_courses_migration_results__state
  • originality_reports__workflow_state
  • outcome_proficiencies__context_type
  • outcome_proficiencies__workflow_state
  • outcome_proficiency_ratings__workflow_state
  • pseudonyms__workflow_state
  • quiz_questions__question_data__regrade_option
  • quiz_questions__question_data
  • quiz_questions__workflow_state
  • quiz_submissions__workflow_state
  • quizzes__workflow_state
  • quizzes__context_type
  • quizzes__quiz_type
  • role_overrides__context_type
  • roles__workflow_state
  • roles__base_role_type
  • rubric_assessments__artifact_type
  • rubric_assessments__assessment_type
  • rubric_associations__context_type
  • rubric_associations__association_type
  • rubric_associations__workflow_state
  • rubrics__context_type
  • rubrics__workflow_state
  • scores__workflow_state
  • submission_comments__context_type
  • submission_comments__media_comment_type
  • submission_versions__context_type
  • submissions__workflow_state
  • submissions__submission_type
  • submissions__media_comment_type
  • users__workflow_state
  • web_conference_participants__participation_type
  • web_conferences__context_type
  • web_conferences__conference_type
  • wiki_pages__workflow_state
  • wiki_pages__context_type
  • collaboration__context_type

Was this helpful?

  1. Services
  2. Data Access Platform
  3. Datasets
  4. Namespaces
  5. canvas

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.

  • Account = 'Account'

  • unspecified = '_dap_unspecified_'

conversation_messages__asset_type

Bases: Enum

Type for column conversation_messages.asset_type.

  • Submission = 'Submission'

  • unspecified = '_dap_unspecified_'

conversation_messages__media_comment_type

Bases: Enum

Type for column conversation_messages.media_comment_type.

  • audio = 'audio'

  • audio2 = 'audio/*'

  • video = 'video'

  • video2 = 'video/*'

  • audio_aac = 'audio/aac'

  • audio_amr = 'audio/amr'

  • audio_flac = 'audio/flac'

  • audio_mp4 = 'audio/mp4'

  • audio_mpeg = 'audio/mpeg'

  • audio_ogg = 'audio/ogg'

  • audio_vnd_dlna_adts = 'audio/vnd.dlna.adts'

  • audio_wav = 'audio/wav'

  • audio_webm = 'audio/webm'

  • audio_xm4a = 'audio/x-m4a'

  • audio_xmswma = 'audio/x-ms-wma'

  • audio_xwav = 'audio/x-wav'

  • video_3gpp = 'video/3gpp'

  • video_avi = 'video/avi'

  • video_mp4 = 'video/mp4'

  • video_mpeg = 'video/mpeg'

  • video_ogg = 'video/ogg'

  • video_quicktime = 'video/quicktime'

  • video_webm = 'video/webm'

  • video_xm4v = 'video/x-m4v'

  • video_xmatroska = 'video/x-matroska'

  • video_xmsasf = 'video/x-ms-asf'

  • video_xmswmv = 'video/x-ms-wmv'

  • video_xmsvideo = 'video/x-msvideo'

  • unspecified = '_dap_unspecified_'

conversation_participants__workflow_state

Bases: Enum

Type for column conversation_participants.workflow_state.

  • read = 'read'

  • unread = 'unread'

  • archived = 'archived'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

conversations__context_type

Bases: Enum

Type for column conversations.context_type.

  • Course = 'Course'

the sender selected a course when composing the message

  • Group = 'Group'

the sender selected a group when composing the message

  • Account = 'Account'

the sender did not select a course or group when composing the message

  • unspecified = '_dap_unspecified_'

course_sections__workflow_state

Bases: Enum

Type for column course_sections.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

courses__workflow_state

Bases: Enum

Type for column courses.workflow_state.

  • created = 'created'

course created by admin, no teacher assigned yet

  • claimed = 'claimed'

teacher has been assigned to course or course created by teacher (not published)

  • available = 'available'

published

  • completed = 'completed'

course manually marked as completed

  • deleted = 'deleted'

course manually deleted (possibly created in error; sometimes admin and instructors delete courses to clear from their list); note: if a course is deleted it won’t necessarily delete the wiki pages, but does cascade to enrollments

  • unspecified = '_dap_unspecified_'

courses__settings

Type extracted from column courses.settings.

Parameters:

  • allow_student_discussion_editing (str | None) – Let students edit or delete their own discussion posts.

  • allow_student_discussion_topics (str | None) – Let students create discussion topics.

  • course_format (str | None) – Format of a course, values include blended, on_campus, online.

  • filter_speed_grader_by_student_group (str | None) – Filter SpeedGrader by student group.

  • hide_distribution_graphs (str | None) – Hide grade distribution graphs from students.

  • hide_final_grade (str | None) – Hide totals in student grades summary.

  • is_public_to_auth_users (str | None) – Set to true if course is public only to authenticated users.

  • lock_all_announcements (str | None) – Disable comments on announcements.

  • public_syllabus (str | None) – Set to true to make the course syllabus public. Values include true, false.

  • public_syllabus_to_auth (str | None) – Set to true to make the course syllabus public for authenticated users.

  • restrict_student_future_view (str | None) – Restrict students from viewing courses before start date.

  • restrict_student_past_view (str | None) – Restrict students from viewing courses after end date.

  • syllabus_updated_at (str | None) – Timestamp when syllabus was updated in a course.

  • usage_rights_required (str | None) – Copyright and license information must be provided for files before they are published.

  • allow_student_forum_attachments (str | None) – Whether students can attach files to discussions.

custom_gradebook_columns__workflow_state

Bases: Enum

Type for column custom_gradebook_columns.workflow_state.

  • active = 'active'

  • hidden = 'hidden'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

developer_key_account_bindings__workflow_state

Bases: Enum

Type for column developer_key_account_bindings.workflow_state.

  • on = 'on'

  • allow = 'allow'

  • off = 'off'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

developer_keys__workflow_state

Bases: Enum

Type for column developer_keys.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • inactive = 'inactive'

  • unspecified = '_dap_unspecified_'

discussion_entries__workflow_state

Bases: Enum

Type for column discussion_entries.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

discussion_entry_participants__workflow_state

Bases: Enum

Type for column discussion_entry_participants.workflow_state.

  • read = 'read'

  • unread = 'unread'

  • unspecified = '_dap_unspecified_'

discussion_topic_participants__workflow_state

Bases: Enum

Type for column discussion_topic_participants.workflow_state.

  • read = 'read'

  • unread = 'unread'

  • unspecified = '_dap_unspecified_'

discussion_topics__type

Bases: Enum

Type for column discussion_topics.type.

  • Announcement = 'Announcement'

  • unspecified = '_dap_unspecified_'

discussion_topics__workflow_state

Bases: Enum

Type for column discussion_topics.workflow_state.

  • active = 'active'

displayed to any user in the course

  • deleted = 'deleted'

  • locked = 'locked'

  • post_delayed = 'post_delayed'

discussion created, but set to go live at a certain date

  • unpublished = 'unpublished'

created but not yet published (draft state)

  • unspecified = '_dap_unspecified_'

discussion_topics__context_type

Bases: Enum

Type for column discussion_topics.context_type.

  • Course = 'Course'

entire class can participate

  • Group = 'Group'

only people in the group can participate

  • unspecified = '_dap_unspecified_'

discussion_topics__discussion_type

Bases: Enum

Type for column discussion_topics.discussion_type.

  • side_comment = 'side_comment'

The same as not_threaded. This value is obsolete.

  • threaded = 'threaded'

Allows replies within replies. Maximum depth of replies is 3.

  • not_threaded = 'not_threaded'

Prevent users from replying to replies, only to the original topic.

  • unspecified = '_dap_unspecified_'

enrollment_dates_overrides__context_type

Bases: Enum

Discriminator for column enrollment_dates_overrides.context_type.

  • Account = 'Account'

  • unspecified = '_dap_unspecified_'

enrollment_dates_overrides__enrollment_type

Bases: Enum

Type for column enrollment_dates_overrides.enrollment_type.

  • DesignerEnrollment = 'DesignerEnrollment'

  • StudentEnrollment = 'StudentEnrollment'

  • TaEnrollment = 'TaEnrollment'

  • TeacherEnrollment = 'TeacherEnrollment'

  • unspecified = '_dap_unspecified_'

enrollment_states__state

Bases: Enum

Type for column enrollment_states.state.

  • active = 'active'

  • invited = 'invited'

  • creation_pending = 'creation_pending'

  • deleted = 'deleted'

  • rejected = 'rejected'

  • completed = 'completed'

  • inactive = 'inactive'

  • current_and_invited = 'current_and_invited'

  • current_and_future = 'current_and_future'

  • current_and_concluded = 'current_and_concluded'

  • pending_active = 'pending_active'

  • pending_invited = 'pending_invited'

  • unspecified = '_dap_unspecified_'

enrollment_terms__workflow_state

Bases: Enum

Type for column enrollment_terms.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

enrollments__workflow_state

Bases: Enum

Type for column enrollments.workflow_state.

  • creation_pending = 'creation_pending'

created but user hasn’t logged in yet

  • invited = 'invited'

admin added student through sis

  • rejected = 'rejected'

student rejected invite

  • active = 'active'

user can fully participate in course

  • inactive = 'inactive'

hard state (i.e., tuition not paid or user drops course); user can no longer access course content

  • completed = 'completed'

manually marked as completed (conclude this enrollment button); user can only view course in read-only format

  • deleted = 'deleted'

enrollment removed from course (soft-deleted, so users with admin permissions can include in reports)

  • unspecified = '_dap_unspecified_'

enrollments__type

Bases: Enum

Type for column enrollments.type.

  • StudentEnrollment = 'StudentEnrollment'

  • TeacherEnrollment = 'TeacherEnrollment'

  • TaEnrollment = 'TaEnrollment'

  • DesignerEnrollment = 'DesignerEnrollment'

  • ObserverEnrollment = 'ObserverEnrollment'

  • StudentViewEnrollment = 'StudentViewEnrollment'

this role is typically used by course designers or instructors to view the course as a student would see it

  • unspecified = '_dap_unspecified_'

favorites__context_type

Bases: Enum

Discriminator for column favorites.context_type.

  • Course = 'Course'

  • Group = 'Group'

  • unspecified = '_dap_unspecified_'

folders__context_type

Bases: Enum

Discriminator for column folders.context_type.

  • Account = 'Account'

  • Course = 'Course'

  • Group = 'Group'

  • User = 'User'

  • unspecified = '_dap_unspecified_'

folders__workflow_state

Bases: Enum

Type for column folders.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • hidden = 'hidden'

  • private = 'private'

  • visible = 'visible'

  • unspecified = '_dap_unspecified_'

folders__unique_type

Bases: Enum

Type for column folders.unique_type.

  • media = 'media'

  • sadocs = 'student annotation documents'

  • imicons = 'icon maker icons'

  • baicons = 'buttons and icons'

  • unspecified = '_dap_unspecified_'

grading_period_groups__workflow_state

Bases: Enum

Type for column grading_period_groups.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

grading_periods__workflow_state

Bases: Enum

Type for column grading_periods.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

grading_standards__context_type

Bases: Enum

Discriminator for column grading_standards.context_type.

  • Account = 'Account'

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

grading_standards__workflow_state

Bases: Enum

Type for column grading_standards.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • archived = 'archived'

  • unspecified = '_dap_unspecified_'

group_categories__context_type

Bases: Enum

Discriminator for column group_categories.context_type.

  • Account = 'Account'

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

group_categories__role

Bases: Enum

Type for column group_categories.role.

  • communities = 'communities'

  • student_organized = 'student_organized'

  • imported = 'imported'

  • unspecified = '_dap_unspecified_'

group_memberships__workflow_state

Bases: Enum

Type for column group_memberships.workflow_state.

  • accepted = 'accepted'

  • deleted = 'deleted'

  • invited = 'invited'

  • rejected = 'rejected'

  • requested = 'requested'

  • unspecified = '_dap_unspecified_'

groups__workflow_state

Bases: Enum

Type for column groups.workflow_state.

  • available = 'available'

  • deleted = 'deleted'

  • active = 'active'

  • unspecified = '_dap_unspecified_'

groups__context_type

Bases: Enum

Type for column groups.context_type.

  • Account = 'Account'

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

groups__default_view

Bases: Enum

Type for column groups.default_view.

  • feed = 'feed'

  • unspecified = '_dap_unspecified_'

learning_outcome_groups__workflow_state

Bases: Enum

Type for column learning_outcome_groups.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

learning_outcome_groups__context_type

Bases: Enum

Type for column learning_outcome_groups.context_type.

  • Account = 'Account'

  • Course = 'Course'

  • College = 'College'

  • Department = 'Department'

  • unspecified = '_dap_unspecified_'

learning_outcome_question_results__associated_asset_type

Bases: Enum

Discriminator for column learning_outcome_question_results.associated_asset_type.

  • AssessmentQuestion = 'AssessmentQuestion'

  • unspecified = '_dap_unspecified_'

learning_outcome_results__context_type

Bases: Enum

Type for column learning_outcome_results.context_type.

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

learning_outcome_results__associated_asset_type

Bases: Enum

Discriminator for column learning_outcome_results.associated_asset_type.

  • AssessmentQuestion = 'AssessmentQuestion'

  • LiveAssessments__Assessment = 'LiveAssessments::Assessment'

  • Assignment = 'Assignment'

  • Quizzes__Quiz = 'Quizzes::Quiz'

  • unspecified = '_dap_unspecified_'

learning_outcome_results__association_type

Bases: Enum

Discriminator for column learning_outcome_results.association_type.

  • Assignment = 'Assignment'

  • Quizzes__Quiz = 'Quizzes::Quiz'

  • RubricAssociation = 'RubricAssociation'

  • unspecified = '_dap_unspecified_'

learning_outcome_results__artifact_type

Bases: Enum

Discriminator for column learning_outcome_results.artifact_type.

  • LiveAssessments__Submission = 'LiveAssessments::Submission'

  • Quizzes__QuizSubmission = 'Quizzes::QuizSubmission'

  • RubricAssessment = 'RubricAssessment'

  • Submission = 'Submission'

  • unspecified = '_dap_unspecified_'

learning_outcome_results__workflow_state

Bases: Enum

Type for column learning_outcome_results.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

learning_outcomes__workflow_state

Bases: Enum

Type for column learning_outcomes.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • retired = 'retired'

  • unspecified = '_dap_unspecified_'

learning_outcomes__context_type

Bases: Enum

Type for column learning_outcomes.context_type.

  • Account = 'Account'

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

learning_outcomes__calculation_method

Bases: Enum

Type for column learning_outcomes.calculation_method.

  • decaying_average = 'decaying_average'

  • average = 'average'

  • highest = 'highest'

  • latest = 'latest'

  • n_mastery = 'n_mastery'

  • weighted_average = 'weighted_average'

  • standard_decaying_average = 'standard_decaying_average'

  • unspecified = '_dap_unspecified_'

lti_line_items__workflow_state

Bases: Enum

Type for column lti_line_items.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

lti_resource_links__context_type

Bases: Enum

Discriminator for column lti_resource_links.context_type.

  • Account = 'Account'

  • Assignment = 'Assignment'

  • Course = 'Course'

  • Group = 'Group'

  • unspecified = '_dap_unspecified_'

lti_resource_links__workflow_state

Bases: Enum

Type for column lti_resource_links.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

lti_results__workflow_state

Bases: Enum

Type for column lti_results.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

master_courses_child_content_tags__content_type

Bases: Enum

Discriminator for column master_courses_child_content_tags.content_type.

  • AssessmentQuestionBank = 'AssessmentQuestionBank'

  • Assignment = 'Assignment'

  • AssignmentGroup = 'AssignmentGroup'

  • Attachment = 'Attachment'

  • CalendarEvent = 'CalendarEvent'

  • ContextExternalTool = 'ContextExternalTool'

  • ContextModule = 'ContextModule'

  • ContentTag = 'ContentTag'

  • CoursePace = 'CoursePace'

  • DiscussionTopic = 'DiscussionTopic'

  • LearningOutcome = 'LearningOutcome'

  • LearningOutcomeGroup = 'LearningOutcomeGroup'

  • Rubric = 'Rubric'

  • Wiki = 'Wiki'

  • WikiPage = 'WikiPage'

  • Quizzes__Quiz = 'Quizzes::Quiz'

  • unspecified = '_dap_unspecified_'

master_courses_child_subscriptions__workflow_state

Bases: Enum

Type for column master_courses_child_subscriptions.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

master_courses_master_content_tags__content_type

Bases: Enum

Discriminator for column master_courses_master_content_tags.content_type.

  • AssessmentQuestionBank = 'AssessmentQuestionBank'

  • Assignment = 'Assignment'

  • AssignmentGroup = 'AssignmentGroup'

  • Attachment = 'Attachment'

  • CalendarEvent = 'CalendarEvent'

  • ContextExternalTool = 'ContextExternalTool'

  • ContextModule = 'ContextModule'

  • ContentTag = 'ContentTag'

  • CoursePace = 'CoursePace'

  • DiscussionTopic = 'DiscussionTopic'

  • LearningOutcome = 'LearningOutcome'

  • Rubric = 'Rubric'

  • Wiki = 'Wiki'

  • WikiPage = 'WikiPage'

  • Quizzes__Quiz = 'Quizzes::Quiz'

  • MediaTrack = 'MediaTrack'

  • unspecified = '_dap_unspecified_'

master_courses_master_migrations__workflow_state

Bases: Enum

Type for column master_courses_master_migrations.workflow_state.

  • completed = 'completed'

  • created = 'created'

  • exporting = 'exporting'

  • exports_failed = 'exports_failed'

  • imports_failed = 'imports_failed'

  • imports_queued = 'imports_queued'

  • queued = 'queued'

  • unspecified = '_dap_unspecified_'

master_courses_master_templates__workflow_state

Bases: Enum

Type for column master_courses_master_templates.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

master_courses_migration_results__import_type

Bases: Enum

Type for column master_courses_migration_results.import_type.

  • full = 'full'

  • selective = 'selective'

  • unspecified = '_dap_unspecified_'

master_courses_migration_results__state

Bases: Enum

Type for column master_courses_migration_results.state.

  • failed = 'failed'

  • completed = 'completed'

  • queued = 'queued'

  • unspecified = '_dap_unspecified_'

originality_reports__workflow_state

Bases: Enum

Type for column originality_reports.workflow_state.

  • error = 'error'

  • pending = 'pending'

  • scored = 'scored'

  • unspecified = '_dap_unspecified_'

outcome_proficiencies__context_type

Bases: Enum

Discriminator for column outcome_proficiencies.context_type.

  • Account = 'Account'

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

outcome_proficiencies__workflow_state

Bases: Enum

Type for column outcome_proficiencies.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

outcome_proficiency_ratings__workflow_state

Bases: Enum

Type for column outcome_proficiency_ratings.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

pseudonyms__workflow_state

Bases: Enum

Type for column pseudonyms.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • suspended = 'suspended'

  • unspecified = '_dap_unspecified_'

quiz_questions__question_data__regrade_option

Bases: Enum

Type for regrade_option extracted from column quiz_questions.question_data.

  • available = 'available'

  • unavailable = 'unavailable'

  • multiple_answers_question = 'multiple_answers_question'

  • multiple_choice_question = 'multiple_choice_question'

  • true_false_question = 'true_false_question'

  • current_and_previous_correct = 'current_and_previous_correct'

  • no_regrade = 'no_regrade'

  • current_correct_only = 'current_correct_only'

  • full_credit = 'full_credit'

  • disabled = 'disabled'

  • unspecified = '_dap_unspecified_'

quiz_questions__question_data

Type extracted from column quiz_questions.question_data.

Parameters:

  • neutral_comments (str | None) – Comments to be displayed regardless of how the student answers the question.

  • answers (str | None) – Collection of possible answers.

  • name (str | None) – Name of the question.

  • question_type (str | None) – Denotes the type of the question.

  • question_text (str | None) – Text of the question.

  • correct_comments (str | None) – Comments to be displayed if the student answers the question correctly.

  • incorrect_comments (str | None) – Comments to be displayed if the student answers the question incorrectly.

  • text_after_answers (str | None) – (Used in short_answer_question, also known as fill_in_the_blank. Omitted for other question types.) Text following the missing word.

  • matching_answer_incorrect_matches (str | None) – (Used in matching_question. Omitted for other question types.) List of distractors (incorrect answers), delimited by new lines, that will be seeded with all the answer_match_right values.

  • points_possible (float64 | None) – Maximum number of points that can be awarded for answering the question correctly.

quiz_questions__workflow_state

Bases: Enum

Type for column quiz_questions.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • generated = 'generated'

  • unspecified = '_dap_unspecified_'

quiz_submissions__workflow_state

Bases: Enum

Type for column quiz_submissions.workflow_state.

  • complete = 'complete'

  • pending_review = 'pending_review'

denotes that a manual submission has been made by the student which has not been completely graded yet. This usually happens when one or more questions in the quiz cannot be autograded (e.g. essay_question type questions)

  • preview = 'preview'

when a Teacher or Admin previews a quiz (even a partial one)

  • settings_only = 'settings_only'

pertains only to quiz moderation events (stores the settings to create and store moderation events before the student has begun an attempt)

  • untaken = 'untaken'

default value; a quiz submission is recorded as soon as a student starts the quiz-taking process (before even answering the first question)

  • unspecified = '_dap_unspecified_'

quizzes__workflow_state

Bases: Enum

Type for column quizzes.workflow_state.

  • created = 'created'

quiz created, but no further actions have been taken

  • edited = 'edited'

after the teacher makes edits to quiz

  • unpublished = 'unpublished'

teacher unpublished a published quiz

  • deleted = 'deleted'

  • available = 'available'

published and available

  • unspecified = '_dap_unspecified_'

quizzes__context_type

Bases: Enum

Type for column quizzes.context_type.

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

quizzes__quiz_type

Bases: Enum

Type for column quizzes.quiz_type.

  • assignment = 'assignment'

appears as Graded Quiz in the UI (a column is created in the grade book for any graded quizzes)

  • practice_quiz = 'practice_quiz'

appears as Practice Quiz in the UI (students do not receive a grade for practice quizzes)

  • graded_survey = 'graded_survey'

appears as Graded Survey in the UI (allows instructor to give students points for completing the survey, but it does not allow the survey to be graded for right or wrong answers)

  • survey = 'survey'

appears as Ungraded Survey in the UI (students do not receive a grade for their responses)

  • unspecified = '_dap_unspecified_'

role_overrides__context_type

Bases: Enum

Discriminator for column role_overrides.context_type.

  • Account = 'Account'

  • unspecified = '_dap_unspecified_'

roles__workflow_state

Bases: Enum

Type for column roles.workflow_state.

  • active = 'active'

  • built_in = 'built_in'

default roles that are included in each Canvas shard

  • deleted = 'deleted'

  • inactive = 'inactive'

  • unspecified = '_dap_unspecified_'

roles__base_role_type

Bases: Enum

Type for column roles.base_role_type.

  • AccountAdmin = 'AccountAdmin'

  • AccountMembership = 'AccountMembership'

  • DesignerEnrollment = 'DesignerEnrollment'

  • NoPermissions = 'NoPermissions'

  • ObserverEnrollment = 'ObserverEnrollment'

  • StudentEnrollment = 'StudentEnrollment'

  • TaEnrollment = 'TaEnrollment'

  • TeacherEnrollment = 'TeacherEnrollment'

  • unspecified = '_dap_unspecified_'

rubric_assessments__artifact_type

Bases: Enum

Discriminator for column rubric_assessments.artifact_type.

  • Submission = 'Submission'

  • Assignment = 'Assignment'

  • ModeratedGrading__ProvisionalGrade = 'ModeratedGrading::ProvisionalGrade'

  • unspecified = '_dap_unspecified_'

rubric_assessments__assessment_type

Bases: Enum

Type for column rubric_assessments.assessment_type.

  • grading = 'grading'

  • invited_assessment = 'invited_assessment'

  • peer_review = 'peer_review'

  • unspecified = '_dap_unspecified_'

rubric_associations__context_type

Bases: Enum

Discriminator for column rubric_associations.context_type.

  • Course = 'Course'

  • Account = 'Account'

  • unspecified = '_dap_unspecified_'

rubric_associations__association_type

Bases: Enum

Discriminator for column rubric_associations.association_type.

  • Account = 'Account'

  • Course = 'Course'

  • Assignment = 'Assignment'

  • unspecified = '_dap_unspecified_'

rubric_associations__workflow_state

Bases: Enum

Type for column rubric_associations.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

rubrics__context_type

Bases: Enum

Discriminator for column rubrics.context_type.

  • Account = 'Account'

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

rubrics__workflow_state

Bases: Enum

Type for column rubrics.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • archived = 'archived'

  • draft = 'draft'

  • unspecified = '_dap_unspecified_'

scores__workflow_state

Bases: Enum

Type for column scores.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

submission_comments__context_type

Bases: Enum

Discriminator for column submission_comments.context_type.

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

submission_comments__media_comment_type

Bases: Enum

Type for column submission_comments.media_comment_type.

  • audio = 'audio'

  • video = 'video'

  • audio_aac = 'audio/aac'

  • audio_amr = 'audio/amr'

  • audio_flac = 'audio/flac'

  • audio_mp4 = 'audio/mp4'

  • audio_mpeg = 'audio/mpeg'

  • audio_ogg = 'audio/ogg'

  • audio_vnd_dlna_adts = 'audio/vnd.dlna.adts'

  • audio_wav = 'audio/wav'

  • audio_webm = 'audio/webm'

  • audio_xm4a = 'audio/x-m4a'

  • audio_xmswma = 'audio/x-ms-wma'

  • audio_xwav = 'audio/x-wav'

  • video_3gpp = 'video/3gpp'

  • video_avi = 'video/avi'

  • video_mp4 = 'video/mp4'

  • video_mpeg = 'video/mpeg'

  • video_ogg = 'video/ogg'

  • video_quicktime = 'video/quicktime'

  • video_webm = 'video/webm'

  • video_xm4v = 'video/x-m4v'

  • video_xmatroska = 'video/x-matroska'

  • video_xmsasf = 'video/x-ms-asf'

  • video_xmswmv = 'video/x-ms-wmv'

  • video_xmsvideo = 'video/x-msvideo'

  • unspecified = '_dap_unspecified_'

submission_versions__context_type

Bases: Enum

Discriminator for column submission_versions.context_type.

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

submissions__workflow_state

Bases: Enum

Type for column submissions.workflow_state.

  • graded = 'graded'

  • pending_review = 'pending_review'

  • submitted = 'submitted'

  • unsubmitted = 'unsubmitted'

  • deleted = 'deleted'

  • unspecified = '_dap_unspecified_'

submissions__submission_type

Bases: Enum

Type for column submissions.submission_type.

  • basic_lti_launch = 'basic_lti_launch'

  • discussion_topic = 'discussion_topic'

  • external_tool = 'external_tool'

  • media_recording = 'media_recording'

  • online_file_upload = 'online_file_upload'

  • online_quiz = 'online_quiz'

  • online_text_entry = 'online_text_entry'

  • online_upload = 'online_upload'

  • online_url = 'online_url'

  • student_annotation = 'student_annotation'

  • unspecified = '_dap_unspecified_'

submissions__media_comment_type

Bases: Enum

Type for column submissions.media_comment_type.

  • audio = 'audio'

  • audio2 = 'audio/*'

  • video = 'video'

  • video2 = 'video/*'

  • audio_aac = 'audio/aac'

  • audio_amr = 'audio/amr'

  • audio_flac = 'audio/flac'

  • audio_mp4 = 'audio/mp4'

  • audio_mpeg = 'audio/mpeg'

  • audio_ogg = 'audio/ogg'

  • audio_vnd_dlna_adts = 'audio/vnd.dlna.adts'

  • audio_wav = 'audio/wav'

  • audio_webm = 'audio/webm'

  • audio_xm4a = 'audio/x-m4a'

  • audio_xmswma = 'audio/x-ms-wma'

  • audio_xwav = 'audio/x-wav'

  • video_3gpp = 'video/3gpp'

  • video_avi = 'video/avi'

  • video_mp4 = 'video/mp4'

  • video_mpeg = 'video/mpeg'

  • video_ogg = 'video/ogg'

  • video_quicktime = 'video/quicktime'

  • video_webm = 'video/webm'

  • video_xm4v = 'video/x-m4v'

  • video_xmatroska = 'video/x-matroska'

  • video_xmsasf = 'video/x-ms-asf'

  • video_xmswmv = 'video/x-ms-wmv'

  • video_xmsvideo = 'video/x-msvideo'

  • unspecified = '_dap_unspecified_'

users__workflow_state

Bases: Enum

Type for column users.workflow_state.

  • creation_pending = 'creation_pending'

  • deleted = 'deleted'

  • pending_approval = 'pending_approval'

  • pre_registered = 'pre_registered'

  • registered = 'registered'

  • unspecified = '_dap_unspecified_'

web_conference_participants__participation_type

Bases: Enum

Type for column web_conference_participants.participation_type.

  • attendee = 'attendee'

  • initiator = 'initiator'

  • invitee = 'invitee'

  • unspecified = '_dap_unspecified_'

web_conferences__context_type

Bases: Enum

Discriminator for column web_conferences.context_type.

  • Account = 'Account'

  • Course = 'Course'

  • Group = 'Group'

  • unspecified = '_dap_unspecified_'

web_conferences__conference_type

Bases: Enum

Type for column web_conferences.conference_type.

  • AdobeConnect = 'AdobeConnect'

  • BigBlueButton = 'BigBlueButton'

  • CiscoWebex = 'CiscoWebex'

  • DimDim = 'DimDim'

  • Wimba = 'Wimba'

  • Wiziq = 'Wiziq'

  • unspecified = '_dap_unspecified_'

wiki_pages__workflow_state

Bases: Enum

Type for column wiki_pages.workflow_state.

  • active = 'active'

  • deleted = 'deleted'

  • post_delayed = 'post_delayed'

  • unpublished = 'unpublished'

  • unspecified = '_dap_unspecified_'

wiki_pages__context_type

Bases: Enum

Type for column wiki_pages.context_type.

  • Course = 'Course'

  • Group = 'Group'

  • unspecified = '_dap_unspecified_'

collaboration__context_type

Bases: Enum

Type for column collaboration_comments.context_type.

  • Account = 'Account'

  • Group = 'Group'

  • Course = 'Course'

  • unspecified = '_dap_unspecified_'

PreviouscanvasNextcanvas_logs

Last updated 1 month ago

Was this helpful?

originality_report_visibility ( | None) – Allows to set the timeframe when the report will become visible.

exclude_small_matches_type ( | None) – Exclude small sources from the Similarity Report by a set number of words or percentage.

regrade_option ( | None) – Denotes if regrading is available for the question. Possible values are available and unavailable for question types. Defaults to available for the allowed question types and NULL for the rest.

assignments__turnitin_settings__originality_report_visibility
assignments__turnitin_settings__exclude_small_matches_type
quiz_questions__question_data__regrade_option