cancel
Showing results for 
Search instead for 
Did you mean: 

2018 API Change Log Archive

2018 API Change Log Archive

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

2018-12-08

Additions

Courses API | List Your Courses Endpoint

  • Include parameter: Added graded period parameters to be returned even if total grades are hidden in the course

 

SIS Import Errors API | SISImportError Object

  • Added row_info parameter, which displays the contents of the line that had the error

 

Users API | List the Activity Stream Endpoint

  • Added only_active_courses parameter

 

Changes

SIS Imports API | Abort SIS Import Endpoint

  • Added clarification that aborting a sis batch can take time and subsequent sis batches begin to process 10 minutes after the abort.

 

SIS Imports API | Get SIS Import List Endpoint

  • Workflow_state parameter: added initializing, failed, restoring, partially_restored, and restored as allowed values

 

2018-11-17

Additions

Variable Substitutions | com.instructure.Person.name_sortable

  • Added variable that returns the sortable name of the launching user. Availability is when launched by a logged in user

 

SIS Imports API | Get the Current Importing SIS Import Endpoint

  • Added variable that returns the sortable name of the launching user. Availability is when launched by a logged in user

 

Changes

Assignments API | List Assignments Endpoint

  • Clarified that the paginated list of assignments is returned for the current course or assignment group

 

Planner API

  • Removed the beta warning banner from the API documentation

 

Rubrics API | Create a Single Rubric Endpoint

  • Clarified the rubric return value

 

Roles API | Create a New Role Endpoint

  • Permissions parameter: Updated account- and course-level role names to match roles in the Canvas Permissions page

 

https://canvas.instructure.com/doc/api/planner.html

2018-10-27

Additions

Plagiarism Detection Platform Assignments API | LtiAssignment Object

  • Added LTI Course ID and Course ID return parameters

 

Plagiarism Detection Submissions API | Submission Object

  • Added LTI Course ID and Course ID return parameters

 

Changes

Conversations API | Create a Conversation Endpoint

  • Recipients parameter: Added clarification when the course/group has over 100 enrollments, bulk_message and group_conversation must be set to true

 

Quiz Extensions API | Set Extensions for Student Quiz Submissions Endpoint

  • All parameters: Added quiz_extensions to parameter name

 

Quiz Submissions API | Update Student Question Scores and Comment Endpoint

  • All parameters: Added quiz_submissions to parameter name

 

2018-10-06

Additions

Assignment External Tools 

  • Added content page

 

Courses API | Course Object

  • Added created_at parameter, which returns the date the course was created

 

Groups API

  • Added Permissions Endpoint

 

Deprecations

Accounts API | Permissions Endpoint

  • Added links to Course and Group permissions

 

Courses API | Permissions Endpoint

  • Added links to Account and Group permissions

 

File Uploads | Uploading via POST

  • Step 3: Clarified file management system transition and newer file upload process
  • Step 3: Deprecated POST requests in favor of GET requests for forward compatibility, to be removed 2019-06-01

 

OAuth2 Endpoints | Get login/oauth2/auth

  • Below parameters table, clarified info on scopes for OAuth2 endpoint

 

2018-09-15

Additions

Accounts API | Get Help Links Endpoint

  • Returns the help links for that account

 

Blueprint Courses API | BlueprintSubscription Object

  • Returns the ID of the blueprint course and blueprint template the associated course is subscribed to

 

Blueprint Courses API | List Blueprint Subscriptions Endpoint

  • Returns a list of blueprint subscriptions for the given course (currently a course may have no more than one)


Custom Gradebook Columns API
 | Bulk Update Column Data

  • Sets the content of custom columns

 

SIS Imports API | SIS Import Object 

  • CSV_attachments parameter: Returns an array of CSV files for processing

 

Variable Substitutions | com.instructure.Assignment.anonymous_grading

  • Returns true if the assignment has anonymous grading enabled

 

Variable Substitutions | com.Instructure.membership.roles

  • Returns true if the assignment has anonymous grading enabled

 

2018-08-04

Additions

Outcome Results API | Get Outcome Result Rollups

  • Exclude parameter: Specified additional values to exclude. “Missing_user_rollups” excludes rollups for users without results.
  • Aggregate_stat parameter: If aggregate rollups requested, then this value determines what statistic is used for the aggregate. Defaults to “mean” if this value is not specified.

 

Changes

Outcomes Data Format | outcomes.csv

  • Vendor_guid field: Clarified that vendor_guid IDs will prefix “canvas_outcome:” and “canvas_outcome_group:” for outcomes and groups, respectively. In addition, these prefixes are reserved; newly created outcomes and groups may not have vendor_guid fields with these prefixes.

 

