/blackboard-system | Type: Application | PCID required: Yes
Tools
blackboard_system_delete_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid
Delete Question 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 | |
assessmentId | string | Yes | — | Assessment Id |
questionId | string | Yes | — | Question Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
blackboard_system_delete_learn_api_public_lti_domains_by_domainid
Delete Domain Config Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domainId | string | Yes | — | Domain Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
blackboard_system_delete_learn_api_public_lti_placements_by_placementid
Delete Placement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
placementId | string | Yes | — | Placement Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions
Get Questions 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 | |
assessmentId | string | Yes | — | Assessment 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. |
blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid
Get Question By Id 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 | |
assessmentId | string | Yes | — | Assessment Id |
questionId | string | Yes | — | Question Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
blackboard_system_get_learn_api_public_lti_domains
Get Domain Configs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
blackboard_system_get_learn_api_public_lti_domains_by_domainid
Get Domain Config Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domainId | string | Yes | — | Domain Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
blackboard_system_get_learn_api_public_lti_placements
Get Placements Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
handle | string | No | — | Search for placements with handle properties that contain this value. Since: 3200.12.0 |
name | string | No | — | Search for placements with name properties that contain this value. Since: 3200.12.0 |
type | string | No | — | Search for placements with type properties that contain this value. Since: 3200.12.0 | Type | Description | --------- | --------- | | Application | Application or Student Tool Placement | | ContentHandler | Content Type placement | | ContentItemMessage | Content-item Message placement (see IMSGlobal spec) Since: 3300.5.0 | | System | System-level Tools | | Administrator | Administrator-level Tools Since: 3400.1.0 | | UltraUI | Ultra-UI Extensions Since: 3700.6.0 | | BaseNavigation | Base Navigation | | CourseNavigation | Course Navigation | | Proctoring | Proctoring Since: 3900.10.0 | |
authorId | string | No | — | Search for placements with author ID properties that contain this value. Since: 3200.12.0 Deprecated: since 3900.0.0; Field was never used and has been removed |
courseId | string | No | — | Search for LTI placements that are available for this course. Note this only applies to Application, ContentHandler, and ContentItemMessage types currently Since: 3900.0.0 |
sort | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional “(desc)” suffix to request a descending sort for that property. e.g. “name.family(desc),created” Since: 3100.0.0 |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
blackboard_system_get_learn_api_public_lti_placements_by_placementid
Get Placement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
placementId | string | Yes | — | Placement Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
blackboard_system_get_learn_api_public_proctoring_services
Get Proctoring Services Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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. |
availability.available | string | No | — | Search for proctoring services with availability.available properties that contain this value. | Type | Description | --------- | --------- | | Yes | | | No | | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
blackboard_system_get_learn_api_public_proctoring_services_by_proctoringserviceid
Get Proctoring Service Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
proctoringServiceId | string | Yes | — | Proctoring Service Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
blackboard_system_get_learn_api_public_system_policies_privacy
Get Policies Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
locale | string | No | — | the locale, otherwise it defaults to en_US |
blackboard_system_get_learn_api_public_system_tasks_by_taskid
Get System Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | Task Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
blackboard_system_get_learn_api_public_system_version
Get Versionblackboard_system_patch_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid
Update Question 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 | |
assessmentId | string | Yes | — | Assessment Id |
questionId | string | Yes | — | Question Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
correctResponseFeedback | string | No | — | Feedback displayed to students when their submitted response is correct. |
incorrectResponseFeedback | string | No | — | Feedback displayed to students when their submitted response is incorrect. |
instructorNotes | string | No | — | Text added to the question as a note for the instructor. It is not intended to be displayed to students. |
points | number | No | — | The point value for the question. |
position | integer | No | — | Position of the Question on the Assessment Canvas. |
questionHandler | object | No | — | Question Handler |
text | string | No | — | The main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor. |
title | string | No | — | The title of the question. |
blackboard_system_patch_learn_api_public_lti_domains_by_domainid
Update Domain Config Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
domainId | string | Yes | — | Domain Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
allowGradesService | boolean | No | — | Whether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. Since: 3600.0.0 |
allowMembershipService | boolean | No | — | Whether the Tool is allowed to call the LTI Names and Roles service and get the course memberships. |
clientId | string | No | — | The client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 Since: 3600.0.0 |
customParameters | object | No | — | The custom parameters for the given domain. |
description | string | No | — | The description of the domain configuration Since: 3900.23.0 |
jwksUrl | string | No | — | The JWKS URL of the tool, if specified. It is optional and can be null Since: 3800.17.0 |
key | string | No | — | The key value |
name | string | No | — | The name of the domain configuration Since: 3900.23.0 |
primaryDomain | string | No | — | The primary domain name associated with this configuration. |
publicKey | string | No | — | The public key of the tool, if specified. It is optional and can be null Since: 3800.17.0 |
secret | string | No | — | The secret value |
sendEmail | boolean | No | — | Whether the user’s email address can be sent to the LTI tool provider. |
sendName | boolean | No | — | Whether the user’s name can be sent to the LTI tool provider. |
sendRole | boolean | No | — | Whether the user’s role can be sent to the LTI tool provider. |
sendUserDataType | string | No | — | Enum indicating when user data can be sent to the LTI tool provider. | Type | Description | --------- | --------- | | Never | | | Sslonly | | | Always | Since: 3300.9.0 | |
status | string | No | — | Enum that indicates if the set of domains associated with this config can or cannot be linked to. | Type | Description | --------- | --------- | | Approved | | | Excluded | | | NeedsApproval | Since: 3300.9.0 | |
useSplashScreen | boolean | No | — | Whether a splash screen is shown before launching the LTI link. Cannot be set to true if allowMembershipService is true. |
blackboard_system_patch_learn_api_public_lti_placements_by_placementid
Update Placement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
placementId | string | Yes | — | Placement Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
allowGrading | boolean | No | — | Whether this placement can accept grades from the tool provider and a grade column can be created for it. This only applies to Enum[Type]#ContentHandler types. All others don’t support grading and will be set to false. |
allowStudents | boolean | No | — | Whether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool. |
authorId | string | No | — | Id of the creator of the placement Deprecated: since 3900.0 not used |
availability | object | No | — | Settings controlling availability of the placement. |
customParameters | object | No | — | Custom launch parameters for the tool. |
description | string | No | — | The description of the placement. Not required to be unique. Maximum length is 1000 characters, BAD_REQUEST error with message is returned if greater than 1000 characters. |
iconUrl | string | No | — | The URL of the icon for this placement, if any. Not required to be unique, must be a complete and valid URL. Maximum length is 255 characters, BAD_REQUEST error with message is returned if greater than 255 characters or incomplete URL. |
instructorCreated | boolean | No | — | Whether an instructor created the placement or not (otherwise admin) Deprecated: since 3900.0 not used |
key | string | No | — | The key value |
launchInNewWindow | boolean | No | — | Whether this placement link should be opened in a new window or not. |
name | string | No | — | The name of the placement. Not required to be unique. Maximum length of 50 characters, BAD_REQUEST error with message is returned if greater than 50 characters. |
secret | string | No | — | The secret value |
url | string | No | — | The URL of the tool provider. Not required to be unique, must be a complete and valid URL. Maximum length is 1024 characters, BAD_REQUEST error with message is returned if greater than 1024 characters or incomplete URL. |
blackboard_system_post_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions
Create Question 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 | |
assessmentId | string | Yes | — | Assessment Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
correctResponseFeedback | string | No | — | Feedback displayed to students when their submitted response is correct. |
incorrectResponseFeedback | string | No | — | Feedback displayed to students when their submitted response is incorrect. |
instructorNotes | string | No | — | Text added to the question as a note for the instructor. It is not intended to be displayed to students. |
points | number | No | — | The point value for the question. |
position | integer | No | — | Position of the Question on the Assessment Canvas. |
questionHandler | object | No | — | Question Handler |
text | string | Yes | — | The main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor. |
title | string | No | — | The title of the question. |
blackboard_system_post_learn_api_public_lti_domains
Create Domain Config Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
allowGradesService | boolean | No | — | Whether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. Since: 3600.0.0 |
allowMembershipService | boolean | No | — | Whether the Tool is allowed to call the LTI Names and Roles service and get the course memberships. |
clientId | string | No | — | The client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 Since: 3600.0.0 |
customParameters | object | No | — | The custom parameters for the given domain. |
description | string | No | — | The description of the domain configuration Since: 3900.23.0 |
jwksUrl | string | No | — | The JWKS URL of the tool, if specified. It is optional and can be null Since: 3800.17.0 |
key | string | No | — | The key value |
name | string | No | — | The name of the domain configuration Since: 3900.23.0 |
primaryDomain | string | No | — | The primary domain name associated with this configuration. |
publicKey | string | No | — | The public key of the tool, if specified. It is optional and can be null Since: 3800.17.0 |
secret | string | No | — | The secret value |
sendEmail | boolean | No | — | Whether the user’s email address can be sent to the LTI tool provider. |
sendName | boolean | No | — | Whether the user’s name can be sent to the LTI tool provider. |
sendRole | boolean | No | — | Whether the user’s role can be sent to the LTI tool provider. |
sendUserDataType | string | No | — | Enum indicating when user data can be sent to the LTI tool provider. | Type | Description | --------- | --------- | | Never | | | Sslonly | | | Always | Since: 3300.9.0 | |
status | string | No | — | Enum that indicates if the set of domains associated with this config can or cannot be linked to. | Type | Description | --------- | --------- | | Approved | | | Excluded | | | NeedsApproval | Since: 3300.9.0 | |
useSplashScreen | boolean | No | — | Whether a splash screen is shown before launching the LTI link. Cannot be set to true if allowMembershipService is true. |
blackboard_system_post_learn_api_public_lti_placements
Create Placement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
allowGrading | boolean | No | — | Whether this placement can accept grades from the tool provider and a grade column can be created for it. This only applies to Enum[Type]#ContentHandler types. All others don’t support grading and will be set to false. |
allowStudents | boolean | No | — | Whether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool. |
authorId | string | No | — | Id of the creator of the placement Deprecated: since 3900.0 not used |
availability | object | No | — | Settings controlling availability of the placement. |
customParameters | object | No | — | Custom launch parameters for the tool. |
description | string | No | — | The description of the placement. Not required to be unique. Maximum length is 1000 characters, BAD_REQUEST error with message is returned if greater than 1000 characters. |
handle | string | Yes | — | The handle that uniquely identifies this placement. Required to be unique. Maximum length is 32 characters, BAD_REQUEST error with message is returned if greater than 32 characters. |
iconUrl | string | No | — | The URL of the icon for this placement, if any. Not required to be unique, must be a complete and valid URL. Maximum length is 255 characters, BAD_REQUEST error with message is returned if greater than 255 characters or incomplete URL. |
instructorCreated | boolean | No | — | Whether an instructor created the placement or not (otherwise admin) Deprecated: since 3900.0 not used |
key | string | No | — | The key value |
launchInNewWindow | boolean | No | — | Whether this placement link should be opened in a new window or not. |
name | string | Yes | — | The name of the placement. Not required to be unique. Maximum length of 50 characters, BAD_REQUEST error with message is returned if greater than 50 characters. |
secret | string | No | — | The secret value |
type | string | Yes | — | The type of placement. | Type | Description | --------- | --------- | | Application | Application or Student Tool Placement | | ContentHandler | Content Type placement | | ContentItemMessage | Content-item Message placement (see IMSGlobal spec) Since: 3300.5.0 | | System | System-level Tools | | Administrator | Administrator-level Tools Since: 3400.1.0 | | UltraUI | Ultra-UI Extensions Since: 3700.6.0 | | BaseNavigation | Base Navigation | | CourseNavigation | Course Navigation | | Proctoring | Proctoring Since: 3900.10.0 | |
url | string | Yes | — | The URL of the tool provider. Not required to be unique, must be a complete and valid URL. Maximum length is 1024 characters, BAD_REQUEST error with message is returned if greater than 1024 characters or incomplete URL. |
blackboard_system_post_learn_api_public_uploads
Upload Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |

