New Enum Values in (CD2) DAP Query API

[sgergely]

We’re excited to announce updates to multiple tables and columns in the Canvas namespace with new enumerated values (enums) that will be available in your CD2/DAP Query API dataset starting January 9th. These changes enrich the dataset with additional context and expand the range of supported use cases.

If you’re a DAP CLI user, no action is required on your part—CLI automatically handles new enum values seamlessly.

Summary of Changes

1. Conversation_messages, submission_comments, submissions
   • Column: media_comment_type
     • New Values: 
       • audio/aac, audio/amr, audio/flac, audio/mp4, audio/mpeg, audio/ogg, audio/vnd.dlna.adts, audio/wav, audio/webm, audio/x-m4a, audio/x-ms-wma, audio/x-wav, video/3gpp, video/avi, video/mp4, video/mpeg, video/ogg, video/quicktime, video/webm, video/x-m4v, video/x-matroska, video/x-ms-asf, video/x-ms-wmv, video/x-msvideo
2. access_tokens
   • Column: workflow_state
     • New Value: pending
3. assignment_overrides
   • Column: set_type
     • New Value: Course
4. assignments
   • Column: workflow_state
     • New Values:
       • outcome_alignment_cloning
       • failed_to_clone_outcome_alignment
5. attachments
   • Column: file_state
     • New Values: 
       • active
       • failed
       • public
       • processed
   • Column: context_type
     • New Values: 
       • DiscussionTopic
       • Switchman::Shard
       • DsrRequest
       • DemoSite
       • RubricImport
6. communication_channels
   • Column: workflow_state
     • New Value: deleted
7. content_migrations
   • Column: workflow_state
     • New Values: 
       • course_list_error
       • getting_course_list
       • have_course_list
8. developer_key_account_bindings
   • Column: workflow_state
     • New Value: deleted
9. discussion_topics
   • Column: discussion_type
     • New Value: not_threaded
10. grading_standards
    • Column: workflow_state
      • New Value: archived
11. learning_outcomes
    • Column: calculation_method
      • New Values:
        • weighted_average
        • standard_decaying_average
12. master_courses_master_content_tags
    • Column: content_type
      • New Value: MediaTrack
13. rubrics
    • Column: workflow_state
      • New Values: 
        • archived
        • draft
14. users
    • Column: workflow_state
      • New Value: active

The documentation is going to be updated once the release is out, so it always documents the current, live state of the system.

[stimme]

This is great news! Thanks to you and your team, Gergely.

[JamesSorenson]

@sgergely 

Will this fix the script issues for us trying to deploy to MS SQL Server? (assignments table missing submissions_types column)

[pgo586]

Thanks for your post @sgergely . I'm curious about the addition for the 'users' table of the new 'active' value in workflow_state. Could you comment on how this will affect other values currently in there? (e.g. 'active' users will now have a workflow_state of 'active' vs. whatever they had before?). We need to understand the details of these changes as they will affect some of our CD2 queries, so I'd rather do this proactively. Thanks in advance!

[sgergely]

Happy New Year Everyone!

We have released the changes to the API and to the documentation above with some slight modifications. During our review we have identified that there are enums that were just developer made, temporarily used values so we havent released them. Here is the list that is not published despite the announcement above (it also answers @pgo586 question above as well):

1. attachments
   • Column: file_state
     • New Values: 
       • active
       • failed
       • processed
   • Column: context_type
     • New Values: 
       • DiscussionTopic
       • Switchman::Shard
       • DsrRequest
       • DemoSite
       • RubricImport
2. communication_channels
   • Column: workflow_state
     • New Value: deleted
3. content_migrations
   • Column: workflow_state
     • New Values: 
       • course_list_error
       • getting_course_list
       • have_course_list
4. users
   • Column: workflow_state
     • New Value: active

I'm going to strike through these above in the post and in the release notes as well. 

[pgo586]

Thanks @sgergely for that post. Happy to see better documentation.  Having said that, I do not see how it answers my question above (sorry; I may be missing something here, so please correct me if I'm wrong). For the docs to answer my question, I guess they would probably have to include the semantics of each of the enum values (and describe how usage of the new values replaces usage of the old values). 

[StevenWalls]

This change was not seamless for us. We have multiple production table syncs failing now (ex below).

Is this something you all are working to resolve or what do we need to do?

ALTER TYPE "canvas"."conversation_messages__media_comment_type"

ADD VALUE 'video/3gpp',

ADD VALUE 'video/avi',

2025-01-10 10:25:58,220 - ERROR - error executing query:

ALTER TYPE "canvas"."assignments__workflow_state"

ADD VALUE 'outcome_alignment_cloning',

ADD VALUE 'failed_to_clone_outcome_alignment';

ALTER TYPE "canvas"."rubrics__workflow_state"
ADD VALUE 'archived',
ADD VALUE 'draft';
2025-01-10 11:06:36,247 - ERROR - error executing query:

[marco_divittori]

@StevenWalls have you seen this recent update?

https://community.canvaslms.com/t5/The-Product-Blog/DAP-CLI-1-3-1-Released-Fix-for-PostgreSQL-Sync-I...