Outcome Results API | Get Outcome Result Rollups

  • Aggregate parameter: Clarified that the median is a separate parameter

 

2018-07-14

Additions

API Token Scopes

  • Added API

 

Proficiency Ratings API

  • Added API

 

Changes

Plagiarism Detection Platform APIs 

  • In the API page sidebar, moved all API documentation for the plagiarism platform to the External Tools section

 

2018-06-23

Additions

SIS Imports API

  • Added Restore workflow_states of SIS Imported Items Endpoint

 

Changes

Files API | File Object

  • Updated file object example and ordering; object returns uuid, folder_id, display_name, and modified_at fields

 

Users API | Get a Pandata JWT Token and its Expiration Date

  • Changed endpoint to reflect use for current user only (/api/v1/users/self/pandata_token)
  • Clarified description in that endpoint is currently only available to the mobile developer keys

 

2018-06-02

Additions

Content Exports API | Export Content Endpoint

  • Added select parameter

 

External Tools API | Create an External Tool Endpoint

  • Added account_navigation[display_type] parameter

 

Grading 

  • Added Submission Details Return Extension documentation, which includes information about supporting Submitted At timestamps

 

Submissions API | Submission Summary Endpoint

  • Added grouped parameter

 

Users API | Create a User Endpoint

  • Added destination parameter

 

2018-05-12

Additions

Accounts API | List Active Courses in an Account

  • Include parameter: Added account_name value

 

Communication Channels API

  • Added Delete a Push Notification Endpoint

 

Courses API | List Your Courses Endpoint

  • Include parameter: Added account object

 

Courses API | List Courses for a User Endpoint

  • Include parameter: Added account object

 

Courses API | Get a Single Course Endpoint

  • Include parameter: Added account object

 

Enrollments API | List Enrollments Endpoint

  • Added enrollment_term_id paramater

 

Submissions API | List Submissions for Multiple Assignments Endpoint

  • Added graded_since parameter

 

Users API | Create a User Endpoint

  • Added destination parameter

 

User Observees API | Add an Observee with Credentials Endpoint

  • Added root_account_id parameter

 

User Observees API | Add an Observee Endpoint

  • Added root_account_id parameter

 

User Observees API | Remove an Observee Endpoint

  • Added root_account_id parameter

 

Changes

Accounts API | List Active Courses in an Account Endpoint

  • Sort parameter: replaced subaccount value with account_name value. Subaccount can still be used as a value for backward compatibility.

 

User Observees API | List Observees Endpoint

  • Clarifies that the returned observees will include the observation_link_root_account_ids attribute

 

2018-04-21

Additions

Accounts API

  • Added Permissions Endpoint

 

Discussion Topics API | Get a Single Topic Endpoint

  • Added include parameter; include overrides as an allowed value

 

Discussion Topics API | List Discussion Topics Endpoint

  • Added include parameter; include overrides as an allowed value

 

Modules API | Module Object

  • Returns the published parameter

 

Modules API | ModuleItem SequenceNode Object

  • Returns the mastery_path parameter and includes examples for the current and next items in the course

 

Modules API | ModuleItemSequence Object

  • Returns full examples for items and modules arrays

 

Sections API | Create Course Section Endpoint

  • Course_section[integration_id] parameter: sets the integration_id of the section

 

SIS CSV Format | changes_sis_id.csv

  • Added group_category as a type
  • Old_integration_id field: description clarifies that this field does not support group categories
  • New_integration_id field: description clarifies that this field does not support group categories

 

SIS Imports API | Import SIS Data Endpoint

  • Skip_deletes parameter: can be used on any type of SIS import; when set, the import will skip any deletes

 

SIS Imports API | SISImport Object

  • Workflow_state parameter: returns whether the SIS import was aborted
  • Skip_deletes parameter: returns whether the import skipped any deleted objects

 

SIS Import Errors API | Get SIS Import Error List Endpoint

  • Returns a list of SIS import errors for an account or SIS import

 

Users API | Get a Pandata JWT Token and its Expiration Date Endpoint

  • Returns a jwt token, which can be used to send events to Canvas Data

 

Changes

Courses API | Permissions Endpoint

  • Includes link to Accounts API Permissions Endpoint
  • Clarifies that permission names are documented in the Create a Role Endpoint

 

Sections API | Create Course Section Endpoint

  • Course_section[sis_section_id] parameter: Notes the user must have the manage_sis permissions to set
Labels (1)
Version history
Revision #:
3 of 3
Last update:
‎08-12-2020 12:14 PM
Updated by: