Skip to main content
Server path: /blackboard-grades | Type: Application | PCID required: Yes

Tools

ToolDescription
blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileidDelete Attachment
blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_columns_by_columnidDelete Grade Column
blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationidDelete Grade Notation
blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_periods_by_periodidDelete Grading Period
blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaidDelete Grade Schema
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_filesGet Attempt File Meta Data List
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileidGet Attempt File Meta Data
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid_downloadDownload
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_categoriesGet Gradebook Categories
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_categories_by_categoryidGet Gradebook Category
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columnsGet Grade Columns
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnidGet Grade Column
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attemptsGet Column Attempts
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts_by_attemptidGet Column Attempt
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_usersGet Column Grades
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_by_useridGet Column Grade
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_lastchangedGet Column Grade Last Changed
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_gradenotationsGet Grade Notations
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationidGet Grade Notation
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_periodsGet Grading Periods
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_periods_by_periodidGet Grading Period
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_schemasGet Grade Schemas
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaidGet Grade Schema
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_users_by_useridGet User Grades
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnidUpdate Grade Column
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts_by_attemptidUpdate Column Attempt
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_by_useridUpdate Column Grade
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationidUpdate Grade Notation
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_periods_by_periodidUpdate Grading Period
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaidUpdate Grade Schema
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_filesAttach File
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_columnsCreate Grade Column
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attemptsCreate Column Attempt
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_gradenotationsCreate Grade Notation
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_periodsCreate Grading Period
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_schemasCreate Grade Schema

blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid

Delete Attachment Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
attemptIdstringYesAttempt Id
attemptFileIdstringYesAttempt File Id

blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid

Delete Grade Column Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
columnIdstringYesThe grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword ‘finalGrade’, which indicates that the course’s final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |
onlyIfEmptybooleanNoOnly If Empty

blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid

Delete Grade Notation Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
gradeNotationIdstringYesGrade Notation Id

blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid

Delete Grading Period Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
periodIdstringYesPeriod Id

blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid

Delete Grade Schema Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
schemaIdstringYesThe grade schema ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:schema1 |

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files

Get Attempt File Meta Data List Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
attemptIdstringYesAttempt Id
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid

Get Attempt File Meta Data Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
attemptIdstringYesAttempt Id
attemptFileIdstringYesAttempt File Id

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid_download

Download Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
attemptIdstringYesAttempt Id
attemptFileIdstringYesAttempt File Id

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_categories

Get Gradebook Categories Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_categories_by_categoryid

Get Gradebook Category Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
categoryIdstringYesthe ID of the category to return
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns

Get Grade Columns Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
contentIdstringNoSearch for grade columns associated with this content item. Since: 3000.11.0
displayNamestringNoThe ‘displayName’ value to use as search criteria. Currently only supports ‘contains’ searches. Since: 3300.2.0
namestringNoThe ‘name’ value to use as search criteria. Currently only supports ‘contains’ searches. Since: 3900.11.0
gradebookCategoryIdstring[]NoSearch for grade columns associated with the ‘gradebookCategoryId’. comma-delimited list of the gradebook category ids. Since: 3900.11.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid

Get Grade Column Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
columnIdstringYesThe grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword ‘finalGrade’, which indicates that the course’s final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts

Get Column Attempts Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
columnIdstringYesThe grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword ‘finalGrade’, which indicates that the course’s final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
userIdstringNoSearch for grade column attempts submitted by this user. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 | Since: 3100.4.0
attemptStatusesstringNoSearch for grade column attempts with one of these statuses. Since: 3100.4.0 | Type | Description | --------- | --------- | | NotAttempted | none of the students in a group has submitted an attempt; applies only to group assessments | | Abandoned | Deprecated: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | InProgress | attempt activity has commenced, but has not been submitted for grading | | Suspended | Deprecated: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | Canceled | Deprecated: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | NeedsGrading | attempt has been submitted for grading, but has not been fully graded | | Completed | a grade has been entered for the attempt | | InProgressAgain | attempt has been graded, but more student activity occurred after the grade was entered; applies only to collaborative tools such as discussions | | NeedsGradingAgain | additional student activity occurring after a grade was entered requires that the attempt be regraded; applies only to collaborative tools such as discussions |
createdstringNoSearch for attempts with created date relative to this value. ‘createdCompare’ may also be sent to control search behavior. Since: 3800.0.0
createdComparestringNoUsed alongside the ‘created’ search parameter. Defaults to greaterOrEqual if not specified. Since: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |
modifiedstringNoSearch for attempts with modified date relative to this value. ‘modifiedCompare’ may also be sent to control search behavior. Since: 3800.0.0
modifiedComparestringNoUsed alongside the ‘modified’ search parameter. Defaults to greaterOrEqual if not specified. Since: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |
attemptDatestringNoSearch for attempts with attempt date relative to this value. ‘attemptDateCompare’ may also be sent to control search behavior. Since: 3800.0.0
attemptDateComparestringNoUsed alongside the ‘attemptDate’ search parameter. Defaults to greaterOrEqual if not specified. Since: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts_by_attemptid

