Content Exports API

BETA: This API resource is not finalized, and there could be breaking changes before its final release.

API for exporting courses and course content

A ContentExport object looks like:

{
  
  //the unique identifier for the export
  "id": 101,
  
  //the date and time this export was requested
  "created_at": "2014-01-01T00:00:00Z",
  
  //the type of content migration: 'common_cartridge' or 'qti'
  "export_type": "common_cartridge",
  
  //attachment api object for the export package (not present until the export
  //completes)
  "attachment": "{"url"=>"https://example.com/api/v1/attachments/789?download_frd=1&verifier=bG9sY2F0cyEh"}",
  
  //The api endpoint for polling the current progress
  "progress_url": "https://example.com/api/v1/progress/4",
  
  //The ID of the user who started the export
  "user_id": 4,
  
  //Current state of the content migration: created exporting exported failed
  "workflow_state": "exported"
}

List content exports ContentExportsApiController#index

BETA: This API endpoint is not finalized, and there could be breaking changes before its final release.

GET /api/v1/courses/:course_id/content_exports

GET /api/v1/groups/:group_id/content_exports

GET /api/v1/users/:user_id/content_exports

List the past and pending content export jobs for a course, group, or user. Exports are returned newest first.

Returns a list of ContentExports

Show content export ContentExportsApiController#show

BETA: This API endpoint is not finalized, and there could be breaking changes before its final release.

GET /api/v1/courses/:course_id/content_exports/:id

GET /api/v1/groups/:group_id/content_exports/:id

GET /api/v1/users/:user_id/content_exports/:id

Get information about a single content export.

Returns a ContentExport

Export content ContentExportsApiController#create

BETA: This API endpoint is not finalized, and there could be breaking changes before its final release.

POST /api/v1/courses/:course_id/content_exports

POST /api/v1/groups/:group_id/content_exports

POST /api/v1/users/:user_id/content_exports

Begin a content export job for a course, group, or user.

You can use the Progress API to track the progress of the export. The migration's progress is linked to with the progress_url value.

When the export completes, use the Show content export endpoint to retrieve a download URL for the exported content.

Request Parameters:

  • export_type
    Required, String, “common_cartridge”|“qti”|“zip”
    “common_cartridge”

    Export the contents of the course in the Common Cartridge (.imscc) format

    “qti”

    Export quizzes from a course in the QTI format

    “zip”

    Export files from a course, group, or user in a zip file

  • skip_notifications
    Optional, Boolean

    Don’t send the notifications about the export to the user. Default: false

Returns a ContentExport