For the complete documentation index, see llms.txt. This page is also available as Markdown.

Submission Comments

This API can be used to edit and delete submission comments.

Edit a submission comment

SubmissionCommentsApiController#update

PUT /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/:id

Scope: url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/:id

Edit the given submission comment.

Request Parameters:

Parameter
Type
Description

comment

string

If this argument is present, edit the text of a comment.

Returns a SubmissionComment object.

Delete a submission comment

SubmissionCommentsApiController#destroy

DELETE /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/:id

Scope: url:DELETE|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/:id

Delete the given submission comment.

Example Request:

Returns a SubmissionComment object.

Upload a file

SubmissionCommentsApiController#create_file

POST /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/files

Scope: url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/files

Upload a file to attach to a submission comment

See the File Upload Documentation for details on the file upload workflow.

The final step of the file upload workflow will return the attachment data, including the new file id. The caller can then PUT the file_id to the submission API to attach it to a comment

Send annotation notification

SubmissionCommentsApiController#annotation_notification

POST /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/annotation_notification

Scope: url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/annotation_notification

Send notification of annotation to other users of the submission Must have permission to send_messages on Site Admin account. annotation notifications go to all users on the submission and the observers for those users. annotation notifications also go to the instructors unless it is sent from an instructor. annotation notifications from instructors go to students if assignment is set to post automatically or if the assignment is posted.

returns {}, status 200

Request Parameters:

Parameter
Type
Description

author_id

Required string

The user that created the annotation

Example Request:

Last updated

Was this helpful?