Get Column Attempt Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
columnIdstringYesThe grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword ‘finalGrade’, which indicates that the course’s final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |
attemptIdstringYesAttempt Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users

Get Column Grades Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
columnIdstringYesThe grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword ‘finalGrade’, which indicates that the course’s final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
changeIndexintegerNoRetrieve only items modified after the given change index. Since: 3300.4.0
includeUnpostedGradesbooleanNoIf true, calculated columns exposed in the response will be processed such that any unposted grades are included in their calculations. If false, only posted grades will be included in calculations. Entitlements course.gradebook-grades.VIEW, course.gradebook.MODIFY and course.gradebook-grades.EXECUTE are required to use this parameter. Since: 3800.4.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_by_userid

Get Column Grade Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
columnIdstringYesThe grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword ‘finalGrade’, which indicates that the course’s final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |
userIdstringYesThe user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_lastchanged

Get Column Grade Last Changed Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
columnIdstringYesThe grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword ‘finalGrade’, which indicates that the course’s final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_gradenotations

Get Grade Notations Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid

Get Grade Notation Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
gradeNotationIdstringYesGrade Notation Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_periods

Get Grading Periods Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
sortstringNoProperties to sort by. This is a comma-delimited list of JSON properties, with an optional “(desc)” or “(asc)” suffix to request an ascending or descending sort for that property. e.g. “title(desc),description” Supported fields are: - id - title - position - dateMode - description Since: 3300.2.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid

Get Grading Period Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
periodIdstringYesPeriod Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_schemas

Get Grade Schemas Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid

Get Grade Schema Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
schemaIdstringYesThe grade schema ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:schema1 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_users_by_userid

Get User Grades Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
userIdstringYesThe user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid

Update Grade Column Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
columnIdstringYesThe grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword ‘finalGrade’, which indicates that the course’s final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
availabilityobjectNoSettings controlling the availability/visibility of grade column data.
descriptionstringNoThe description of the grade column.
displayNamestringNoThe display name of the grade column. Only applicable for Classic courses. Ultra courses will simply use the name field. Since: 3300.2.0
externalGradebooleanNoWhether this grade column is an external grade column.
externalIdstringNoThe externalId for this grade column
externalToolIdstringNoThe externalId for this grade column Since: 3500.2.0
gradebookCategoryIdstringNoThe gradebook category ID for the grade column. Since: 3400.2.0
gradingobjectNoSettings controlling whether numerical and text grade values for this grade column are calculated, determined based on attempts, or manually entered.
includeInCalculationsbooleanNoIndicates whether or not this column is included in gradebook calculations. Cannot be set for Ultra courses. Default: true Since: 3800.4.0
namestringNoThe name of the grade column.
scoreobjectNoSettings controlling the numerical scoring of this grade column.
showStatisticsToStudentsbooleanNoIndicates whether or not column statistics are shown to students. Read-only for Ultra courses. Default: false Since: 3800.4.0

blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts_by_attemptid

