ContentMigration¶
-
class
canvasapi.content_migration.
ContentMigration
(requester, attributes)¶ Parameters: - requester (
canvasapi.requester.Requester
) – The requester to pass HTTP requests through. - attributes (dict) – The JSON object to build this object with.
-
get_migration_issue
(migration_issue, **kwargs)¶ List a single issue for this content migration.
Calls: GET /api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues/:id
or GET /api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues/:id
or GET /api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues/:id
or GET /api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues/:id
Parameters: migration_issue (int, str or
canvasapi.content_migration.ContentMigration
) – The object or ID of the issue to retrieve.Return type:
-
get_migration_issues
(**kwargs)¶ List issues for this content migration
-
get_parent
(**kwargs)¶ Return the object that spawned this content migration.
Return type: canvasapi.group.Account
, orcanvasapi.course.Course
, orcanvasapi.course.Group
, orcanvasapi.course.User
-
get_progress
(**kwargs)¶ Get the progress of the current content migration.
Calls: GET /api/v1/progress/:id Return type: canvasapi.progress.Progress
-
get_selective_data
(**kwargs)¶ Return the selective data associated with this content migration. Use this to get a list of available objects to import for a migration created with ‘waiting_for_select=True’.
Calls: GET /api/v1/accounts/:account_id/content_migrations/:content_migration_id/selective_data
or GET /api/v1/courses/:course_id/content_migrations/:content_migration_id/selective_data
or GET /api/v1/groups/:group_id/content_migrations/:content_migration_id/selective_data
or GET /api/v1/users/:user_id/content_migrations/:content_migration_id/selective_data
Returns: Paginated List of of nodes available for selection in this migration
Return type:
-
update
(**kwargs)¶ Update an existing content migration.
Calls: PUT /api/v1/accounts/:account_id/content_migrations/:id
or PUT /api/v1/courses/:course_id/content_migrations/:id
Returns: True if the migration was updated, False otherwise.
Return type: bool
- requester (
ContentMigrationSelectionNode¶
-
class
canvasapi.content_migration.
ContentMigrationSelectionNode
(requester, attributes)¶ Parameters: - requester (
canvasapi.requester.Requester
) – The requester to pass HTTP requests through. - attributes (dict) – The JSON object to build this object with.
- requester (
MigrationIssue¶
-
class
canvasapi.content_migration.
MigrationIssue
(requester, attributes)¶ Parameters: - requester (
canvasapi.requester.Requester
) – The requester to pass HTTP requests through. - attributes (dict) – The JSON object to build this object with.
-
update
(**kwargs)¶ Update an existing migration issue.
Calls: PUT /api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues/:id or PUT /api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues/:id or PUT /api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues/:id or PUT /api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues/:id Returns: True if the issue was updated, False otherwise. Return type: bool
- requester (
Migrator¶
-
class
canvasapi.content_migration.
Migrator
(requester, attributes)¶ Parameters: - requester (
canvasapi.requester.Requester
) – The requester to pass HTTP requests through. - attributes (dict) – The JSON object to build this object with.
- requester (