Skip to main content
Module

x/gesso/types/params.ts>CreateContentMigrationParams

A TypeScript API client for Canvas LMS
Latest
interface CreateContentMigrationParams
import { type CreateContentMigrationParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";

Properties

optional
migrationtype: string

The type of the migration. Use the Migrator endpoint to see all available migrators. Default allowed values: canvas_cartridge_importer, common_cartridge_importer, course_copy_importer, zip_file_importer, qti_converter, moodle_converter

optional
preattachmentname: string

Required if uploading a file. This is the first step in uploading a file to the content migration. See the File Upload Documentation for details on the file upload workflow.

optional
preattachment: string

Other file upload properties, See File Upload Documentation

optional
settingsfileurl: string

A URL to download the file from. Must not require authentication.

optional
settingscontentexportid: string

The id of a ContentExport to import. This allows you to import content previously exported from Canvas without needing to download and re-upload it.

optional
settingssourcecourseid: string

The course to copy from for a course copy migration. (required if doing course copy)

optional
settingsfolderid: string

The folder to unzip the .zip file into for a zip_file_import.

optional
settingsoverwritequizzes: boolean

Whether to overwrite quizzes with the same identifiers between content packages.

optional
settingsquestionbankid: number

The existing question bank ID to import questions into if not specified in the content package.

optional
settingsquestionbankname: string

The question bank to import questions into if not specified in the content package, if both bank id and name are set, id will take precedence.

optional
settingsinsertintomoduleid: number

The id of a module in the target course. This will add all imported items (that can be added to a module) to the given module.

optional
settingsinsertintomoduletype: string

Allowed values: assignment, discussion_topic, file, page, quiz

optional
settingsinsertintomoduleposition: number

The (1-based) position to insert the imported items into the course (if insert_into_module_id is supplied). If this parameter is omitted, items will be added to the end of the module.

optional
settingsmovetoassignmentgroupid: number

The id of an assignment group in the target course. If provided, all imported assignments will be moved to the given assignment group.

optional
settingsimporterskips: unknown[]

Allowed values: all_course_settings, visibility_settings

optional
dateshiftoptionsshiftdates: boolean

Whether to shift dates in the copied course

optional
dateshiftoptionsoldstartdate: Date

The original start date of the source content/course

optional
dateshiftoptionsoldenddate: Date

The original end date of the source content/course

optional
dateshiftoptionsnewstartdate: Date

The new start date for the content/course

optional
dateshiftoptionsnewenddate: Date

The new end date for the source content/course

optional
dateshiftoptionsdaysubstitutionsX: number

Move anything scheduled for day 'X' to the specified day. (0-Sunday, 1-Monday, 2-Tuesday, 3-Wednesday, 4-Thursday, 5-Friday, 6-Saturday)

optional
dateshiftoptionsremovedates: boolean

Whether to remove dates in the copied course. Cannot be used in conjunction with shift_dates.

optional
selectiveimport: boolean

If set, perform a selective import instead of importing all content. The migration will identify the contents of the package and then stop in the waiting_for_select workflow state. At this point, use the List items endpoint to enumerate the contents of the package, identifying the copy parameters for the desired content. Then call the Update endpoint and provide these copy parameters to start the import.

optional
select: unknown

Allowed values: folders, files, attachments, quizzes, assignments, announcements, calendar_events, discussion_topics, modules, module_items, pages, rubrics