Canvas LMS · Schema

Canvas LMS Assignment

A Canvas Assignment as returned by GET /api/v1/courses/{course_id}/assignments/{id}. See https://canvas.instructure.com/doc/api/assignments.html

Learning ManagementEducationEdTechLMSLTIHigher EducationK-12Open SourceAGPLCanvas

Properties

Name Type Description
id integer
name string
description stringnull
course_id integer
created_at string
updated_at string
due_at stringnull
lock_at stringnull
unlock_at stringnull
html_url string
assignment_group_id integer
due_date_required boolean
allowed_extensions array
max_name_length integer
turnitin_enabled boolean
vericite_enabled boolean
peer_reviews boolean
automatic_peer_reviews boolean
peer_review_count integer
group_category_id integernull
needs_grading_count integer
position integer
post_to_sis booleannull
integration_id stringnull
points_possible number
submission_types array
has_submitted_submissions boolean
grading_type string
grading_standard_id integernull
published boolean
unpublishable boolean
only_visible_to_overrides boolean
locked_for_user boolean
muted boolean
omit_from_final_grade boolean
hide_in_gradebook boolean
moderated_grading boolean
grader_count integer
final_grader_id integernull
anonymous_grading boolean
allowed_attempts integer
post_manually boolean
View JSON Schema on GitHub

JSON Schema

canvas-lms-assignment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/canvas-lms/main/json-schema/canvas-lms-assignment-schema.json",
  "title": "Canvas LMS Assignment",
  "description": "A Canvas Assignment as returned by GET /api/v1/courses/{course_id}/assignments/{id}. See https://canvas.instructure.com/doc/api/assignments.html",
  "type": "object",
  "required": ["id", "name", "course_id"],
  "properties": {
    "id": {"type": "integer"},
    "name": {"type": "string"},
    "description": {"type": ["string", "null"]},
    "course_id": {"type": "integer"},
    "created_at": {"type": "string", "format": "date-time"},
    "updated_at": {"type": "string", "format": "date-time"},
    "due_at": {"type": ["string", "null"], "format": "date-time"},
    "lock_at": {"type": ["string", "null"], "format": "date-time"},
    "unlock_at": {"type": ["string", "null"], "format": "date-time"},
    "html_url": {"type": "string"},
    "assignment_group_id": {"type": "integer"},
    "due_date_required": {"type": "boolean"},
    "allowed_extensions": {"type": "array", "items": {"type": "string"}},
    "max_name_length": {"type": "integer"},
    "turnitin_enabled": {"type": "boolean"},
    "vericite_enabled": {"type": "boolean"},
    "peer_reviews": {"type": "boolean"},
    "automatic_peer_reviews": {"type": "boolean"},
    "peer_review_count": {"type": "integer"},
    "group_category_id": {"type": ["integer", "null"]},
    "needs_grading_count": {"type": "integer"},
    "position": {"type": "integer"},
    "post_to_sis": {"type": ["boolean", "null"]},
    "integration_id": {"type": ["string", "null"]},
    "points_possible": {"type": "number"},
    "submission_types": {
      "type": "array",
      "items": {"type": "string", "enum": ["discussion_topic", "online_quiz", "on_paper", "none", "external_tool", "online_text_entry", "online_url", "online_upload", "media_recording", "student_annotation"]}
    },
    "has_submitted_submissions": {"type": "boolean"},
    "grading_type": {"type": "string", "enum": ["pass_fail", "percent", "letter_grade", "gpa_scale", "points", "not_graded"]},
    "grading_standard_id": {"type": ["integer", "null"]},
    "published": {"type": "boolean"},
    "unpublishable": {"type": "boolean"},
    "only_visible_to_overrides": {"type": "boolean"},
    "locked_for_user": {"type": "boolean"},
    "muted": {"type": "boolean"},
    "omit_from_final_grade": {"type": "boolean"},
    "hide_in_gradebook": {"type": "boolean"},
    "moderated_grading": {"type": "boolean"},
    "grader_count": {"type": "integer"},
    "final_grader_id": {"type": ["integer", "null"]},
    "anonymous_grading": {"type": "boolean"},
    "allowed_attempts": {"type": "integer"},
    "post_manually": {"type": "boolean"}
  }
}