/blackboard-grades | Type: Application | PCID required: Yes
Tools
blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid
Delete Attachment Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
attemptId | string | Yes | — | Attempt Id |
attemptFileId | string | Yes | — | Attempt File Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"attemptId": {
"type": "string",
"description": "Attempt Id"
},
"attemptFileId": {
"type": "string",
"description": "Attempt File Id"
}
},
"required": [
"PCID",
"courseId",
"attemptId",
"attemptFileId"
]
}
blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid
Delete Grade Column Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
columnId | string | Yes | — | The 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 | |
onlyIfEmpty | boolean | No | — | Only If Empty |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"columnId": {
"type": "string",
"description": "The 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 |"
},
"onlyIfEmpty": {
"type": "boolean",
"description": "Only If Empty"
}
},
"required": [
"PCID",
"courseId",
"columnId"
]
}
blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid
Delete Grade Notation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
gradeNotationId | string | Yes | — | Grade Notation Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"gradeNotationId": {
"type": "string",
"description": "Grade Notation Id"
}
},
"required": [
"PCID",
"courseId",
"gradeNotationId"
]
}
blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid
Delete Grading Period Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
periodId | string | Yes | — | Period Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"periodId": {
"type": "string",
"description": "Period Id"
}
},
"required": [
"PCID",
"courseId",
"periodId"
]
}
blackboard_grades_delete_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid
Delete Grade Schema Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
schemaId | string | Yes | — | The 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 | |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"schemaId": {
"type": "string",
"description": "The 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 |"
}
},
"required": [
"PCID",
"courseId",
"schemaId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files
Get Attempt File Meta Data List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
attemptId | string | Yes | — | Attempt Id |
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"attemptId": {
"type": "string",
"description": "Attempt Id"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"attemptId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid
Get Attempt File Meta Data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
attemptId | string | Yes | — | Attempt Id |
attemptFileId | string | Yes | — | Attempt File Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"attemptId": {
"type": "string",
"description": "Attempt Id"
},
"attemptFileId": {
"type": "string",
"description": "Attempt File Id"
}
},
"required": [
"PCID",
"courseId",
"attemptId",
"attemptFileId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files_by_attemptfileid_download
Download Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
attemptId | string | Yes | — | Attempt Id |
attemptFileId | string | Yes | — | Attempt File Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"attemptId": {
"type": "string",
"description": "Attempt Id"
},
"attemptFileId": {
"type": "string",
"description": "Attempt File Id"
}
},
"required": [
"PCID",
"courseId",
"attemptId",
"attemptFileId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_categories
Get Gradebook Categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
}
},
"required": [
"PCID",
"courseId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_categories_by_categoryid
Get Gradebook Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
categoryId | string | Yes | — | the ID of the category to return |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"categoryId": {
"type": "string",
"description": "the ID of the category to return"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"categoryId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns
Get Grade Columns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
contentId | string | No | — | Search for grade columns associated with this content item. Since: 3000.11.0 |
displayName | string | No | — | The ‘displayName’ value to use as search criteria. Currently only supports ‘contains’ searches. Since: 3300.2.0 |
name | string | No | — | The ‘name’ value to use as search criteria. Currently only supports ‘contains’ searches. Since: 3900.11.0 |
gradebookCategoryId | string[] | No | — | Search for grade columns associated with the ‘gradebookCategoryId’. comma-delimited list of the gradebook category ids. Since: 3900.11.0 |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"contentId": {
"type": "string",
"description": "Search for grade columns associated with this content item. **Since**: 3000.11.0"
},
"displayName": {
"type": "string",
"description": "The 'displayName' value to use as search criteria. Currently only supports 'contains' searches. **Since**: 3300.2.0"
},
"name": {
"type": "string",
"description": "The 'name' value to use as search criteria. Currently only supports 'contains' searches. **Since**: 3900.11.0"
},
"gradebookCategoryId": {
"type": "array",
"items": {
"type": "string"
},
"description": "Search for grade columns associated with the 'gradebookCategoryId'. comma-delimited list of the gradebook category ids. **Since**: 3900.11.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid
Get Grade Column Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
columnId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"columnId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"columnId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts
Get Column Attempts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
columnId | string | Yes | — | The 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 | |
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
userId | string | No | — | Search 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 |
attemptStatuses | string | No | — | Search 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 | |
created | string | No | — | Search for attempts with created date relative to this value. ‘createdCompare’ may also be sent to control search behavior. Since: 3800.0.0 |
createdCompare | string | No | — | Used alongside the ‘created’ search parameter. Defaults to greaterOrEqual if not specified. Since: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
modified | string | No | — | Search for attempts with modified date relative to this value. ‘modifiedCompare’ may also be sent to control search behavior. Since: 3800.0.0 |
modifiedCompare | string | No | — | Used alongside the ‘modified’ search parameter. Defaults to greaterOrEqual if not specified. Since: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
attemptDate | string | No | — | Search for attempts with attempt date relative to this value. ‘attemptDateCompare’ may also be sent to control search behavior. Since: 3800.0.0 |
attemptDateCompare | string | No | — | Used alongside the ‘attemptDate’ search parameter. Defaults to greaterOrEqual if not specified. Since: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"columnId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"userId": {
"type": "string",
"description": "Search 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"
},
"attemptStatuses": {
"type": "string",
"description": "Search 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 |",
"enum": [
"NotAttempted",
"Abandoned",
"InProgress",
"Suspended",
"Canceled",
"NeedsGrading",
"Completed",
"InProgressAgain",
"NeedsGradingAgain"
]
},
"created": {
"type": "string",
"description": "Search for attempts with created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3800.0.0"
},
"createdCompare": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"modified": {
"type": "string",
"description": "Search for attempts with modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3800.0.0"
},
"modifiedCompare": {
"type": "string",
"description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"attemptDate": {
"type": "string",
"description": "Search for attempts with attempt date relative to this value. 'attemptDateCompare' may also be sent to control search behavior. **Since**: 3800.0.0"
},
"attemptDateCompare": {
"type": "string",
"description": "Used alongside the 'attemptDate' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3800.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"columnId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts_by_attemptid
Get Column Attempt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
columnId | string | Yes | — | The 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 | |
attemptId | string | Yes | — | Attempt Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"columnId": {
"type": "string",
"description": "The 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 |"
},
"attemptId": {
"type": "string",
"description": "Attempt Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"columnId",
"attemptId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users
Get Column Grades Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
columnId | string | Yes | — | The 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 | |
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
changeIndex | integer | No | — | Retrieve only items modified after the given change index. Since: 3300.4.0 |
includeUnpostedGrades | boolean | No | — | If 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 |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"columnId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"changeIndex": {
"type": "integer",
"description": "Retrieve only items modified after the given change index. **Since**: 3300.4.0"
},
"includeUnpostedGrades": {
"type": "boolean",
"description": "If 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"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"columnId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_by_userid
Get Column Grade Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
columnId | string | Yes | — | The 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 | |
userId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"columnId": {
"type": "string",
"description": "The 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 |"
},
"userId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"columnId",
"userId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_lastchanged
Get Column Grade Last Changed Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
columnId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"columnId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"columnId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_gradenotations
Get Grade Notations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid
Get Grade Notation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
gradeNotationId | string | Yes | — | Grade Notation Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"gradeNotationId": {
"type": "string",
"description": "Grade Notation Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"gradeNotationId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_periods
Get Grading Periods Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
sort | string | No | — | Properties 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 |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"sort": {
"type": "string",
"description": "Properties 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"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid
Get Grading Period Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
periodId | string | Yes | — | Period Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"periodId": {
"type": "string",
"description": "Period Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"periodId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_schemas
Get Grade Schemas Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid
Get Grade Schema Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
schemaId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"schemaId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"schemaId"
]
}
blackboard_grades_get_learn_api_public_courses_by_courseid_gradebook_users_by_userid
Get User Grades Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
userId | string | Yes | — | The 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 | |
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"userId": {
"type": "string",
"description": "The 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 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"userId"
]
}
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid
Update Grade Column Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
columnId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
availability | object | No | — | Settings controlling the availability/visibility of grade column data. |
description | string | No | — | The description of the grade column. |
displayName | string | No | — | The display name of the grade column. Only applicable for Classic courses. Ultra courses will simply use the name field. Since: 3300.2.0 |
externalGrade | boolean | No | — | Whether this grade column is an external grade column. |
externalId | string | No | — | The externalId for this grade column |
externalToolId | string | No | — | The externalId for this grade column Since: 3500.2.0 |
gradebookCategoryId | string | No | — | The gradebook category ID for the grade column. Since: 3400.2.0 |
grading | object | No | — | Settings controlling whether numerical and text grade values for this grade column are calculated, determined based on attempts, or manually entered. |
includeInCalculations | boolean | No | — | Indicates whether or not this column is included in gradebook calculations. Cannot be set for Ultra courses. Default: true Since: 3800.4.0 |
name | string | No | — | The name of the grade column. |
score | object | No | — | Settings controlling the numerical scoring of this grade column. |
showStatisticsToStudents | boolean | No | — | Indicates whether or not column statistics are shown to students. Read-only for Ultra courses. Default: false Since: 3800.4.0 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"columnId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling the availability/visibility of grade column data.",
"properties": {
"available": {
"type": "string",
"description": "Whether this grade column is available to students | Type | Description | --------- | --------- | | Yes | Students may view the grade column. | | No | Students may not view the grade column. |",
"enum": [
"Yes",
"No"
]
}
}
},
"description": {
"type": "string",
"description": "The description of the grade column."
},
"displayName": {
"type": "string",
"description": "The display name of the grade column. Only applicable for Classic courses. Ultra courses will simply use the `name` field. **Since**: 3300.2.0"
},
"externalGrade": {
"type": "boolean",
"description": "Whether this grade column is an external grade column."
},
"externalId": {
"type": "string",
"description": "The externalId for this grade column"
},
"externalToolId": {
"type": "string",
"description": "The externalId for this grade column **Since**: 3500.2.0"
},
"gradebookCategoryId": {
"type": "string",
"description": "The gradebook category ID for the grade column. **Since**: 3400.2.0"
},
"grading": {
"type": "object",
"description": "Settings controlling whether numerical and text grade values for this grade column are calculated, determined based on attempts, or manually entered.",
"properties": {
"due": {
"type": "string",
"description": "The date on which attempts are due for the grade column."
},
"attemptsAllowed": {
"type": "integer",
"description": "Number of attempts allowed for the grade column."
},
"scoringModel": {
"type": "string",
"description": "The scoring model for the submitted grade column attempts. | Type | Description | --------- | --------- | | Last | | | Highest | | | Lowest | | | First | | | Average | |",
"enum": [
"Last",
"Highest",
"Lowest",
"First",
"Average"
]
},
"schemaId": {
"type": "string",
"description": "The ID of the grade schema associated with this grade column. Mutable since 3400.2.0 **Since**: 3200.13.0"
},
"anonymousGrading": {
"type": "object",
"description": "Settings for anonymous grading"
}
}
},
"includeInCalculations": {
"type": "boolean",
"description": "Indicates whether or not this column is included in gradebook calculations. Cannot be set for Ultra courses. Default: true **Since**: 3800.4.0"
},
"name": {
"type": "string",
"description": "The name of the grade column."
},
"score": {
"type": "object",
"description": "Settings controlling the numerical scoring of this grade column.",
"properties": {
"possible": {
"type": "number",
"description": "The points possible for this grade column."
}
}
},
"showStatisticsToStudents": {
"type": "boolean",
"description": "Indicates whether or not column statistics are shown to students. Read-only for Ultra courses. Default: false **Since**: 3800.4.0"
}
},
"required": [
"PCID",
"courseId",
"columnId"
]
}
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts_by_attemptid
Update Column Attempt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
columnId | string | Yes | — | Column Id |
attemptId | string | Yes | — | Attempt Id |
courseId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
attemptReceipt | object | No | — | Attempt Receipt |
exempt | boolean | No | — | Whether the score associated with this attempt is ignored when computing the user’s grade for the associated grade column. |
feedback | string | No | — | The instructor feedback associated with this attempt. |
notes | string | No | — | The instructor notes associated with this attempt. |
reconciliationMode | string | No | — | The 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 | | |
score | number | No | — | The score associated with this attempt. |
status | string | No | — | The 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 | |
studentComments | string | No | — | The student comments associated with this attempt. |
studentSubmission | string | No | — | The student submission text associated with this attempt. |
text | string | No | — | The text grade associated with this attempt. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"columnId": {
"type": "string",
"description": "Column Id"
},
"attemptId": {
"type": "string",
"description": "Attempt Id"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"attemptReceipt": {
"type": "object",
"description": "Attempt Receipt",
"properties": {
"receiptId": {
"type": "string",
"description": "The associated receipt ID."
},
"submissionDate": {
"type": "string",
"description": "Get the associated receipt submission date."
}
}
},
"exempt": {
"type": "boolean",
"description": "Whether the score associated with this attempt is ignored when computing the user's grade for the associated grade column."
},
"feedback": {
"type": "string",
"description": "The instructor feedback associated with this attempt."
},
"notes": {
"type": "string",
"description": "The instructor notes associated with this attempt."
},
"reconciliationMode": {
"type": "string",
"description": "The 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 | |",
"enum": [
"Average",
"Highest",
"Lowest",
"Custom"
]
},
"score": {
"type": "number",
"description": "The score associated with this attempt."
},
"status": {
"type": "string",
"description": "The 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 |",
"enum": [
"NotAttempted",
"Abandoned",
"InProgress",
"Suspended",
"Canceled",
"NeedsGrading",
"Completed",
"InProgressAgain",
"NeedsGradingAgain"
]
},
"studentComments": {
"type": "string",
"description": "The student comments associated with this attempt."
},
"studentSubmission": {
"type": "string",
"description": "The student submission text associated with this attempt."
},
"text": {
"type": "string",
"description": "The text grade associated with this attempt."
}
},
"required": [
"PCID",
"columnId",
"attemptId",
"courseId"
]
}
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_users_by_userid
Update Column Grade Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
columnId | string | Yes | — | The 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 | |
userId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
exempt | boolean | No | — | Whether the score associated with this grade is ignored when computing the course grade. |
feedback | string | No | — | The 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. |
gradeNotationId | string | No | — | The 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. |
notes | string | No | — | The 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. |
score | number | No | — | The overridden score of this grade. This field is only used for overriding the grade |
text | string | No | — | The overridden text representation of this grade. This field is only used for overriding the grade via text value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"columnId": {
"type": "string",
"description": "The 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 |"
},
"userId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"exempt": {
"type": "boolean",
"description": "Whether the score associated with this grade is ignored when computing the course grade."
},
"feedback": {
"type": "string",
"description": "The 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."
},
"gradeNotationId": {
"type": "string",
"description": "The 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."
},
"notes": {
"type": "string",
"description": "The 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."
},
"score": {
"type": "number",
"description": "The overridden score of this grade. This field is only used for overriding the grade"
},
"text": {
"type": "string",
"description": "The overridden text representation of this grade. This field is only used for overriding the grade via text value"
}
},
"required": [
"PCID",
"courseId",
"columnId",
"userId"
]
}
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_gradenotations_by_gradenotationid
Update Grade Notation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
gradeNotationId | string | Yes | — | Grade Notation Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
code | string | No | — | The performance code associated with the grade notation. |
description | string | No | — | The description of the grade notation. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"gradeNotationId": {
"type": "string",
"description": "Grade Notation Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"code": {
"type": "string",
"description": "The performance code associated with the grade notation."
},
"description": {
"type": "string",
"description": "The description of the grade notation."
}
},
"required": [
"PCID",
"courseId",
"gradeNotationId"
]
}
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_periods_by_periodid
Update Grading Period Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
periodId | string | Yes | — | Period Id |
associate | boolean | No | — | The associate value |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
dateMode | string | No | — | Property 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 | |
description | string | No | — | The description of the grading period. Length is limited to 1000 characters. |
end | string | No | — | If 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. |
position | integer | No | — | The relative position of the grading period to other grading periods when viewed in the grade book. |
start | string | No | — | If 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. |
title | string | No | — | The title of the grading period. Length is limited to 64 characters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"periodId": {
"type": "string",
"description": "Period Id"
},
"associate": {
"type": "boolean",
"description": "The associate value"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"dateMode": {
"type": "string",
"description": "Property 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 |",
"enum": [
"DoNotUseDates",
"UseDates"
]
},
"description": {
"type": "string",
"description": "The description of the grading period. Length is limited to 1000 characters."
},
"end": {
"type": "string",
"description": "If 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."
},
"position": {
"type": "integer",
"description": "The relative position of the grading period to other grading periods when viewed in the grade book."
},
"start": {
"type": "string",
"description": "If 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."
},
"title": {
"type": "string",
"description": "The title of the grading period. Length is limited to 64 characters."
}
},
"required": [
"PCID",
"courseId",
"periodId"
]
}
blackboard_grades_patch_learn_api_public_courses_by_courseid_gradebook_schemas_by_schemaid
Update Grade Schema Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
schemaId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
description | string | No | — | The description of this grade schema. |
externalId | string | No | — | The externalId associated with this grade schema. |
symbols | object[] | No | — | The list of grade symbols for this grade schema. Only returned for Tabular scaleType schemas. |
title | string | No | — | The title of this grade schema. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"schemaId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"description": {
"type": "string",
"description": "The description of this grade schema."
},
"externalId": {
"type": "string",
"description": "The externalId associated with this grade schema."
},
"symbols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The text of this grade symbol."
},
"absoluteValue": {
"type": "number",
"description": "The absoluteValue of this grade symbol."
},
"lowerBound": {
"type": "number",
"description": "The lowerBound of this grade symbol."
},
"upperBound": {
"type": "number",
"description": "The upperBound of this grade symbol."
}
}
},
"description": "The list of grade symbols for this grade schema. Only returned for Tabular scaleType schemas."
},
"title": {
"type": "string",
"description": "The title of this grade schema."
}
},
"required": [
"PCID",
"courseId",
"schemaId"
]
}
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_attempts_by_attemptid_files
Attach File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
attemptId | string | Yes | — | Attempt Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
name | string | No | — | The name of the file which has been attached to an Attempt including the file extension. |
uploadId | string | Yes | — | Upload Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"attemptId": {
"type": "string",
"description": "Attempt Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"name": {
"type": "string",
"description": "The name of the file which has been attached to an Attempt including the file extension."
},
"uploadId": {
"type": "string",
"description": "Upload Id"
}
},
"required": [
"PCID",
"courseId",
"attemptId",
"uploadId"
]
}
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_columns
Create Grade Column Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
availability | object | No | — | Settings controlling the availability/visibility of grade column data. |
description | string | No | — | The description of the grade column. |
displayName | string | No | — | The display name of the grade column. Only applicable for Classic courses. Ultra courses will simply use the name field. Since: 3300.2.0 |
externalGrade | boolean | No | — | Whether this grade column is an external grade column. |
externalId | string | No | — | The externalId for this grade column |
externalToolId | string | No | — | The externalId for this grade column Since: 3500.2.0 |
gradebookCategoryId | string | No | — | The gradebook category ID for the grade column. Since: 3400.2.0 |
grading | object | Yes | — | Settings controlling whether numerical and text grade values for this grade column are calculated, determined based on attempts, or manually entered. |
includeInCalculations | boolean | No | — | Indicates whether or not this column is included in gradebook calculations. Cannot be set for Ultra courses. Default: true Since: 3800.4.0 |
name | string | Yes | — | The name of the grade column. |
score | object | No | — | Settings controlling the numerical scoring of this grade column. |
showStatisticsToStudents | boolean | No | — | Indicates whether or not column statistics are shown to students. Read-only for Ultra courses. Default: false Since: 3800.4.0 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling the availability/visibility of grade column data.",
"properties": {
"available": {
"type": "string",
"description": "Whether this grade column is available to students | Type | Description | --------- | --------- | | Yes | Students may view the grade column. | | No | Students may not view the grade column. |",
"enum": [
"Yes",
"No"
]
}
}
},
"description": {
"type": "string",
"description": "The description of the grade column."
},
"displayName": {
"type": "string",
"description": "The display name of the grade column. Only applicable for Classic courses. Ultra courses will simply use the `name` field. **Since**: 3300.2.0"
},
"externalGrade": {
"type": "boolean",
"description": "Whether this grade column is an external grade column."
},
"externalId": {
"type": "string",
"description": "The externalId for this grade column"
},
"externalToolId": {
"type": "string",
"description": "The externalId for this grade column **Since**: 3500.2.0"
},
"gradebookCategoryId": {
"type": "string",
"description": "The gradebook category ID for the grade column. **Since**: 3400.2.0"
},
"grading": {
"type": "object",
"description": "Settings controlling whether numerical and text grade values for this grade column are calculated, determined based on attempts, or manually entered.",
"properties": {
"type": {
"type": "string",
"description": "The type of Grading settings for this Grade Column. | Type | Description | --------- | --------- | | Attempts | Indicates score and grade values are determined based on user attempts | | Calculated | Indicates score and grade values are determined by applying a calculated formula. | | Manual | Indicates score and grade values are manually entered. |",
"enum": [
"Attempts",
"Calculated",
"Manual"
]
},
"due": {
"type": "string",
"description": "The date on which attempts are due for the grade column."
},
"attemptsAllowed": {
"type": "integer",
"description": "Number of attempts allowed for the grade column."
},
"scoringModel": {
"type": "string",
"description": "The scoring model for the submitted grade column attempts. | Type | Description | --------- | --------- | | Last | | | Highest | | | Lowest | | | First | | | Average | |",
"enum": [
"Last",
"Highest",
"Lowest",
"First",
"Average"
]
},
"schemaId": {
"type": "string",
"description": "The ID of the grade schema associated with this grade column. Mutable since 3400.2.0 **Since**: 3200.13.0"
},
"anonymousGrading": {
"type": "object",
"description": "Settings for anonymous grading"
}
},
"required": [
"anonymousGrading",
"type"
]
},
"includeInCalculations": {
"type": "boolean",
"description": "Indicates whether or not this column is included in gradebook calculations. Cannot be set for Ultra courses. Default: true **Since**: 3800.4.0"
},
"name": {
"type": "string",
"description": "The name of the grade column."
},
"score": {
"type": "object",
"description": "Settings controlling the numerical scoring of this grade column.",
"properties": {
"possible": {
"type": "number",
"description": "The points possible for this grade column."
}
}
},
"showStatisticsToStudents": {
"type": "boolean",
"description": "Indicates whether or not column statistics are shown to students. Read-only for Ultra courses. Default: false **Since**: 3800.4.0"
}
},
"required": [
"PCID",
"courseId",
"grading",
"name"
]
}
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_columns_by_columnid_attempts
Create Column Attempt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
columnId | string | Yes | — | Column Id |
courseId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
attemptDate | string | No | — | Return the attempt date associated with this attempt. |
attemptReceipt | object | No | — | Attempt Receipt |
exempt | boolean | No | — | Whether the score associated with this attempt is ignored when computing the user’s grade for the associated grade column. |
feedback | string | No | — | The instructor feedback associated with this attempt. |
notes | string | No | — | The instructor notes associated with this attempt. |
reconciliationMode | string | No | — | The 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 | | |
score | number | No | — | The score associated with this attempt. |
status | string | No | — | The 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 | |
studentComments | string | No | — | The student comments associated with this attempt. |
studentSubmission | string | No | — | The student submission text associated with this attempt. |
text | string | No | — | The text grade associated with this attempt. |
userId | string | No | — | The 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"columnId": {
"type": "string",
"description": "Column Id"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"attemptDate": {
"type": "string",
"description": "Return the attempt date associated with this attempt."
},
"attemptReceipt": {
"type": "object",
"description": "Attempt Receipt",
"properties": {
"receiptId": {
"type": "string",
"description": "The associated receipt ID."
},
"submissionDate": {
"type": "string",
"description": "Get the associated receipt submission date."
}
}
},
"exempt": {
"type": "boolean",
"description": "Whether the score associated with this attempt is ignored when computing the user's grade for the associated grade column."
},
"feedback": {
"type": "string",
"description": "The instructor feedback associated with this attempt."
},
"notes": {
"type": "string",
"description": "The instructor notes associated with this attempt."
},
"reconciliationMode": {
"type": "string",
"description": "The 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 | |",
"enum": [
"Average",
"Highest",
"Lowest",
"Custom"
]
},
"score": {
"type": "number",
"description": "The score associated with this attempt."
},
"status": {
"type": "string",
"description": "The 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 |",
"enum": [
"NotAttempted",
"Abandoned",
"InProgress",
"Suspended",
"Canceled",
"NeedsGrading",
"Completed",
"InProgressAgain",
"NeedsGradingAgain"
]
},
"studentComments": {
"type": "string",
"description": "The student comments associated with this attempt."
},
"studentSubmission": {
"type": "string",
"description": "The student submission text associated with this attempt."
},
"text": {
"type": "string",
"description": "The text grade associated with this attempt."
},
"userId": {
"type": "string",
"description": "The 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."
}
},
"required": [
"PCID",
"columnId",
"courseId"
]
}
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_gradenotations
Create Grade Notation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
code | string | Yes | — | The performance code associated with the grade notation. |
description | string | Yes | — | The description of the grade notation. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"code": {
"type": "string",
"description": "The performance code associated with the grade notation."
},
"description": {
"type": "string",
"description": "The description of the grade notation."
}
},
"required": [
"PCID",
"courseId",
"code",
"description"
]
}
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_periods
Create Grading Period Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
associate | boolean | No | — | The associate value |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
dateMode | string | No | — | Property 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 | |
description | string | No | — | The description of the grading period. Length is limited to 1000 characters. |
end | string | No | — | If 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. |
position | integer | No | — | The relative position of the grading period to other grading periods when viewed in the grade book. |
start | string | No | — | If 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. |
title | string | Yes | — | The title of the grading period. Length is limited to 64 characters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"associate": {
"type": "boolean",
"description": "The associate value"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"dateMode": {
"type": "string",
"description": "Property 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 |",
"enum": [
"DoNotUseDates",
"UseDates"
]
},
"description": {
"type": "string",
"description": "The description of the grading period. Length is limited to 1000 characters."
},
"end": {
"type": "string",
"description": "If 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."
},
"position": {
"type": "integer",
"description": "The relative position of the grading period to other grading periods when viewed in the grade book."
},
"start": {
"type": "string",
"description": "If 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."
},
"title": {
"type": "string",
"description": "The title of the grading period. Length is limited to 64 characters."
}
},
"required": [
"PCID",
"courseId",
"title"
]
}
blackboard_grades_post_learn_api_public_courses_by_courseid_gradebook_schemas
Create Grade Schema Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
description | string | No | — | The description of this grade schema. |
externalId | string | No | — | The externalId associated with this grade schema. |
scaleType | string | No | — | The scale type of this grade schema. | Type | Description | --------- | --------- | | Percent | | | Score | | | Tabular | | | Text | | | CompleteIncomplete | | |
symbols | object[] | No | — | The list of grade symbols for this grade schema. Only returned for Tabular scaleType schemas. |
title | string | Yes | — | The title of this grade schema. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The 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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"description": {
"type": "string",
"description": "The description of this grade schema."
},
"externalId": {
"type": "string",
"description": "The externalId associated with this grade schema."
},
"scaleType": {
"type": "string",
"description": "The scale type of this grade schema. | Type | Description | --------- | --------- | | Percent | | | Score | | | Tabular | | | Text | | | CompleteIncomplete | |",
"enum": [
"Percent",
"Score",
"Tabular",
"Text",
"CompleteIncomplete"
]
},
"symbols": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The text of this grade symbol."
},
"absoluteValue": {
"type": "number",
"description": "The absoluteValue of this grade symbol."
},
"lowerBound": {
"type": "number",
"description": "The lowerBound of this grade symbol."
},
"upperBound": {
"type": "number",
"description": "The upperBound of this grade symbol."
}
}
},
"description": "The list of grade symbols for this grade schema. Only returned for Tabular scaleType schemas."
},
"title": {
"type": "string",
"description": "The title of this grade schema."
}
},
"required": [
"PCID",
"courseId",
"title"
]
}