Update Column Attempt Parameters:
ParameterTypeRequiredDefaultDescription
columnIdstringYesColumn Id
attemptIdstringYesAttempt Id
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
attemptReceiptobjectNoAttempt Receipt
exemptbooleanNoWhether the score associated with this attempt is ignored when computing the user’s grade for the associated grade column.
feedbackstringNoThe instructor feedback associated with this attempt.
notesstringNoThe instructor notes associated with this attempt.
reconciliationModestringNoThe reconciliation mode to use when reconciling the attempt grade. When modifying reconciliationMode, score is also required. A new score will not be calculated based on the reconciliationMode Since: 3700.2.0 | Type | Description | --------- | --------- | | Average | | | Highest | | | Lowest | | | Custom | |
scorenumberNoThe score associated with this attempt.
statusstringNoThe status of this attempt. | Type | Description | --------- | --------- | | NotAttempted | none of the students in a group has submitted an attempt; applies only to group assessments | | Abandoned | Deprecated: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | InProgress | attempt activity has commenced, but has not been submitted for grading | | Suspended | Deprecated: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | Canceled | Deprecated: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | NeedsGrading | attempt has been submitted for grading, but has not been fully graded | | Completed | a grade has been entered for the attempt | | InProgressAgain | attempt has been graded, but more student activity occurred after the grade was entered; applies only to collaborative tools such as discussions | | NeedsGradingAgain | additional student activity occurring after a grade was entered requires that the attempt be regraded; applies only to collaborative tools such as discussions |
studentCommentsstringNoThe student comments associated with this attempt.
studentSubmissionstringNoThe student submission text associated with this attempt.
textstringNoThe text grade associated with this attempt.

blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_by_userid

Update Column Grade Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
columnIdstringYesThe grade column ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. The ID may also be the keyword ‘finalGrade’, which indicates that the course’s final grade column is specified. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:column1 | | finalGrade | finalGrade |
userIdstringYesThe user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
exemptbooleanNoWhether the score associated with this grade is ignored when computing the course grade.
feedbackstringNoThe instructor feedback associated with this grade. This feedback is used for grades on manual grade columns. That is, when column.grading.type = Manual. It is also used when column.grading.type = Attempts and the grade has been manually overridden.
gradeNotationIdstringNoThe Id of a Grade Notation which can be optionally associated with this Grade. If a Grade Notation is specified for this Grade, then the DisplayGrade’s Text attribute will contain the Grade Notation’s Description.
notesstringNoThe instructor notes associated with this grade. This notes field is used for grades on manual grade columns. That is, when column.grading.type = Manual. It is also used when column.grading.type = Attempts and the grade has been manually overridden.
scorenumberNoThe overridden score of this grade. This field is only used for overriding the grade
textstringNoThe overridden text representation of this grade. This field is only used for overriding the grade via text value

blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid

Update Grade Notation Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
gradeNotationIdstringYesGrade Notation Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
codestringNoThe performance code associated with the grade notation.
descriptionstringNoThe description of the grade notation.

blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid

Update Grading Period Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
periodIdstringYesPeriod Id
associatebooleanNoThe associate value
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
dateModestringNoProperty may be set to DoNotUseDates to explicitly blank dates, in which case startDate and endDate are ignored; otherwise set to UseDates; in this case startDate and endDate must be included and valid. | Type | Description | --------- | --------- | | DoNotUseDates | Do not use dates | | UseDates | Use dates |
descriptionstringNoThe description of the grading period. Length is limited to 1000 characters.
endstringNoIf start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. End dates will be persisted as ending at 23:59:59 on the submitted day.
positionintegerNoThe relative position of the grading period to other grading periods when viewed in the grade book.
startstringNoIf start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. Start dates will be persisted as starting at 00:00:00 on the submitted day.
titlestringNoThe title of the grading period. Length is limited to 64 characters.

blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid

Update Grade Schema Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
schemaIdstringYesThe grade schema ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:schema1 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
descriptionstringNoThe description of this grade schema.
externalIdstringNoThe externalId associated with this grade schema.
symbolsobject[]NoThe list of grade symbols for this grade schema. Only returned for Tabular scaleType schemas.
titlestringNoThe title of this grade schema.

blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files

Attach File Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
attemptIdstringYesAttempt Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
namestringNoThe name of the file which has been attached to an Attempt including the file extension.
uploadIdstringYesUpload Id

blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_columns

