Downloading Submission File Attachment

I'm trying to download the actual file the students upload via the API. I have a list of all the submissions I want to download using the URL

urlAPI_root = url_root+'/api/v1/courses/' + str(assignment.crsID) + '/assignments/' + str(assignment.id) + '/submissions/'+str(submission['user_id'])

I receive the information I need to know about the grade, time submitted and such. However, it informs me that the submission_type is online_upload but I cannot access the file that was uploaded. Any ideas?

Find more posts tagged with

Accepted answers

garth

@wade_ashby you can get a list of all submissions for an assignment using this API call:

Submissions - List Assignment Submissions

This API call will return a json list of submission objects:

Submissions - Submission Object

Here's an example of the syntax:

http://mysite.instructure.com/api/v1/courses/1234/assignments/1234/submissions

Within each submission object that contains an uploaded document, you will see an "attachments" object.

One of the parameters of the "attatchment" is: "url"

This is the URL for the document attached to the submission.

You are able to download the file from this URL.

Here is an example of one of the submission objects that is returned from a test course that I work with, I have highlighted the URL variable in bold text:

{

"id": 546,

"body": null,

"url": null,

"grade": "21",

"score": 21,

"submitted_at": "2015-07-23T16:12:22Z",

"assignment_id": 1234,

"user_id": 1234,

"submission_type": "online_upload",

"workflow_state": "graded",

"grade_matches_current_submission": true,

"graded_at": "2015-11-12T20:22:50Z",

"grader_id": 1234,

"attempt": 1,

"excused": null,

"late": false,

"preview_url": "https://mysite.instructure.com/courses/1234/assignments/1234/submissions/1234?preview=1&version=1",

"attachments": [

{

"id": 5029,

"folder_id": 1234,

"display_name": "mysampledoc.docx",

"filename": "mysampledoc.docx",

"content-type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",

"url": "https://mysite.instructure.com/files/1234/download?download_frd=1&verifier=a0r8I2lbKdd3ORdvaRLCVIPtPin2ZRRQQlMq1Ik0",

"size": 15081,

"created_at": "2015-07-23T16:12:21Z",

"updated_at": "2015-07-23T16:12:23Z",

"unlock_at": null,

"locked": false,

"hidden": false,

"lock_at": null,

"hidden_for_user": false,

"thumbnail_url": null,

"modified_at": "2015-07-23T16:12:21Z",

"locked_for_user": false,

"preview_url": "/api/v1/canvadoc_session?blob=%7B%22user_id%22:61240000000000033,%22attachment_id%22:5029,%22type%22:%22canvadoc%22%7D&hmac=0b1bcf1a12345fdaec654321d1e48c0bfc6b1167"

}

]

}

I hope this helps.

All comments

garth

@wade_ashby you can get a list of all submissions for an assignment using this API call:

Submissions - List Assignment Submissions

This API call will return a json list of submission objects:

Submissions - Submission Object

Here's an example of the syntax:

http://mysite.instructure.com/api/v1/courses/1234/assignments/1234/submissions

Within each submission object that contains an uploaded document, you will see an "attachments" object.

One of the parameters of the "attatchment" is: "url"

This is the URL for the document attached to the submission.

You are able to download the file from this URL.

Here is an example of one of the submission objects that is returned from a test course that I work with, I have highlighted the URL variable in bold text:

{

"id": 546,

"body": null,

"url": null,

"grade": "21",

"score": 21,

"submitted_at": "2015-07-23T16:12:22Z",

"assignment_id": 1234,

"user_id": 1234,

"submission_type": "online_upload",

"workflow_state": "graded",

"grade_matches_current_submission": true,

"graded_at": "2015-11-12T20:22:50Z",

"grader_id": 1234,

"attempt": 1,

"excused": null,

"late": false,

"preview_url": "https://mysite.instructure.com/courses/1234/assignments/1234/submissions/1234?preview=1&version=1",

"attachments": [

{

"id": 5029,

"folder_id": 1234,

"display_name": "mysampledoc.docx",

"filename": "mysampledoc.docx",

"content-type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",

"url": "https://mysite.instructure.com/files/1234/download?download_frd=1&verifier=a0r8I2lbKdd3ORdvaRLCVIPtPin2ZRRQQlMq1Ik0",

"size": 15081,

"created_at": "2015-07-23T16:12:21Z",

"updated_at": "2015-07-23T16:12:23Z",

"unlock_at": null,

"locked": false,

"hidden": false,

"lock_at": null,

"hidden_for_user": false,

"thumbnail_url": null,

"modified_at": "2015-07-23T16:12:21Z",

"locked_for_user": false,

"preview_url": "/api/v1/canvadoc_session?blob=%7B%22user_id%22:61240000000000033,%22attachment_id%22:5029,%22type%22:%22canvadoc%22%7D&hmac=0b1bcf1a12345fdaec654321d1e48c0bfc6b1167"

}

]

}

I hope this helps.

wade_ashby

Thank you! I had a colleague who helped me and he confirmed what you said. My problem was I had https://canvas.instructure.com as the url root and not http://mysite.instructure.com.

mlewis23

This is an old post and it looks like the submission endpoint has changed in the last 10 years. I'm not seeing attachments as an available item for submissions, does anyone know where to find the submission url in order to download the submitted file?

mlewis23

From the assignment endpoint I do see a link for 'submissions_download_url' to bulk download all the files. Is this the best available these days?

Unanswered Questions

Messaging Changes--- Suggestions for more streamlining
Hello, I was thinking of this a while ago and have been trying to message Canvas support about this but they suggested here but not which category. I apologize if this is the wrong spot. When messaging students right now we need to message one by one. I would like to know if there is a way we can change that to streamline…
Finding the LTIv1.3 IDs for Members of a Course
I'm building a tool for my institution that imports grades from another LTI tool into Canvas so instructors can automate late assignment policies not otherwise supported by Canvas. I'm trying to use the LTIv1.3 ID which is readily available on the LTI-side as a link to the student record on Canvas, but I can't find the ID…
Canvas Media Question
How can one track Canvas Media use without having the reports available from Canvas Studio? Checking API endpoints and the Data 2 schema, there do not seem to be dedicated Canvas Media endpoints. Am I missing some? A method I've considered is using the body field of the wiki_pages table, as this contains the html code of…
Canvas Catalog API - Completed Certificates
Hello, I'm trying to utilize an API call to pull completed certificates and was hoping to download and store the certs as a backup. I can successfully run the API call but it will not allow me to view the certificate unless I access the URL while signed into an account where it's "my" cert. Is there a permissions setting…
UI for weekly progression idea
UI for weekly progression idea that rest in the Schedule tab of the **K-12 UI** of Canvas it's incomplete and I really would not take it and push it into instance but I am going to post it here because in the past people like @James && @robotcars || @Steve_25 have had terrific input in the past... maybe w/their eyes and…