2019 API Change Log Archive

Document created by Erin Hallmark Administrator on Nov 11, 2019
Version 1Show Document
  • View in full screen mode

The Change Log Archive page displays previous API changes from 2019 formerly noted in the API Change Log. The heading date indicates the date that the API code was made available in the production environment.

 

2019-09-21

Changes

Submissions API | Upload a File Endpoint

  • Added validation for file type; if a submission is set to accept only specific file types, the endpoint rejects uploaded file types not included for submission uploads

 

2019-07-31

Additions

Assignments API | List Assignment Endpoint

  • Added post_to_sis parameter

 

OAuth2 Overview

  • Added link to LTI Advantage documentation and section for accessing LTI Advantage Services

 

SIS CSV Format | Logins.csv

  • Added file

 

Changes

SIS CSV Format | Courses.csv

  • Clarified description for account_id to specify that new courses will be attached to the root account if not specified

2019-07-13

Additions

Assignments API | Assignment Object

  • Added posted_manually parameter

 

GraphQL 

  • Added file

 

Submissions API | Submissions Object

  • Added posted_at parameter

 

Variable Substitutions | Canvas.course.sectionRestricted

  • Added variable that corresponds with whether the user was enrolled with the restriction to only interact with users in their own section

 

Changes

Assignments API | Assignment Object | Muted Parameter

  • Updated description for muted parameter regarding Old and New Gradebooks

 

Conversations API | Create a Conversation Endpoint | Group_conversation parameter

  • Updated description to indicate the value must be set to true if the number of recipients is over the set maximum (100)

 

Deprecations

Assignments API | Create an Assignment Endpoint | Assignment[muted] parameter

  • Deprecated for New Gradebook, to be removed 2020-01-18
  • This parameter may only still be used with the Old Gradebook

 

2019-06-22

Additions

Users API | List Users in Account Endpoint

  • Added enrollment_type parameter

2019-06-01

Additions

Files API | Get Uploaded Media Folder for User Endpoint

  • Added endpoint

 

Originality Report API | Create an Originality Report

  • Added originality_report[error_message] parameter

 

Originality Report API | Edit an Originality Report

  • Added originality_report[error_message] parameter

 

Originality Report API | Originality Report Object

  • Returns Error_report

 

Removals

File Uploads | Uploading via POST Process

  • Step 3: Deprecated POST requests in favor of GET requests for forward compatibility
  • Previous announcement date: 2018-10-06

 

2019-05-11

Additions

Assignments API | Create an Assignment Endpoint

  • Added assignment [grader_count], assignment [final_grader_id], assignment [grader_comments_visible_to_graders], assignment [graders_anonymous_to_graders], assignment [graders_names_visible_to_final_grader], assignment [anonymous_grading] parameters

 

Assignments API | Edit an Assignment Endpoint

  • Added assignment [grader_count], assignment [final_grader_id], assignment [grader_comments_visible_to_graders], assignment [graders_anonymous_to_graders], assignment [graders_names_visible_to_final_grader], assignment [anonymous_grading] parameters

 

SIS Imports API | Import SIS Data Endpoint

  • Added diff_row_count_threshold parameter

 

Users API | Merge User Into Another User Endpoint

  • Added user merge details and caveats for behaviors relating to avatars, terms of use, communication channels, enrollments, submissions, access tokens, conversations, favorites, and LTI tools

 

2019-04-20

Additions

Submissions API | Grade or Comment on a Submission Endpoint

  • Rubric_assessment parameter: Added rubric_assessment[criterion_id][rating_id] sub-parameter
  • Added rating IDs to example rubric in description

 

Users API | Update User Settings Endpoint

  • Added hide_dashcard_color_overlays parameter

 

2019-03-30

Additions

Content Migrations API | Create a Content Migration Endpoint

  • Added selective_import parameter

 

Content Migrations API |  List Items for Selective Import Endpoint

  • Added endpoint

 

Changes

Content Migrations API | Update a Content Migration Endpoint

  • Clarified the endpoint takes same arguments as creating a migration
  • Clarified that updating the content migration will also be used when importing content selectively

 

2019-03-09

Changes

SIS Imports API | Imports SIS Data Endpoint

Added change_threshold parameter

 

Users API | To Do Items Endpoint

  • Removed mention of user dashboard, as this API call is not used for the dashboard

 

2019-02-16

Additions

Users API | Edit a User Endpoint

  • Added [user]title and [user]bio parameters

 

2019-01-26

Additions

Assignments API | Assignment Object

  • Returns grader_count, final_grader, grader_comments_visible_to_graders, graders_anonymous_to_graders, grader_names_visible_to_final_grader, and anonymous_grading parameters

 

Submissions API | Submission Object

  • Returns UserDisplay parameter

 

Users API

  • Added AnonyousUserDisplay Object

 

Changes

Submissions API | List Gradeable Students Endpoint

  • Added clarification about anonymous grading

 

Removals

Enrollments API | Enrollment Object

  • Removed computed_current_score, computed_final_score, computed_current_grade, computed_final_grade, current_period_computed_current_score, current_period_computed_final_score, current_period_computed_current_grade, and current_period_computed_final_grade parameters

 

2019-01-05

Additions

Assignments API | Create an Assignment Endpoint

  • Added assignment[allowed_attempts] parameter

 

Assignments API | Edit an Assignment Endpoint

  • Added assignment[allowed_attempts] parameter

 

Assignments API | Assignment Object

  • Added allowed_attempts parameter

 

Conversations API | Create a Conversations Endpoint

  • Added force_new parameter

 

Courses API | Get a Single Course Endpoint

  • Added teacher_limit parameter

 

Enrollments API | Enrollment Object

  • Added override_grade, override_score, current_period_override_grade, and current_period_override_score parameters
  • Added override score clarifications in computed_current_score, computed_final_score, computed_final_grade, current_period_computed_current_score, current_period_computed_final_score, current_period_computed_current_grade, and current_period_computed_final_grade parameters

 

Roles API | Create a New Role Endpoint

  • Permissions_enabled parameter: Added view_audit_trail in permissions list

 

SIS Imports API | SIS Import Statistic Object

  • Added object examples

 

SIS Imports API | SIS Import Statistic Objects

  • Added object examples

 

SIS Imports API | SIS Import Object

  • Workflow_state parameter: Added initializing and failed descriptions
  • Added statistics parameter

 

Submissions API | Submission Object

  • Added extra_attempts parameter


Changes

Developer Keys

  • Verified and corrected all links in document

 

Files API | Delete File Endpoint

  • Clarified endpoint usage and added permanent deletion warning

 

Navigation Tools

  • Removed incorrect auto-generated links from page

 

Removals

Courses API | List Users in Course Endpoint

  • Include parameter: Removed email as an optional parameter

 

View 2018 Canvas API Change Log Archive

Attachments

    Outcomes