Create Grade Column Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
availabilityobjectNoSettings controlling the availability/visibility of grade column data.
descriptionstringNoThe description of the grade column.
displayNamestringNoThe display name of the grade column. Only applicable for Classic courses. Ultra courses will simply use the name field. Since: 3300.2.0
externalGradebooleanNoWhether this grade column is an external grade column.
externalIdstringNoThe externalId for this grade column
externalToolIdstringNoThe externalId for this grade column Since: 3500.2.0
gradebookCategoryIdstringNoThe gradebook category ID for the grade column. Since: 3400.2.0
gradingobjectYesSettings controlling whether numerical and text grade values for this grade column are calculated, determined based on attempts, or manually entered.
includeInCalculationsbooleanNoIndicates whether or not this column is included in gradebook calculations. Cannot be set for Ultra courses. Default: true Since: 3800.4.0
namestringYesThe name of the grade column.
scoreobjectNoSettings controlling the numerical scoring of this grade column.
showStatisticsToStudentsbooleanNoIndicates whether or not column statistics are shown to students. Read-only for Ultra courses. Default: false Since: 3800.4.0

blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts

Create Column Attempt Parameters:
ParameterTypeRequiredDefaultDescription
columnIdstringYesColumn Id
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
attemptDatestringNoReturn the attempt date associated with this attempt.
attemptReceiptobjectNoAttempt Receipt
exemptbooleanNoWhether the score associated with this attempt is ignored when computing the user’s grade for the associated grade column.
feedbackstringNoThe instructor feedback associated with this attempt.
notesstringNoThe instructor notes associated with this attempt.
reconciliationModestringNoThe reconciliation mode to use when reconciling the attempt grade. When modifying reconciliationMode, score is also required. A new score will not be calculated based on the reconciliationMode Since: 3700.2.0 | Type | Description | --------- | --------- | | Average | | | Highest | | | Lowest | | | Custom | |
scorenumberNoThe score associated with this attempt.
statusstringNoThe status of this attempt. | Type | Description | --------- | --------- | | NotAttempted | none of the students in a group has submitted an attempt; applies only to group assessments | | Abandoned | Deprecated: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | InProgress | attempt activity has commenced, but has not been submitted for grading | | Suspended | Deprecated: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | Canceled | Deprecated: Since 9.1 SP8 unsupported status, undetermined behavior if used. | | NeedsGrading | attempt has been submitted for grading, but has not been fully graded | | Completed | a grade has been entered for the attempt | | InProgressAgain | attempt has been graded, but more student activity occurred after the grade was entered; applies only to collaborative tools such as discussions | | NeedsGradingAgain | additional student activity occurring after a grade was entered requires that the attempt be regraded; applies only to collaborative tools such as discussions |
studentCommentsstringNoThe student comments associated with this attempt.
studentSubmissionstringNoThe student submission text associated with this attempt.
textstringNoThe text grade associated with this attempt.
userIdstringNoThe user ID associated with this attempt. Defaults to the authenticated user on create. Can be specified as a user other than the authenticated user if the authenticated user has the “course.gradebook.MODIFY” entitlement and the authenticated application has the “course.attempt.nonowner.SUBMIT” entitlement.

blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_gradenotations

Create Grade Notation Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
codestringYesThe performance code associated with the grade notation.
descriptionstringYesThe description of the grade notation.

blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_periods

Create Grading Period Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
associatebooleanNoThe associate value
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
dateModestringNoProperty may be set to DoNotUseDates to explicitly blank dates, in which case startDate and endDate are ignored; otherwise set to UseDates; in this case startDate and endDate must be included and valid. | Type | Description | --------- | --------- | | DoNotUseDates | Do not use dates | | UseDates | Use dates |
descriptionstringNoThe description of the grading period. Length is limited to 1000 characters.
endstringNoIf start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. End dates will be persisted as ending at 23:59:59 on the submitted day.
positionintegerNoThe relative position of the grading period to other grading periods when viewed in the grade book.
startstringNoIf start and end are set, and start is before end, these define temporal coverage of grading period which may be used to associate GradableItems (Columns) by due date. Start dates will be persisted as starting at 00:00:00 on the submitted day.
titlestringYesThe title of the grading period. Length is limited to 64 characters.

blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_schemas

Create Grade Schema Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
descriptionstringNoThe description of this grade schema.
externalIdstringNoThe externalId associated with this grade schema.
scaleTypestringNoThe scale type of this grade schema. | Type | Description | --------- | --------- | | Percent | | | Score | | | Tabular | | | Text | | | CompleteIncomplete | |
symbolsobject[]NoThe list of grade symbols for this grade schema. Only returned for Tabular scaleType schemas.
titlestringYesThe title of this grade schema.