CustomGradebookColumn

class canvasapi.custom_gradebook_columns.CustomGradebookColumn(requester, attributes)

Parameters:

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

delete(**kwargs)

Permanently delete a custom column.

Calls:: DELETE /api/v1/courses/:course_id/custom_gradebook_columns/:id
Return type:: canvasapi.custom_gradebook_columns.CustomGradebookColumn

get_column_entries(**kwargs)

Returns a list of ColumnData objects.

Calls:: GET /api/v1/courses/:course_id/custom_gradebook_columns/:id/data
Return type:: canvasapi.paginated_list.PaginatedList of canvasapi.custom_gradebook_columns.ColumnData

reorder_custom_columns(order, **kwargs)

Put the given columns in a specific order based on given parameter.

Calls:: POST /api/v1/courses/:course_id/custom_gradebook_columns/reorder
Parameters:: order (list of int) – The order the columns are supposed to be in.
Returns:: True if successful (status code of 200)
Return type:: bool

update_custom_column(**kwargs)

Update a CustomColumn object.

Calls:: PUT /api/v1/courses/:course_id/custom_gradebook_columns/:id
Return type:: canvasapi.custom_gradebook_columns.CustomGradebookColumn

ColumnData

class canvasapi.custom_gradebook_columns.ColumnData(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_column_data(column_data, **kwargs)

Sets the content of a custom column.

Calls:: PUT /api/v1/courses/:course_id/custom_gradebook_columns/:id/data/:user_id
Parameters:: column_data (str) – The content in the column.
Return type:: canvasapi.custom_gradebook_columns.ColumnData