.course. rubric

Source:
Functions for interacting with rubrics within courses

Methods

createFreeFormGradingRubricInAssignment(opts, configopt) → {Promise.<CanvasRubric>}

Source:
Author:
  • Gabe Abrams
Creates a new rubric for grading with free form comments enabled and add it to an assignment in a course.
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
assignmentId number Canvas course Id to add the rubric to
rubricItems Array List of rubric item objects: [{description, points, [longDescription]}, ...]
courseId number <optional>
 default course id Canvas course Id to add the rubric to
title string <optional>
 generated title Title of the new rubric
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
Canvas Rubric https://canvas.instructure.com/doc/api/rubrics.html#Rubric
Type
Promise.<CanvasRubric>

get(opts, configopt) → {Promise.<CanvasRubric>}

Source:
Author:
  • Gabe Abrams
Gets info on a specific rubric in a course
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
rubricId number Canvas course Id to add the rubric to
courseId number <optional>
 default course id Canvas course Id to add the rubric to
include string <optional>
 Allowed values: ['assessments', 'graded_assessments', 'peer_assessments']. If excluded, no assessments will be included (default: none)
assessmentStyle string <optional>
 both omitted Allowed values: ['full','comments_only'] (full = entire assessment, comments_only = only comment part of assessment). Only valid if including assessments
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
Canvas Rubric https://canvas.instructure.com/doc/api/rubrics.html#Rubric
Type
Promise.<CanvasRubric>

list(optsopt, configopt) → {Promise.<Array.<CanvasRubric>>}

Source:
Author:
  • Gabe Abrams
Lists the set of rubrics in a course
Parameters:
Name Type Attributes Description
opts object <optional>
 object containing all arguments
Properties
Name Type Attributes Default Description
courseId number <optional>
 default course id Canvas course Id to add the rubric to
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
list of Canvas Rubrics https://canvas.instructure.com/doc/api/rubrics.html#Rubric
Type
Promise.<Array.<CanvasRubric>>