Data and Timestamps are in UTC.
These fields are common among events, but not all, and not always sent with each event.
Name | Type | Size | mb | Description/Sample |
---|---|---|---|---|
context_account_id |
bigint | Account id of the record. | ||
context_id_meta |
bigint | The Canvas id of the current context. | ||
context_role_meta |
string | 24 | The role of the current user in the current context. | |
context_sis_source_id |
string | 32 | SIS source id of the current context. | |
context_type_meta |
string | 24 | The type of context where the event happened. | |
developer_key_id |
bigint | For events triggered by external tool. | ||
event_name |
string | 18 | The name of the event. | |
event_time |
datetime | The time, in ISO 8601 format. | ||
hostname |
string | 64 | The domain of the Canvas instance for the request. | |
http_method |
string | 7 | HTTP method/verb (GET, PUT, POST etc.) that was sent with the request. | |
job_id |
bigint | The identifier for the asynchronous job. | ||
job_tag |
string | 100 | A string identifying the type of job being performed. | |
producer |
string | 12 | The name of the producer of an event. Will always be 'canvas' when an event is originating in Canvas, 'quizzes' for Quizzes.Next, or 'quizzes-lti'. | |
real_user_id |
bigint | If the current user is being masqueraded, this is the Canvas id of the masquerading user. | ||
request_id |
string | 36 | The identifier for this request. Correlates to Canvas Data table Requests.id | |
root_account_id |
bigint | The Canvas id of the root account associated with the context of the job. | ||
root_account_lti_guid |
string | 40 | The Canvas lti_guid of the root account associated with the context of the job. | |
root_account_uuid |
string | 40 | The Canvas uuid of the root account associated with the context of the job. | |
session_id |
string | 32 | The session identifier for this request. Can be used to correlate events in the same session for a user. | |
time_zone |
string | 255 | description | |
url_meta |
string | MAX | URL which was requested. | |
referrer |
string | MAX | URL of the page the user clicked to get to the current page. | |
user_account_id |
bigint | The Canvas id of the account that the current user belongs to. | ||
user_agent |
string | 300 | The User-Agent sent by the browser making the request. | |
user_id_meta |
bigint | The Canvas id of the currently logged in user. | ||
user_login_meta |
string | 64 | The login of the current user. | |
user_sis_id_meta |
string | 32 | The SIS id of the user. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
account_notification_id |
bigint | The Canvas id of the account notification.120000000001012 |
||
subject |
string | 255 | The subject of the notification. | |
message |
string | MAX | The message to be sent in the notification.html |
|
icon |
string | 32 | The icon to display with the message. Defaults to warning.information, warning |
|
start_at |
datetime | When to send out the notification.2019-11-02T12:00:46.200Z |
||
end_at |
datetime | When to expire the notification.2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
asset_id |
bigint | The Canvas id of the asset.120000012301234 |
||
asset_name |
string | 500 | The title of a course, page, module, assignment, LTI, attachment etc. | |
asset_type |
string | 24 | The type of asset being accessed.account, assignment, attachment, calendar_event, collaboration, content_tag, context_external_tool, course, discussion_topic, enrollment, group, learning_outcome, lti/tool_proxy, quizzes:quiz, user, web_conference, wiki_page |
|
asset_subtype |
string | 24 | The sub type of asset being accessed.announcements, assignments, calendar_feed, collaborations, conferences, files, grades, home, modules, outcomes, pages, quizzes, roster, speed_grader, syllabus, topics |
|
category |
string | 24 | Navigation Routesannouncements, assignments, calendar, collaborations, conferences, external_tools, external_urls, files, grades, home, modules, outcomes, pages, quizzes, roster, syllabus, topics, wiki |
|
level |
string | 24 | descriptionparticipate, submit |
|
role |
string | 24 | The role of the user accessing the asset.AccountUser, DesignerEnrollment, GroupMembership, ObserverEnrollment, StudentEnrollment, StudentViewEnrollment, TaEnrollment, TeacherEnrollment, User |
|
filename |
string | MAX | true | The file name of the attachment, possibly truncated.image.png |
display_name |
string | MAX | true | The display name of the attachment, possibly truncated. |
domain |
string | 255 | The domain of the web resource or LTI. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
assignment_id |
bigint | The Canvas id of the new assignment.120000001234501 |
||
context_id |
bigint | The type of context the assignment is used in.120000001234560 |
||
context_type |
string | 24 | The type of context the assignment is used in.Course |
|
context_uuid |
string | 40 | The uuid of the context associated with the assignment.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
assignment_group_id |
bigint | The Canvas id of the assignment group.120000001234567 |
||
workflow_state |
string | 19 | Workflow state of the assignment.duplicating, fail_to_import, failed_to_duplicate, published, unpublished |
|
title |
string | 255 | true | The title of the assignment, possibly truncated. |
description |
string | MAX | true | The description of the assignment, possibly truncated. |
due_at |
datetime | The due date for the assignment.2019-11-02T12:00:46.200Z |
||
unlock_at |
datetime | The unlock date (assignment is unlocked after this date).2019-11-02T12:00:46.200Z |
||
lock_at |
datetime | The lock date (assignment is locked after this date).2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this assignment was last modified in any way.2019-11-02T12:00:46.200Z |
||
points_possible |
float | 53 | The maximum points possible for the assignment.100.0 |
|
lti_assignment_id |
string | 36 | The LTI assignment guid for the assignment.a1b2c3c4-z9x8-a1s2-q5w6-p9o8i7u6y5t6 |
|
lti_resource_link_id |
string | 40 | descriptiona1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
lti_resource_link_id_duplicated_from |
string | 255 | descriptiona1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
submission_types |
string | 255 | Valid methods for submitting the assignment, may include multiple comma separated options.discussion_topic, external_tool, media_recording, none, not_graded, on_paper, online_quiz, online_text_entry, online_upload, online_url, wiki_page |
Name | Type | Size | mb | Description |
---|---|---|---|---|
assignment_id |
bigint | The Canvas id of the new assignment.120000001234501 |
||
context_id |
bigint | The type of context the assignment is used in.120000001234567 |
||
context_type |
string | 24 | The type of context the assignment is used in.Course |
|
context_uuid |
string | 40 | The uuid of the context associated with the assignment.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
assignment_group_id |
bigint | The Canvas id of the assignment group.120000001234567 |
||
workflow_state |
string | 19 | Workflow state of the assignment.deleted, duplicating, fail_to_imp, fail_to_import, failed_to_dupl, importing, published, unpublished |
|
title |
string | 255 | true | The title of the assignment, possibly truncated. |
description |
string | MAX | true | The description of the assignment, possibly truncated.html |
due_at |
datetime | The due date for the assignment.2019-11-02T12:00:46.200Z |
||
unlock_at |
datetime | The unlock date (assignment is unlocked after this date).2019-11-02T12:00:46.200Z |
||
lock_at |
datetime | The lock date (assignment is locked after this date).2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this assignment was last modified in any way.2019-11-02T12:00:46.200Z |
||
points_possible |
float | 53 | The maximum points possible for the assignment.100.0 |
|
lti_assignment_id |
string | 36 | The LTI assignment guid for the assignment.a1b2c3c4-z9x8-a1s2-q5w6-p9o8i7u6y5t6 |
|
lti_resource_link_id |
string | 40 | descriptiona1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
lti_resource_link_id_duplicated_from |
string | 255 | descriptiona1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
submission_types |
string | 255 | Valid methods for submitting the assignment, may include multiple comma separated options.discussion_topic, external_tool, media_recording, none, not_graded, on_paper, online_quiz, online_text_entry, online_upload, online_url, wiki_page |
Name | Type | Size | mb | Description |
---|---|---|---|---|
assignment_group_id |
bigint | The Canvas id of the assignment group.1234567 |
||
context_id |
bigint | The type of context the assignment group is used in.1234560 |
||
context_type |
string | 24 | The type of context the assignment group is used in.Course |
|
name |
string | 255 | true | Name of the assignment group. |
position |
int | Position of the assignment group in the assignment page.123 |
||
group_weight |
float | 53 | Weight of the assignment group.100.0 |
|
sis_source_id |
string | 32 | Correlated id for the record for this course in the SIS system (assuming SIS integration is configured). | |
integration_data |
string | 255 | true | description{} |
rules |
string | 255 | true | description |
Name | Type | Size | mb | Description |
---|---|---|---|---|
assignment_group_id |
bigint | The Canvas id of the assignment group.1234567 |
||
context_id |
bigint | The type of context the assignment group is used in.1234567 |
||
context_type |
string | 24 | The type of context the assignment group is used in.Course |
|
name |
string | 255 | true | The name of the assignment group. |
position |
int | Position of the assignment group in the assignment page.12 |
||
group_weight |
float | 53 | Weight of the assignment group.100.0 |
|
sis_source_id |
string | 32 | Correlated id for the record for this course in the SIS system (assuming SIS integration is configured). | |
integration_data |
string | 255 | true | description{} |
rules |
string | 255 | true | descriptionnever_drop:123 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
attachment_id |
bigint | The Canvas id of the attachment.120000012301234 |
||
user_id |
bigint | The Canvas id of the user associated with the attachment.120000001234567 |
||
display_name |
string | MAX | true | The display name of the attachment, possibly truncated. |
filename |
string | MAX | true | The file name of the attachment, possibly truncated.image.png |
folder_id |
bigint | The id of the folder where the attachment was saved.120000001234567 |
||
context_type |
string | 24 | The type of context the attachment is used in.Course, Group, User |
|
context_id |
bigint | The id of the context the attachment is used in.120000001234567 |
||
content_type |
string | 255 | The attached files mime-type. | |
unlock_at |
datetime | The unlock date (attachment is unlocked after this date).2019-11-02T12:00:46.200Z |
||
lock_at |
datetime | The lock date (attachment is locked after this date).2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this attachment was last modified in any way.2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
attachment_id |
bigint | The Canvas id of the attachment.120000012301234 |
||
user_id |
bigint | The Canvas id of the user associated with the attachment.120000001234567 |
||
display_name |
string | MAX | true | The display name of the attachment, possibly truncated.assignment.docx |
filename |
string | MAX | true | The file name of the attachment, possibly truncated.assignment.docx |
folder_id |
bigint | The id of the folder where the attachment was saved.120000001234567 |
||
context_type |
string | 24 | The type of context the attachment is used in.Course, Group, User |
|
context_id |
bigint | The id of the context the attachment is used in.120000001234567 |
||
content_type |
string | 255 | The attached files mime-type. | |
unlock_at |
datetime | The unlock date (attachment is unlocked after this date).2019-11-02T12:00:46.200Z |
||
lock_at |
datetime | The lock date (attachment is locked after this date).2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this attachment was last modified in any way.2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
attachment_id |
bigint | The Canvas id of the attachment.120000012301234 |
||
user_id |
bigint | The Canvas id of the user associated with the attachment.120000001234560 |
||
display_name |
string | MAX | true | The display name of the attachment, possibly truncated.new-profile.jpg |
old_display_name |
string | MAX | true | The new display name of the attachment, possibly truncated.profile.jpg |
filename |
string | MAX | true | The file name of the attachment, possibly truncated.new-profile.jpg |
folder_id |
bigint | The id of the folder where the attachment was saved.120000001234567 |
||
context_type |
string | 24 | The type of context the attachment is used in.Course, User |
|
context_id |
bigint | The id of the context the attachment is used in.120000001234567 |
||
content_type |
string | 255 | The attached files mime-type. | |
unlock_at |
datetime | The unlock date (attachment is unlocked after this date).2019-11-02T12:00:46.200Z |
||
lock_at |
datetime | The lock date (attachment is locked after this date).2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this attachment was last modified in any way.2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
content_migration_id |
bigint | The Canvas id of the content migration.120000000123456 |
||
context_id |
bigint | The Canvas id of the context associated with the content migration.120000001234560 |
||
context_type |
string | 24 | The type of context associated with the content migration.Course |
|
lti_context_id |
string | 40 | The lti context id of the context associated with the content migration.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
context_uuid |
string | 40 | The uuid of the context associated with the content migration.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
import_quizzes_next |
string | 5 | Indicates whether the user requested that the quizzes in the content migration be created in Quizzes.Next (true) or in native Canvas (false).true |
Name | Type | Size | mb | Description |
---|---|---|---|---|
requirement_count |
int | Count of all the requirements in the course as a number.120 |
||
requirement_completed_count |
int | The count of those requirements that are done.120 |
||
next_requirement_url |
string | 255 | Link to the module item that is next in the order of requirements to complete.http://edu.instructure.com/courses/12345/modules/items/12345 |
|
completed_at |
datetime | Timestamp when the course was completed.2019-11-02T12:00:46.200Z |
||
user_email |
string | 255 | The students email.user@domain.tld |
|
user_id |
bigint | The Canvas id of the student completing the course.1234567 |
||
user_name |
string | 64 | The name of the student. | |
course_id |
int | The local Canvas id of the course.1234567 |
||
course_name |
string | 255 | The name of the course. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
course_id |
bigint | The Canvas id of the created course.120000001234560 |
||
uuid |
string | 40 | The unique id of the course.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
account_id |
bigint | The Account id of the created course.120000000120012 |
||
name |
string | 255 | The name the created course. | |
created_at |
datetime | The time at which this course was created.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this course was last modified in any way.2019-11-02T12:00:46.200Z |
||
workflow_state |
string | 12 | The state of the course.claimed, created |
Name | Type | Size | mb | Description |
---|---|---|---|---|
requirement_count |
int | Count of all the requirements in the course as a number.123 |
||
requirement_completed_count |
int | The count of those requirements that are done.101 |
||
next_requirement_url |
string | 255 | Link to the module item that is next in the order of requirements to complete.http://edu.instructure.com/courses/12345/modules/items/12345 |
|
completed_at |
datetime | Timestamp when the course was completed.2019-11-02T12:00:46.200Z |
||
user_email |
string | 255 | The students email.user@domain.tld |
|
user_id |
bigint | The Canvas id of the student completing the course.120000001234567 |
||
user_name |
string | 64 | The name of the student. | |
course_id |
int | The local Canvas id of the course.1234567 |
||
course_name |
string | 255 | The name of the course. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
course_section_id |
int | The local Canvas id of the section.1234567 |
||
sis_source_id |
string | 32 | Correlated id for the record for this course in the SIS system (assuming SIS integration is configured). | |
sis_batch_id |
string | 32 | The batch id of the sis import. | |
course_id |
int | The Canvas id of the course.1234560 |
||
enrollment_term_id |
string | 255 | The Canvas id of the enrollment term. | |
name |
string | 255 | The name of the course. | |
default_section |
string | 5 | True if this is the default section.true |
|
accepting_enrollments |
string | 255 | True if this section is open for enrollment. | |
can_manually_enroll |
string | 255 | Deprecated, will always be null. | |
start_at |
datetime | Section start date in ISO8601 format. | ||
end_at |
datetime | Section end date in ISO8601 format. | ||
workflow_state |
string | 7 | The workflow state of the section.active |
|
restrict_enrollments_to_section_dates |
string | 5 | True when 'Users can only participate in the course between these dates' is checked.false |
|
nonxlist_course_id |
string | 255 | The unique identifier of the original course of a cross-listed section. | |
stuck_sis_fields |
string | 100 | descriptioncourse_id,name |
|
integration_id |
string | 255 | description |
Name | Type | Size | mb | Description |
---|---|---|---|---|
course_section_id |
int | The local Canvas id of the section.1234567 |
||
sis_source_id |
string | 32 | Correlated id for the record for this course in the SIS system (assuming SIS integration is configured). | |
sis_batch_id |
string | 32 | The batch id of the sis import. | |
course_id |
int | The local Canvas id of the course.1234567 |
||
enrollment_term_id |
string | 255 | The Canvas id of the enrollment term. | |
name |
string | 255 | The name of the course. | |
default_section |
string | 5 | True if this is the default section.true |
|
accepting_enrollments |
string | 255 | True if this section is open for enrollment. | |
can_manually_enroll |
string | 255 | Deprecated, will always be null. | |
start_at |
datetime | Section start date in ISO8601 format.2019-11-02T12:00:46.200Z |
||
end_at |
datetime | Section end date in ISO8601 format.2019-11-02T12:00:46.200Z |
||
workflow_state |
string | 7 | The workflow state of the section.active, deleted |
|
restrict_enrollments_to_section_dates |
string | 5 | True when 'Users can only participate in the course between these dates' is checked.true |
|
nonxlist_course_id |
string | 255 | The unique identifier of the original course of a cross-listed section.1357227 |
|
stuck_sis_fields |
string | 100 | descriptionname,start_at,restrict_enrollments_to_section_dates |
|
integration_id |
string | 255 | description |
Name | Type | Size | mb | Description |
---|---|---|---|---|
course_id |
bigint | The Canvas id of the updated course.120000001234560 |
||
account_id |
bigint | The Account id of the updated course.120000000120012 |
||
uuid |
string | 40 | The unique id of the course.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
name |
string | 255 | The name the updated course. | |
created_at |
datetime | The time at which this course was created.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this course was last modified in any way.2019-11-02T12:00:46.200Z |
||
workflow_state |
string | 12 | The state of the course.available, claimed, completed, created, deleted |
Name | Type | Size | mb | Description |
---|---|---|---|---|
user_id |
bigint | The Canvas id of the user posting.120000001234567 |
||
created_at |
datetime | The time at which this entry was created.2019-11-02T12:00:46.200Z |
||
parent_discussion_entry_id |
bigint | If this was a reply, the Canvas id of the parent entry.120000001234012 |
||
parent_discussion_entry_author_id |
bigint | If this was a reply, the Canvas id of the parent entry author. | ||
discussion_entry_id |
bigint | The Canvas id of the newly added entry.120000001234012 |
||
discussion_topic_id |
bigint | The Canvas id of the topic the entry was added to.120000001234567 |
||
text |
string | MAX | The text of the post, possibly truncated. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
user_id |
bigint | The Canvas id of the user posting.120000001234567 |
||
created_at |
datetime | The time at which this entry was submitted.2019-11-02T12:00:46.200Z |
||
discussion_entry_id |
bigint | The Canvas id of the newly added entry.120000001234012 |
||
discussion_topic_id |
bigint | The Canvas id of the topic the entry was added to.120000001234567 |
||
text |
string | MAX | The text of the post, possibly truncated. | |
parent_discussion_entry_id |
bigint | If this was a reply, the Canvas id of the parent entry.120000001234012 |
||
assignment_id |
bigint | The local Canvas id, if the discussion is an assignment.1234560 |
||
submission_id |
bigint | The local Canvas id of the submission.12345678 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
discussion_topic_id |
bigint | The Canvas id of the new discussion topic.120000001234567 |
||
is_announcement |
string | 5 | true if this topic was posted as an announcement, false otherwise.true |
|
title |
string | 255 | true | Title of the topic, possibly truncated. |
body |
string | MAX | true | Body of the topic, possibly truncated.html |
assignment_id |
bigint | The local Canvas id of the assignment.1234010 |
||
context_id |
bigint | The type of context the discussion topic is used in.1234560 |
||
context_type |
string | 24 | The type of context the discussion topic is used in.Course, Group |
|
workflow_state |
string | 24 | The state of the discussion.active, deleted, post_delayed, unpublished |
|
lock_at |
datetime | The lock date (discussion is locked after this date).2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this enrollment was last modified in any way.2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
discussion_topic_id |
bigint | The Canvas id of the new discussion topic.120000001234567 |
||
is_announcement |
string | 5 | true if this topic was posted as an announcement, false otherwise.true |
|
title |
string | 255 | true | Title of the topic, possibly truncated. |
body |
string | MAX | true | Body of the topic, possibly truncated.html |
assignment_id |
bigint | The local Canvas id of the assignment.1 |
||
context_id |
bigint | The type of context the discussion topic is used in.1234567 |
||
context_type |
string | 24 | The type of context the discussion_topicis used in.Course, Group |
|
workflow_state |
string | 24 | The state of the discussion.active, deleted, post_delayed, unpublished |
|
lock_at |
datetime | The lock date (discussion is locked after this date).2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this discussion was last modified in any way.2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
enrollment_id |
bigint | The Canvas id of the new enrollment.120000012345678 |
||
course_id |
bigint | The Canvas id of the course for this enrollment.120000001234560 |
||
user_id |
bigint | The Canvas id of the user for this enrollment.120000001234501 |
||
user_name |
string | 64 | The user's name. | |
type |
string | 24 | The type of enrollment.TeacherEnrollment |
|
created_at |
datetime | The time at which this enrollment was created.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this enrollment was last modified in any way.2019-11-02T12:00:46.200Z |
||
limit_privileges_to_course_section |
string | 5 | Whether students can only talk to students within their course section.true |
|
course_section_id |
bigint | The id of the section of the course for the new enrollment.120000001234567 |
||
associated_user_id |
bigint | The id of the user observed by an observer's enrollment. Omitted from non-observer enrollments.120000001234567 |
||
workflow_state |
string | 16 | The state of the enrollment.active, completed, creation_pending, deleted, inactive, invited |
Name | Type | Size | mb | Description |
---|---|---|---|---|
enrollment_id |
bigint | The Canvas id of the new enrollment.120000012345678 |
||
state |
string | 16 | The state of the enrollment.pending_invited |
|
state_started_at |
datetime | The time when this enrollment state starts.2019-11-02T12:00:46.200Z |
||
state_is_current |
string | 5 | If this enrollment_state is up to date.true |
|
state_valid_until |
datetime | The time at which this enrollment is no longer valid.2019-11-02T12:00:46.200Z |
||
restricted_access |
string | 5 | True if this enrollment_state is restricted.true |
|
access_is_current |
string | 5 | If this enrollment_state access is up to date.true |
|
state_invalidated_at |
datetime | Time enrollment_state was invalidated. | ||
state_recalculated_at |
datetime | Time enrollment_state was created. | ||
access_invalidated_at |
datetime | Time enrollment_state access was invalidated. | ||
access_recalculated_at |
datetime | Time enrollment_state access was created. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
enrollment_id |
bigint | The Canvas id of the new enrollment.120000012345678 |
||
state |
string | 16 | The state of the enrollment.rejected |
|
state_started_at |
datetime | The time when this enrollment state starts.2019-11-02T12:00:46.200Z |
||
state_is_current |
string | 5 | If this enrollment_state is up to date.true |
|
state_valid_until |
datetime | The time at which this enrollment is no longer valid.2019-11-02T12:00:46.200Z |
||
restricted_access |
string | 5 | True if this enrollment_state is restricted.true |
|
access_is_current |
string | 5 | If this enrollment_state access is up to date.true |
|
state_invalidated_at |
datetime | Time enrollment_state was invalidated. | ||
state_recalculated_at |
datetime | Time enrollment_state was created. | ||
access_invalidated_at |
datetime | Time enrollment_state access was invalidated. | ||
access_recalculated_at |
datetime | Time enrollment_state access was created. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
enrollment_id |
bigint | The Canvas id of the new enrollment.120000012345678 |
||
course_id |
bigint | The Canvas id of the course for this enrollment.120000001234567 |
||
user_id |
bigint | The Canvas id of the user for this enrollment.120000001234567 |
||
user_name |
string | 64 | The user's name. | |
type |
string | 24 | The type of enrollment.TeacherEnrollment |
|
created_at |
datetime | The time at which this enrollment was created.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this enrollment was last modified in any way.2019-11-02T12:00:46.200Z |
||
limit_privileges_to_course_section |
string | 5 | Whether students can only talk to students within their course section.true |
|
course_section_id |
bigint | The id of the section of the course for the new enrollment.120000001234567 |
||
associated_user_id |
bigint | The id of the user observed by an observer's enrollment. Omitted from non-observer enrollments.120000001234567 |
||
workflow_state |
string | 16 | The state of the enrollment.active, completed, creation_pending, deleted, inactive, invited, rejected |
Name | Type | Size | mb | Description |
---|---|---|---|---|
submission_id |
bigint | The Canvas id of the submission that the grade is changing on.120000012300123 |
||
assignment_id |
bigint | The Canvas id of the assignment associated with the submission.120000001234012 |
||
grade |
string | 80 | The new grade.S |
|
old_grade |
string | 80 | The previous grade, if there was one.S |
|
score |
float | 53 | The new score.99.5 |
|
old_score |
float | 53 | The previous score.89.5 |
|
points_possible |
float | 53 | The maximum points possible for the submission's assignment.100.0 |
|
old_points_possible |
float | 53 | The maximum points possible for the previous grade.100.0 |
|
grader_id |
bigint | The Canvas id of the user making the grade change. Null if this was the result of automatic grading.120000001234567 |
||
student_id |
bigint | Same as the user_id.120000001234560 |
||
student_sis_id |
string | 32 | The SIS ID of the student. | |
user_id |
bigint | The Canvas id of the user associated to the submission with the change.120000001234560 |
||
grading_complete |
string | 5 | The boolean state that the submission is completely graded. False if the assignment is only partially graded, for example a quiz with automatically and manually graded sections. Incomplete grade changes should not be published to students.true |
|
muted |
string | 5 | The boolean muted state of the submissions's assignment. Muted grade changes should not be published to students.true |
Name | Type | Size | mb | Description |
---|---|---|---|---|
group_category_id |
bigint | The Canvas id of the newly created group category.120000000012345 |
||
group_category_name |
string | 255 | The name of the newly created group category. | |
context_id |
bigint | The Canvas id of the group's context.1234567 |
||
context_type |
string | 24 | The type of the group's context.Course |
|
group_limit |
int | The cap of the number of users in each group.12 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
group_category_id |
bigint | The Canvas id of the newly created group category.120000000012345 |
||
group_category_name |
string | 255 | The name of the newly created group category. | |
context_id |
bigint | The Canvas id of the group's context.1234567 |
||
context_type |
string | 24 | The type of the group's context.Course |
|
group_limit |
int | The cap of the number of users in each group.12 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
group_category_id |
bigint | The Canvas id of the group category.120000000012345 |
||
group_category_name |
string | 255 | The name of the group category. | |
group_id |
bigint | The Canvas id of the group.120000000120120 |
||
group_name |
string | 255 | The name of the group. | |
uuid |
string | 40 | The unique id of the group.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
context_type |
string | 24 | The type of the group's context.Course |
|
context_id |
bigint | The Canvas id of the group's context.120000001234567 |
||
account_id |
bigint | The Canvas id of the group's account.120000000123456 |
||
workflow_state |
string | 9 | The state of the group.available, deleted |
|
max_membership |
int | The maximum membership cap for the group.10 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
group_membership_id |
bigint | The Canvas id of the group membership.120000000123456 |
||
user_id |
bigint | The Canvas id of the user being assigned to a group.120000001230123 |
||
group_id |
bigint | The Canvas id of the group the user is assigned to.120000000120120 |
||
group_name |
string | 255 | The name of the group the user is being assigned to. | |
group_category_id |
bigint | The Canvas id of the group category.120000000012345 |
||
group_category_name |
string | 255 | The name of the group category. | |
workflow_state |
string | 8 | The state of the group membership.accepted |
Name | Type | Size | mb | Description |
---|---|---|---|---|
group_membership_id |
bigint | The Canvas id of the group membership.120000000123456 |
||
user_id |
bigint | The Canvas id of the user being assigned to a group.120000001234560 |
||
group_id |
bigint | The Canvas id of the group the user is assigned to.120000000120123 |
||
group_name |
string | 255 | The name of the group the user is being assigned to. | |
group_category_id |
bigint | The Canvas id of the group category.120000000012345 |
||
group_category_name |
string | 255 | The name of the group category. | |
workflow_state |
string | 7 | The state of the group membership.deleted |
Name | Type | Size | mb | Description |
---|---|---|---|---|
group_category_id |
bigint | The Canvas id of the group category120000000012345 |
||
group_category_name |
string | 255 | The name of the group category. | |
group_id |
bigint | The Canvas id of the group.120000000120120 |
||
group_name |
string | 255 | The name of the group. | |
uuid |
string | 40 | The unique id of the group.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
context_type |
string | 24 | The type of the group's contextCourse |
|
context_id |
bigint | The Canvas id of the group's context.120000001234567 |
||
account_id |
bigint | The Canvas id of the group's account.120000000123456 |
||
workflow_state |
string | 9 | The state of the group.available, deleted |
|
max_membership |
int | The maximum membership cap for the group.10 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
learning_outcome_id |
bigint | The local Canvas if of the learning outcome.1230123 |
||
context_id |
bigint | The type of context the learning outcome is used in.1234567 |
||
context_type |
string | 24 | The type of context the learning outcome is used in.Course |
|
display_name |
string | 255 | Optional friendly name for reporting. | |
short_description |
string | 255 | Also the title of the outcome. | |
description |
string | MAX | true | Description of the outcome.html |
vendor_guid |
string | 100 | A custom GUID for the learning standard. | |
calculation_method |
string | 255 | The method used to calculate student score.decaying_average, highest |
|
calculation_int |
int | Defines the variable value used by the calculation_method. Included only if calculation_method uses it.12 |
||
rubric_criterion_description |
string | 255 | Also the title of the outcome. | |
rubric_criterion_ratings |
string | 1000 | description[{"description":"Meets Expectations","points":8.0},{"description":"Does Not Meet Expectations","points":1.0},{"description":"Did Not Turn In","points":0.0}] |
|
rubric_criterion_mastery_points |
float | 53 | description3.5 |
|
rubric_criterion_points_possible |
float | 53 | description10.0 |
|
title |
string | 255 | The title of the learning outcome or learning outcome group. | |
workflow_state |
string | 6 | Workflow status of the learning outcome. Defaults to active.active |
Name | Type | Size | mb | Description |
---|---|---|---|---|
learning_outcome_group_id |
bigint | The local Canvas id of the learning outcome group.123456 |
||
context_id |
bigint | The type of context the learning outcome is used in.1234567 |
||
context_type |
string | 24 | The type of context the learning outcome is used in.Course |
|
title |
string | 255 | Title of the learning outcome group. | |
description |
string | 255 | Description of the outcome. | |
vendor_guid |
string | 100 | A custom GUID for the learning standard. | |
parent_outcome_group_id |
bigint | description123456 |
||
workflow_state |
string | 6 | Workflow status of the learning outcome.active |
Name | Type | Size | mb | Description |
---|---|---|---|---|
learning_outcome_group_id |
bigint | The local Canvas id of the learning outcome group.123456 |
||
context_id |
bigint | The type of context the learning outcome is used in.1234567 |
||
context_type |
string | 24 | The type of context the learning outcome is used in.Course |
|
title |
string | 255 | Title of the learning outcome group. | |
description |
string | 255 | Description of the outcome. | |
vendor_guid |
string | 100 | A custom GUID for the learning standard. | |
parent_outcome_group_id |
bigint | description | ||
workflow_state |
string | 6 | Workflow status of the learning outcome.active |
|
updated_at |
datetime | The time at which this group was last modified in any way2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
learning_outcome_link_id |
bigint | description12345678 |
||
learning_outcome_id |
bigint | The local Canvas if of the learning outcome.1201234 |
||
learning_outcome_group_id |
bigint | The local Canvas id of the learning outcome group.123456 |
||
context_id |
bigint | The type of context the learning outcome is used in.1234567 |
||
context_type |
string | 24 | The type of context the learning outcome is used in.Course |
|
workflow_state |
string | 6 | descriptionactive |
Name | Type | Size | mb | Description |
---|---|---|---|---|
learning_outcome_link_id |
bigint | description | ||
learning_outcome_id |
bigint | The local Canvas if of the learning outcome. | ||
learning_outcome_group_id |
bigint | The local Canvas id of the learning outcome group. | ||
context_id |
bigint | The type of context the learning outcome is used in. | ||
context_type |
string | 24 | The type of context the learning outcome is used in. | |
workflow_state |
string | 6 | description | |
updated_at |
datetime | description2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
learning_outcome_id |
bigint | The local Canvas if of the learning outcome.1230123 |
||
mastery |
int | True if student achieved mastery.1230123 |
||
score |
float | 53 | The student's score.99.5 |
|
created_at |
datetime | Time when the result was created.2019-11-02T12:00:46.200Z |
||
attempt |
int | This is the submission attempt number.1 |
||
possible |
float | 53 | Total number of points possible.20.0 |
|
original_score |
float | 53 | Score on the first attempt.20.0 |
|
original_possible |
float | 53 | Possible points on the first attempt.20.0 |
|
original_mastery |
string | 5 | True if student achieved mastery.true |
|
assessed_at |
datetime | description | ||
title |
string | 255 | description | |
percent |
float | 53 | Percent of maximum points possible for an outcome, scaled to reflect any custom mastery levels that differ from the learning outcome.1.0 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
learning_outcome_id |
bigint | The local Canvas if of the learning outcome.1230123 |
||
mastery |
int | True if student achieved mastery.1230123 |
||
score |
float | 53 | The student's score.99.5 |
|
created_at |
datetime | Time when the result was first created.2019-11-02T12:00:46.200Z |
||
attempt |
int | This is the submission attempt number.10 |
||
possible |
float | 53 | Total number of points possible.20.0 |
|
original_score |
float | 53 | Score on the first attempt.20.0 |
|
original_possible |
float | 53 | Possible points on the first attempt.20.0 |
|
original_mastery |
string | 5 | True if student achieved mastery.true |
|
assessed_at |
datetime | description2019-11-02T12:00:46.200Z |
||
title |
string | 255 | description | |
percent |
float | 53 | Percent of maximum points possible for an outcome, scaled to reflect any custom mastery levels that differ from the learning outcome.1.0 |
|
updated_at |
datetime | Percent of maximum points possible for an outcome, scaled to reflect any custom mastery levels that differ from the learning outcome.2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
learning_outcome_id |
bigint | The local Canvas if of the learning outcome | ||
context_id |
bigint | The type of context the learning_outcome is used in. | ||
context_type |
string | 24 | The type of context the learning_outcome is used in. | |
display_name |
string | 255 | Optional friendly name for reporting. | |
short_description |
string | 255 | Also the title of the outcome. | |
description |
string | MAX | true | Description of the outcome. |
vendor_guid |
string | 100 | A custom GUID for the learning standard. | |
calculation_method |
string | 255 | The method used to calculate student score. | |
calculation_int |
int | Defines the variable value used by the calculation_method. Included only if calculation_method uses it. | ||
rubric_criterion_description |
string | 255 | Also the title of the outcome. | |
rubric_criterion_ratings |
string | 1000 | description | |
rubric_criterion_mastery_points |
float | 53 | description | |
rubric_criterion_points_possible |
float | 53 | description | |
title |
string | 255 | The title of the learning outcome or learning outcome group. | |
workflow_state |
string | 6 | Workflow status of the learning outcome. Defaults to active | |
updated_at |
datetime | The time at which this outcome was last modified in any way.2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
redirect_url |
string | MAX | The URL the user was redirected to after logging in. Is set when the user logs in after clicking a deep link into Canvas.https://edu.instructure.com/users/self?display=borderless |
Name | Type | Size | mb | Description |
---|
Name | Type | Size | mb | Description |
---|---|---|---|---|
module_id |
int | The Canvas id of the module.1234567 |
||
context_id |
bigint | The local Canvas id of the context.1234560 |
||
context_type |
string | 24 | The type of module's context.Course |
|
name |
string | 255 | The name of the module. | |
position |
int | The position of the module in the course.101 |
||
workflow_state |
string | 11 | The workflow state of the module.active, unpublished |
Name | Type | Size | mb | Description |
---|---|---|---|---|
module_item_id |
int | The Canvas id of the module item.12340123 |
||
module_id |
int | The Canvas id of the module.1234567 |
||
context_id |
bigint | The local Canvas id of the context.1234560 |
||
context_type |
string | 24 | The type of module's context.Course |
|
position |
int | The position of the module item in the module.1012 |
||
workflow_state |
string | 11 | The workflow state of the module item.active, unpublished |
Name | Type | Size | mb | Description |
---|---|---|---|---|
module_item_id |
int | The Canvas id of the module item.12340012 |
||
module_id |
int | The Canvas id of the module.1234567 |
||
context_id |
bigint | The local Canvas id of the context.1234567 |
||
context_type |
string | 24 | The type of module's context.Course |
|
position |
int | The position of the module item in the module.123 |
||
workflow_state |
string | 11 | The workflow state of the module item.active, deleted, unpublished |
Name | Type | Size | mb | Description |
---|---|---|---|---|
module_id |
int | The Canvas id of the module.1234567 |
||
context_id |
bigint | The local Canvas id of the context.1234567 |
||
context_type |
string | 24 | The type of module's context.Course |
|
name |
string | 255 | The name of the module. | |
position |
int | The position of the module in the course.123 |
||
workflow_state |
string | 11 | The workflow state of the module.active, deleted, unpublished |
Name | Type | Size | mb | Description |
---|---|---|---|---|
submission_id |
bigint | The Canvas id of the new submission.120000012345678 |
||
assignment_id |
bigint | The Canvas id of the assignment being submitted.120000001234500 |
||
user_id |
bigint | The Canvas id of the user associated with the submission.120000001234012 |
||
submitted_at |
datetime | The timestamp when the assignment was submitted.2019-11-02T12:00:46.200Z |
||
lti_user_id |
string | 40 | The LTI id of the user associated with the submission.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
graded_at |
datetime | The timestamp when the assignment was graded.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this assignment was last modified in any way.2019-11-02T12:00:46.200Z |
||
score |
float | 53 | The raw score.99.5 |
|
grade |
string | 70 | The grade for the submission, translated into the assignment grading scheme (so a letter grade, for example)F |
|
submission_type |
string | 24 | The types of submission.online_upload |
|
body |
string | MAX | true | The content of the submission, if it was submitted directly in a text field, possibly truncated. |
url |
string | 255 | The URL of the submission (for 'online_url' submissions) | |
attempt |
int | This is the submission attempt number.1 |
||
lti_assignment_id |
string | 36 | The LTI assignment guid of the submission's assignmenta1b2c3c4-z9x8-a1s2-q5w6-p9o8i7u6y5t6 |
|
group_id |
string | 255 | The submissions’s group ID if the assignment is a group assignment. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
context_type |
string | 24 | ||
context_id |
bigint | |||
assignment_resource_link_id |
string | 40 | descriptiona1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
assignment_title |
string | 255 | true | Title of the quiz |
assignment_context_title |
string | 255 | true | Title of the course |
assignment_course_uuid |
string | 40 | The unique id of the course for this association.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
qti_export_url |
string | MAX | The URL of the exported quiz, zip filehttps://inst-fs-iad-prod.inscloudgate.net/files/a1b2c3c4-z9x8-a1s2-q5w6-p9o8i7u6y5t6/xyz.zip?download=1&xyz |
Name | Type | Size | mb | Description |
---|---|---|---|---|
submission_id |
bigint | The Canvas id of the quiz submission.120000001234567 |
||
quiz_id |
bigint | The Canvas id of the quiz.120000001234567 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
id |
int | description12301 |
||
title |
string | 255 | true | description |
label |
string | 255 | description | |
item_body |
string | MAX | description | |
properties_rich_content_editor |
string | 255 | descriptionfalse |
|
properties_show_word_count |
string | 255 | descriptionfalse |
|
properties_shuffle_rules |
string | MAX | descriptionnull |
|
properties_spell_check |
string | 255 | descriptionfalse |
|
properties_word_limit_max |
string | 255 | description0 |
|
properties_word_limit_min |
string | 255 | description0 |
|
properties_word_limit |
string | 255 | descriptionfalse |
|
properties_display_answers_paragraph |
string | 255 | descriptionfalse |
|
properties_include_labels |
string | 255 | descriptiontrue |
|
properties_top_label |
string | 255 | description | |
properties_bottom_label |
string | 255 | description | |
interaction_data_choices |
string | MAX | description{} |
|
interaction_data_true_choice |
string | 5 | descriptionTrue |
|
interaction_data_false_choice |
string | 5 | descriptionFalse |
|
interaction_data_essay |
string | 255 | descriptionnull |
|
interaction_data_rce |
string | 255 | descriptiontrue |
|
interaction_data_spell_check |
string | 255 | descriptiontrue |
|
interaction_data_word_count |
string | 255 | descriptiontrue |
|
interaction_data_word_limit_enabled |
string | 255 | descriptiontrue |
|
interaction_data_word_limit_max |
string | 255 | descriptionnull |
|
interaction_data_word_limit_min |
string | 255 | descriptionnull |
|
interaction_data_file_upload |
string | 255 | descriptionfalse |
|
user_response_type |
string | 16 | descriptionBoolean, Hash, HashOfTexts, MultipleResponse, MultipleUuid, Text, Uuid |
|
outcome_alignment_set_guid |
string | 255 | descriptiona1b2c3c4-z9x8-a1s2-q5w6-p9o8i7u6y5t6 |
|
scoring_data |
string | MAX | description{"value":true} |
|
scoring_algorithm |
string | 18 | descriptionAllOrNothing, Categorization, DeepEquals, Equivalence, HotSpot, MultipleMethods, None, Numeric, VaryPointsByAnswer |
Name | Type | Size | mb | Description |
---|---|---|---|---|
id |
int | description12345 |
||
title |
string | 255 | true | description |
label |
string | 255 | description | |
item_body |
string | MAX | description | |
properties_rich_content_editor |
string | 255 | descriptionfalse |
|
properties_show_word_count |
string | 255 | descriptionfalse |
|
properties_shuffle_rules |
string | MAX | descriptionnull |
|
properties_spell_check |
string | 255 | descriptionfalse |
|
properties_word_limit_max |
string | 255 | description0 |
|
properties_word_limit_min |
string | 255 | description0 |
|
properties_word_limit |
string | 255 | descriptionfalse |
|
properties_display_answers_paragraph |
string | 255 | descriptionfalse |
|
properties_include_labels |
string | 255 | descriptiontrue |
|
properties_top_label |
string | 255 | description | |
properties_bottom_label |
string | 255 | description | |
interaction_data_choices |
string | MAX | description{} |
|
interaction_data_true_choice |
string | 5 | descriptionTrue |
|
interaction_data_false_choice |
string | 5 | descriptionFalse |
|
interaction_data_essay |
string | 255 | descriptionnull |
|
interaction_data_rce |
string | 255 | descriptiontrue |
|
interaction_data_spell_check |
string | 255 | descriptiontrue |
|
interaction_data_word_count |
string | 255 | descriptiontrue |
|
interaction_data_word_limit_enabled |
string | 255 | descriptiontrue |
|
interaction_data_word_limit_max |
string | 255 | descriptionnull |
|
interaction_data_word_limit_min |
string | 255 | descriptionnull |
|
interaction_data_file_upload |
string | 255 | descriptionfalse |
|
user_response_type |
string | 16 | descriptionBoolean, Hash, HashOfTexts, MultipleResponse, MultipleUuid, Text, Uuid |
|
outcome_alignment_set_guid |
string | 255 | descriptiona1b2c3c4-z9x8-a1s2-q5w6-p9o8i7u6y5t6 |
|
scoring_data |
string | MAX | description{"value":true} |
|
scoring_algorithm |
string | 18 | descriptionAllOrNothing, Categorization, DeepEquals, Equivalence, HotSpot, MultipleMethods, None, Numeric, VaryPointsByAnswer |
Name | Type | Size | mb | Description |
---|---|---|---|---|
user_uuid |
string | 40 | UUID of the user.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
quiz_id |
int | The local Quizzes.Next id of the quiz.12301 |
||
score_to_keep |
string | 7 | Scoring policy, could be average, highest, or latest.latest |
Name | Type | Size | mb | Description |
---|---|---|---|---|
new_assignment_id |
bigint | description | ||
original_course_uuid |
string | 40 | descriptiona1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
original_resource_link_id |
string | 40 | description | |
new_course_uuid |
string | 40 | descriptiona1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
new_course_id |
string | 40 | description | |
new_resource_link_id |
string | 40 | description |
Name | Type | Size | mb | Description |
---|---|---|---|---|
qti_type |
string | 14 | description | |
quiz_id |
int | The local Quizzes.Next id of the quiz.12345 |
||
success |
string | 5 | True if the import completed, False otherwise.true |
Name | Type | Size | mb | Description |
---|---|---|---|---|
id |
string | 255 | The Quizzes.Next id of the job.9999 |
|
original_quiz_id |
string | 255 | The local Quizzes.Next id of the quiz.9978 |
|
status |
string | 255 | Status of the job.scheduled |
Name | Type | Size | mb | Description |
---|---|---|---|---|
id |
string | 255 | The Quizzes.Next id of the job.9999 |
|
original_quiz_id |
string | 255 | The local Quizzes.Next id of the quiz.9978 |
|
status |
string | 255 | Status of the job.cloning, completed |
|
cloned_quiz_id |
string | 255 | The local Quizzes.Next id of the quiz.9999 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
id |
int | The local Quizzes.Next id of the quiz.12345 |
||
title |
string | 255 | true | The title of the quiz. |
instructions |
string | MAX | The instructions for the quiz.html |
|
context_id |
bigint | description1 |
||
owner |
string | 40 | descriptiona1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
has_time_limit |
string | 5 | True if the quiz has a time limit, false otherwise.true |
|
due_at |
datetime | The due date for the quiz.2019-11-02T12:00:46.200Z |
||
lock_at |
datetime | The lock date (quiz is locked after this date).2019-11-02T12:00:46.200Z |
||
session_time_limit_in_seconds |
int | The number of seconds the student has to complete the quiz.123000 |
||
shuffle_questions |
string | 5 | True if the questions are shuffled.true |
|
shuffle_answers |
string | 5 | True if the answers are shuffled.false |
|
status |
string | 18 | Workflow state of the quiz.uninitialized, unpublished |
|
outcome_alignment_set_guid |
string | 255 | description |
Name | Type | Size | mb | Description |
---|---|---|---|---|
quiz_session_id |
int | description123450 |
||
quiz_session_result_id |
int | description123456 |
||
grader_id |
bigint | description0 |
||
grading_method |
string | 14 | descriptionautograde, manual_grading, regrading |
|
status |
string | 18 | descriptionautogr, graded |
|
score |
float | 53 | description99.5 |
|
fudge_points |
string | 255 | Number of points the quiz submission's score was fudged (changed) by. Values can be negative or positive.9.0 |
|
points_possible |
float | 53 | The maximum points possible for the quiz.100.0 |
|
percentage |
float | 53 | description2.0 |
|
created_at |
datetime | The time at which this quiz was graded.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | description2019-11-02T12:00:46.200Z |
Name | Type | Size | mb | Description |
---|---|---|---|---|
accepted_student_access_code_at |
datetime | description2019-11-02T12:00:46.200Z |
||
allow_backtracking |
string | 5 | descriptiontrue |
|
attempt |
int | description12 |
||
authoritative_result_id |
int | description0 |
||
created_at |
datetime | description2019-11-02T12:00:46.200Z |
||
end_at |
datetime | description2019-11-02T12:00:46.200Z |
||
grade_passback_guid |
string | 255 | description | |
graded_url |
string | 78 | descriptionhttps://edu.quiz-lti-iad-prod.instructure.com/api/quiz_sessions/99999/graded |
|
id |
int | description123450 |
||
invalidated_student_access_code_at |
datetime | description2019-11-02T12:00:46.200Z |
||
one_at_a_time_type |
string | 8 | descriptionnone, question |
|
passback_url |
string | 255 | description | |
points_possible |
float | 53 | The maximum points possible for the submitted quiz.100.0 |
|
quiz_id |
int | description12301 |
||
session_items_count |
int | description100 |
||
start_at |
datetime | description2019-11-02T12:00:46.200Z |
||
status |
string | 11 | descriptionautograding |
|
submitted_at |
datetime | description2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | description2019-11-02T12:00:46.200Z |
||
exclude_from_stats |
string | 255 | true |
Name | Type | Size | mb | Description |
---|---|---|---|---|
accepted_student_access_code_at |
datetime | description2019-11-02T12:00:46.200Z |
||
allow_backtracking |
string | 5 | descriptiontrue |
|
attempt |
int | description1 |
||
authoritative_result_id |
int | description0 |
||
created_at |
datetime | description2019-11-02T12:00:46.200Z |
||
end_at |
datetime | description | ||
grade_passback_guid |
string | 255 | description | |
graded_url |
string | 78 | descriptionhttps://edc.quiz-lti-iad-prod.instructure.com/api/quiz_sessions/12345/graded |
|
id |
int | description123450 |
||
invalidated_student_access_code_at |
datetime | description2019-11-02T12:00:46.200Z |
||
one_at_a_time_type |
string | 8 | descriptionnone, question |
|
passback_url |
string | 255 | description | |
points_possible |
float | 53 | The maximum points possible for the quiz.100.0 |
|
quiz_id |
int | description12345 |
||
session_items_count |
int | description12 |
||
start_at |
datetime | description | ||
status |
string | 11 | descriptionin_progress |
|
submitted_at |
datetime | description2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | description2019-11-02T12:00:46.200Z |
||
exclude_from_stats |
string | 255 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
id |
int | The local Quizzes.Next id of the quiz.12345 |
||
title |
string | 255 | true | The title of the quiz. |
instructions |
string | MAX | The instructions for the quiz.html |
|
context_id |
bigint | description1 |
||
owner |
string | 40 | descriptiona1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
has_time_limit |
string | 5 | True if the quiz has a time limit, false otherwise.true |
|
due_at |
datetime | The due date for the quiz.2019-11-02T12:00:46.200Z |
||
lock_at |
datetime | The lock date (quiz is locked after this date).2019-11-02T12:00:46.200Z |
||
session_time_limit_in_seconds |
int | The number of seconds the student has to complete the quiz.123450 |
||
shuffle_questions |
string | 5 | True if the questions are shuffled.true |
|
shuffle_answers |
string | 5 | True if the answers are shuffled.false |
|
status |
string | 16 | Workflow state of the quiz.importing, uninitialized, unpublished |
|
outcome_alignment_set_guid |
string | 255 | description |
Name | Type | Size | mb | Description |
---|---|---|---|---|
submission_comment_id |
bigint | The local Canvas id of the submission comment.1200123 |
||
submission_id |
bigint | The local Canvas if of the submission.12345678 |
||
user_id |
bigint | The local Canvas id of the user making the comment.1234567 |
||
created_at |
datetime | The time at which this comment was created.2019-11-02T12:00:46.200Z |
||
attachment_ids |
string | 255 | The local Canvas ids of attachments for the comment, comma separated if more than are attached.63904721 |
|
body |
string | MAX | 96 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
submission_id |
bigint | The Canvas id of the new submission.120000012300120 |
||
assignment_id |
bigint | The Canvas id of the assignment being submitted.120000001234012 |
||
user_id |
bigint | The Canvas id of the user associated with the submission.120000001234560 |
||
submitted_at |
datetime | The timestamp when the assignment was submitted.2019-11-02T12:00:46.200Z |
||
lti_user_id |
string | 40 | The LTI id of the user associated with the submission.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
graded_at |
datetime | The timestamp when the assignment was graded, if it was graded.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this assignment was last modified in any way.2019-11-02T12:00:46.200Z |
||
score |
float | 53 | The raw score99.5 |
|
grade |
string | 255 | The grade for the submission, translated into the assignment grading scheme (so a letter grade, for example)Missing |
|
submission_type |
string | 24 | The types of submissionbasic_lti_launch, discussion_topic, media_recording, online_quiz, online_text_entry, online_upload, online_url |
|
body |
string | MAX | The content of the submission, if it was submitted directly in a text field, possibly truncated. | |
url |
string | MAX | The URL of the submission (for 'online_url' submissions) | |
attempt |
int | This is the submission attempt number.12 |
||
lti_assignment_id |
string | 36 | The LTI assignment guid of the submission's assignmenta1b2c3c4-z9x8-a1s2-q5w6-p9o8i7u6y5t6 |
|
group_id |
int | The submissions’s group ID if the assignment is a group assignment.120123 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
submission_id |
bigint | The Canvas id of the new submission.120000012300123 |
||
assignment_id |
bigint | The Canvas id of the assignment being submitted.120000001234012 |
||
user_id |
bigint | The Canvas id of the user associated with the submission.120000001234560 |
||
submitted_at |
datetime | The timestamp when the assignment was submitted.2019-11-02T12:00:46.200Z |
||
lti_user_id |
string | 40 | The LTI id of the user associated with the submission. | |
lti_assignment_id |
string | 36 | The LTI assignment guid of the submission's assignment.a1b2c3c4-z9x8-a1s2-q5w6-p9o8i7u6y5t6 |
|
graded_at |
datetime | The timestamp when the assignment was graded, if it was graded.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this assignment was last modified in any way.2019-11-02T12:00:46.200Z |
||
score |
float | 53 | The raw score99.5 |
|
grade |
string | 255 | The grade for the submission, translated into the assignment grading scheme (so a letter grade, for example).S |
|
submission_type |
string | 24 | The types of submissionbasic_lti_launch, discussion_topic, external_tool, media_recording, online_quiz, online_text_entry, online_upload, online_url |
|
body |
string | MAX | The content of the submission, if it was submitted directly in a text field, possibly truncated. | |
url |
string | MAX | The URL of the submission (for 'online_url' submissions) | |
attempt |
int | This is the submission attempt number.12 |
||
group_id |
int | The submissions’s group ID if the assignment is a group assignment.120120 |
Name | Type | Size | mb | Description |
---|---|---|---|---|
course_id |
bigint | The Canvas id of the updated course.120000001234560 |
||
syllabus_body |
string | MAX | The new syllabus content, possibly truncated.html |
|
old_syllabus_body |
string | MAX | The old syllabus content, possibly truncated.html |
Name | Type | Size | mb | Description |
---|---|---|---|---|
user_id |
bigint | The Canvas id of the user for this association.120000001234501 |
||
account_id |
bigint | The Canvas id of the account for this association.120000000120012 |
||
account_uuid |
string | 40 | The unique id of the account for this association.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
created_at |
datetime | The time at which this association was created.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this association was last modified.2019-11-02T12:00:46.200Z |
||
is_admin |
string | 5 | The roles the user has in the account.true |
Name | Type | Size | mb | Description |
---|---|---|---|---|
user_id |
bigint | The Canvas id of user.120000001234501 |
||
uuid |
string | 40 | Unique user id.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
name |
string | 100 | true | Name of user. |
short_name |
string | 32 | true | Short name of user. |
workflow_state |
string | 14 | State of the user.registered |
|
created_at |
datetime | The time at which this user was created.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this user was last modified in any way.2019-11-02T12:00:46.200Z |
||
user_login |
string | 64 | The login of the current user. | |
user_sis_id |
string | 32 | The SIS id of the user. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
user_id |
bigint | The Canvas id of user.101200000000001234 |
||
uuid |
string | 40 | Unique user id.a1b2c3c4z9x8a1s2q5w6p9o8i7u6y5t6a2s3d4f5 |
|
name |
string | 100 | true | Name of user. |
short_name |
string | 64 | true | Short name of user. |
workflow_state |
string | 14 | State of the user.deleted, pre_registered, registered |
|
created_at |
datetime | The time at which this user was created.2019-11-02T12:00:46.200Z |
||
updated_at |
datetime | The time at which this user was last modified in any way.2019-11-02T12:00:46.200Z |
||
user_login |
string | 64 | The login of the current user. | |
user_sis_id |
string | 32 | The SIS id of the user. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
wiki_page_id |
bigint | The Canvas id of the new wiki page.120000001234560 |
||
title |
string | 255 | true | The title of the new page, possibly truncated. |
body |
string | MAX | The body of the new page, possibly truncated.html |
Name | Type | Size | mb | Description |
---|---|---|---|---|
wiki_page_id |
bigint | The Canvas id of the delete wiki page.120000001234567 |
||
title |
string | 255 | true | The title of the deleted wiki page, possibly truncated. |
Name | Type | Size | mb | Description |
---|---|---|---|---|
wiki_page_id |
bigint | The Canvas id of the changed wiki page.120000001234500 |
||
title |
string | 255 | true | The new title, possibly truncated. |
body |
string | MAX | The new page body, possibly truncated.html |
|
old_title |
string | 255 | true | The old title, possibly truncated. |
old_body |
string | MAX | The old page body, possibly truncated.html |
mb column is Multi-byte, emojis, unicode, and foreign language characters.