Implement a GET call for the Blueprint Courses API

This idea has been developed and deployed to Canvas

Blueprint Courses - Canvas LMS REST API Documentation 

Currently there is no GET call to find out what has already been set in a Blueprint Course.

The GET /api/v1/courses/:course_id/blueprint_templates/default only brings back the template ID, the course ID, and

last_export_completed_at.

A GET call is needed to display:

  • If the course is enabled as a Blueprint course
  • If General Locked Objects have been set (and which ones)
  • If Locked Objects by Type have been set (and which ones)

When updating a course (Courses - Canvas LMS REST API Documentation ), nothing is returned pertaining to Blueprint settings, when they are being set.

There seems to be no way currently to find out what restrictions have been set other than for an admin to go into the course manually and look at the settings.

The only way to find out if a course has even been enabled as a Blueprint course is to use GET /api/v1/courses/:course_id/blueprint_templates/default, which will then give the ID if it is a Blueprint course, or an error if it is not.

E.g. - Enabled

254556_pastedImage_137.png

Not a Blueprint course:

254557_pastedImage_138.png

Comments from Instructure

For more information, please read through https://community.canvaslms.com/docs/DOC-13339-canvas-production-release-notes-2017-11-18 

4 Comments
agschmid
Community Contributor

it looks like this may be implemented soon. It's listed for the 11/6/2017 beta release (doesn't seem to be working yet, though): https://community.canvaslms.com/docs/DOC-13332-canvas-beta-release-notes-2017-11-06#jive_content_id_... 

erinhmcmillan
Instructure Alumni
Instructure Alumni

Hi, Andrea,

Your idea has been completed as part of the Canvas Production Release Notes (2017-11-18) and you should be seeing Blueprint information returned in the Courses API.

Thank you!

Erin 

KristinL
Community Team
Community Team
Status changed to: New
 
KristinL
Community Team
Community Team
Status changed to: Completed