Files
A File object looks like:
{
"id": 569,
"folder_id": 4207,
"display_name": "file.txt",
"filename": "file.txt",
"content-type": "text/plain",
"url": "http://www.example.com/files/569/download?download_frd=1",
// file size in bytes
"size": 43451,
"created_at": "2012-07-06T14:58:50Z",
"updated_at": "2012-07-06T14:58:50Z",
"unlock_at": "2012-07-07T14:58:50Z",
"locked": false,
"hidden": false,
"lock_at": "2012-07-20T14:58:50Z",
"hidden_for_user": false,
// Changes who can access the file. Valid options are 'inherit' (the default),
// 'course', 'institution', and 'public'. Only valid in course endpoints.
"visibility_level": "course",
"thumbnail_url": null,
"modified_at": "2012-07-06T14:58:50Z",
// simplified content-type mapping
"mime_class": "html",
// identifier for file in third-party transcoding service
"media_entry_id": "m-3z31gfpPf129dD3sSDF85SwSDFnwe",
"locked_for_user": false,
"lock_info": null,
"lock_explanation": "This assignment is locked until September 1 at 12:00am",
// optional: url to the document preview. This url is specific to the user
// making the api call. Only included in submission endpoints.
"preview_url": null
}A Folder object looks like:
An UsageRights object looks like:
A License object looks like:
Get quota information
GET /api/v1/courses/:course_id/files/quota
GET /api/v1/groups/:group_id/files/quota
GET /api/v1/users/:user_id/files/quota
Example Request:
Example Response:
List files
GET /api/v1/courses/:course_id/files
GET /api/v1/users/:user_id/files
GET /api/v1/groups/:group_id/files
GET /api/v1/folders/:id/files
Request Parameters:
Parameter
Type
Description
Example Request:
Get public inline preview url
GET /api/v1/files/:id/public_url
Request Parameters:
Parameter
Type
Description
Example Request:
Example Response:
Get file
GET /api/v1/files/:id
POST /api/v1/files/:id
GET /api/v1/courses/:course_id/files/:id
GET /api/v1/groups/:group_id/files/:id
GET /api/v1/users/:user_id/files/:id
Request Parameters:
Parameter
Type
Description
Example Request:
Translate file reference
GET /api/v1/courses/:course_id/files/file_ref/:migration_id
Example Request:
Download file
GET /accounts/:account_id/files/:file_id/download
GET /assessment_questions/:assessment_question_id/files/:file_id/download
GET /assignments/:assignment_id/files/:id/download
GET /courses/:course_id/files/:file_id/download
GET /files/:file_id/download
GET /groups/:group_id/files/:file_id/download
GET /quiz_statistics/:quiz_statistics_id/files/:file_id/download
GET /quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download
GET /users/:user_id/files/:file_id/download
Example Request:
Update file
PUT /api/v1/files/:id
Request Parameters:
Parameter
Type
Description
Example Request:
Delete file
DELETE /api/v1/files/:id
Request Parameters:
Parameter
Type
Description
Example Request:
Get icon metadata
GET /api/v1/files/:id/icon_metadata
Example Request:
Example Response:
Reset link verifier
POST /api/v1/files/:id/reset_verifier
Example Request:
Update word count
POST /api/v1/files/update_word_count
Request Parameters:
Parameter
Type
Description
Example Request:
List folders
GET /api/v1/folders/:id/folders
Example Request:
List all folders
GET /api/v1/courses/:course_id/folders
GET /api/v1/users/:user_id/folders
GET /api/v1/groups/:group_id/folders
Example Request:
Resolve path
GET /api/v1/courses/:course_id/folders/by_path/*full_path
GET /api/v1/courses/:course_id/folders/by_path
GET /api/v1/users/:user_id/folders/by_path/*full_path
GET /api/v1/users/:user_id/folders/by_path
GET /api/v1/groups/:group_id/folders/by_path/*full_path
GET /api/v1/groups/:group_id/folders/by_path
Example Request:
Get folder
GET /api/v1/courses/:course_id/folders/:id
GET /api/v1/users/:user_id/folders/:id
GET /api/v1/groups/:group_id/folders/:id
GET /api/v1/folders/:id
Example Request:
Update folder
PUT /api/v1/folders/:id
Request Parameters:
Parameter
Type
Description
Example Request:
Create folder
POST /api/v1/courses/:course_id/folders
POST /api/v1/users/:user_id/folders
POST /api/v1/groups/:group_id/folders
POST /api/v1/folders/:folder_id/folders
POST /api/v1/accounts/:account_id/folders
Request Parameters:
Parameter
Type
Description
Example Request:
Delete folder
DELETE /api/v1/folders/:id
Request Parameters:
Parameter
Type
Description
Example Request:
Upload a file
POST /api/v1/folders/:folder_id/files
Copy a file
POST /api/v1/folders/:dest_folder_id/copy_file
Request Parameters:
Parameter
Type
Description
Example Request:
Copy a folder
POST /api/v1/folders/:dest_folder_id/copy_folder
Request Parameters:
Parameter
Type
Description
Example Request:
Get uploaded media folder for user
GET /api/v1/courses/:course_id/folders/media
GET /api/v1/groups/:group_id/folders/media
Example Request:
Set usage rights
PUT /api/v1/courses/:course_id/usage_rights
PUT /api/v1/groups/:group_id/usage_rights
PUT /api/v1/users/:user_id/usage_rights
Request Parameters:
Parameter
Type
Description
Remove usage rights
DELETE /api/v1/courses/:course_id/usage_rights
DELETE /api/v1/groups/:group_id/usage_rights
DELETE /api/v1/users/:user_id/usage_rights
Request Parameters:
Parameter
Type
Description
List licenses
GET /api/v1/courses/:course_id/content_licenses
GET /api/v1/groups/:group_id/content_licenses
GET /api/v1/users/:user_id/content_licenses
Last updated
Was this helpful?