Outcome

class canvasapi.outcome.Outcome(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)

Modify an existing outcome.

Calls:: PUT /api/v1/outcomes/:id
Returns:: True if updated, False otherwise.
Return type:: bool

OutcomeLink

class canvasapi.outcome.OutcomeLink(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_outcome(**kwargs)

Return the linked outcome

Calls:: GET /api/v1/outcomes/:id
Returns:: Outcome object that was in the OutcomeLink
Return type:: canvasapi.outcome.Outcome

get_outcome_group(**kwargs)

Return the linked outcome group

Calls:: GET /api/v1/global/outcome_groups/:id or GET /api/v1/accounts/:account_id/outcome_groups/:id or GET /api/v1/courses/:course_id/outcome_groups/:id
Returns:: Linked outcome group object.
Return type:: canvasapi.outcome.OutcomeGroup

OutcomeGroup

class canvasapi.outcome.OutcomeGroup(requester, attributes)

Parameters:

requester (canvasapi.requester.Requester) – The requester to pass HTTP requests through.
attributes (dict) – The JSON object to build this object with.

create_subgroup(title, **kwargs)

Create a subgroup of the current group

Calls:: POST /api/v1/global/outcome_groups/:id/subgroups or POST /api/v1/accounts/:account_id/outcome_groups/:id/subgroups or POST /api/v1/courses/:course_id/outcome_groups/:id/subgroups
Parameters:: title (str) – The title of the subgroup.
Returns:: Itself as an OutcomeGroup object.
Return type:: canvasapi.outcome.OutcomeGroup

delete(**kwargs)

Delete an outcome group.

Calls:: DELETE /api/v1/global/outcome_groups/:id or DELETE /api/v1/accounts/:account_id/outcome_groups/:id or DELETE /api/v1/courses/:course_id/outcome_groups/:id
Returns:: True if successful, false if failed.
Return type:: bool

get_linked_outcomes(**kwargs)

List linked outcomes.

Calls:: GET /api/v1/global/outcome_groups/:id/outcomes or GET /api/v1/accounts/:account_id/outcome_groups/:id/outcomes or GET /api/v1/courses/:course_id/outcome_groups/:id/outcomes
Returns:: Paginated List of Outcomes linked to the group.
Return type:: canvasapi.paginated_list.PaginatedList of canvasapi.outcome.OutcomeLink

get_subgroups(**kwargs)

List subgroups.

Calls:: GET /api/v1/global/outcome_groups/:id/subgroups or GET /api/v1/accounts/:account_id/outcome_groups/:id/subgroups or GET /api/v1/courses/:course_id/outcome_groups/:id/subgroups
Returns:: Paginated List of OutcomeGroups linked to the current group.
Return type:: canvasapi.paginated_list.PaginatedList of canvasapi.outcome.OutcomeGroup

import_outcome_group(outcome_group, **kwargs)

Import an outcome group as a subgroup into the current outcome group

Calls:: POST /api/v1/global/outcome_groups/:id/import or POST /api/v1/accounts/:account_id/outcome_groups/:id/import or POST /api/v1/courses/:course_id/outcome_groups/:id/import
Parameters:: outcome (canvasapi.outcome.OutcomeGroup or int) – The object or ID of the outcome group to import.
Returns:: Itself as an OutcomeGroup object.
Return type:: canvasapi.outcome.OutcomeGroup

link_existing(outcome, **kwargs)

Link to an existing Outcome.

Calls:: PUT /api/v1/global/outcome_groups/:id/outcomes/:outcome_id or PUT /api/v1/accounts/:account_id/outcome_groups/:id/outcomes/:outcome_id or PUT /api/v1/courses/:course_id/outcome_groups/:id/outcomes/:outcome_id
Parameters:: outcome (canvasapi.outcome.Outcome or int) – The object or ID of the outcome.
Returns:: OutcomeLink object with current OutcomeGroup and newly linked Outcome.
Return type:: canvasapi.outcome.OutcomeLink

link_new(title, **kwargs)

Create a new Outcome and link it to this OutcomeGroup

Calls:: POST /api/v1/global/outcome_groups/:id/outcomes or POST /api/v1/accounts/:account_id/outcome_groups/:id/outcomes or POST /api/v1/courses/:course_id/outcome_groups/:id/outcomes
Parameters:: title (str) – The title of the new outcome.
Returns:: OutcomeLink object with current OutcomeGroup and newly linked Outcome.
Return type:: canvasapi.outcome.OutcomeLink

unlink_outcome(outcome, **kwargs)

Remove an Outcome from and OutcomeLink

Calls:: DELETE /api/v1/global/outcome_groups/:id/outcomes/:outcome_id or DELETE /api/v1/accounts/:account_id/outcome_groups/:id/outcomes/:outcome_id or DELETE /api/v1/courses/:course_id/outcome_groups/:id/outcomes/:outcome_id
Parameters:: outcome (canvasapi.outcome.Outcome or int) – The object or ID of the outcome.
Returns:: True if successful, false if failed.
Return type:: bool

update(**kwargs)

Update an outcome group.

Calls:: PUT /api/v1/global/outcome_groups/:id or PUT /api/v1/accounts/:account_id/outcome_groups/:id or PUT /api/v1/courses/:course_id/outcome_groups/:id
Returns:: True if updated, False otherwise.
Return type:: bool

OutcomeResult

class canvasapi.outcome.OutcomeResult(requester, attributes)

Parameters:

requester (canvasapi.requester.Requester) – The requester to pass HTTP requests through.
attributes (dict) – The JSON object to build this object with.