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

Tools

ToolDescription
blackboard_system_delete_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionidDelete Question
blackboard_system_delete_learn_api_public_lti_domains_by_domainidDelete Domain Config
blackboard_system_delete_learn_api_public_lti_placements_by_placementidDelete Placement
blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questionsGet Questions
blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionidGet Question By Id
blackboard_system_get_learn_api_public_lti_domainsGet Domain Configs
blackboard_system_get_learn_api_public_lti_domains_by_domainidGet Domain Config
blackboard_system_get_learn_api_public_lti_placementsGet Placements
blackboard_system_get_learn_api_public_lti_placements_by_placementidGet Placement
blackboard_system_get_learn_api_public_proctoring_servicesGet Proctoring Services
blackboard_system_get_learn_api_public_proctoring_services_by_proctoringserviceidGet Proctoring Service
blackboard_system_get_learn_api_public_system_policies_privacyGet Policies
blackboard_system_get_learn_api_public_system_tasks_by_taskidGet System Task
blackboard_system_get_learn_api_public_system_versionGet Version
blackboard_system_patch_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionidUpdate Question
blackboard_system_patch_learn_api_public_lti_domains_by_domainidUpdate Domain Config
blackboard_system_patch_learn_api_public_lti_placements_by_placementidUpdate Placement
blackboard_system_post_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questionsCreate Question
blackboard_system_post_learn_api_public_lti_domainsCreate Domain Config
blackboard_system_post_learn_api_public_lti_placementsCreate Placement
blackboard_system_post_learn_api_public_uploadsUpload

blackboard_system_delete_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid

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

blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid

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

blackboard_system_get_learn_api_public_lti_domains_by_domainid

Get Domain Config Parameters:
ParameterTypeRequiredDefaultDescription
domainIdstringYesDomain Id
fieldsstringNoA 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:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
handlestringNoSearch for placements with handle properties that contain this value. Since: 3200.12.0
namestringNoSearch for placements with name properties that contain this value. Since: 3200.12.0
typestringNoSearch 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 |
authorIdstringNoSearch 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
courseIdstringNoSearch for LTI placements that are available for this course. Note this only applies to Application, ContentHandler, and ContentItemMessage types currently Since: 3900.0.0
sortstringNoProperties 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
fieldsstringNoA 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:
ParameterTypeRequiredDefaultDescription
placementIdstringYesPlacement Id
fieldsstringNoA 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:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
availability.availablestringNoSearch for proctoring services with availability.available properties that contain this value. | Type | Description | --------- | --------- | | Yes | | | No | |
fieldsstringNoA 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:
ParameterTypeRequiredDefaultDescription
proctoringServiceIdstringYesProctoring Service Id
fieldsstringNoA 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:
ParameterTypeRequiredDefaultDescription
localestringNothe locale, otherwise it defaults to en_US

blackboard_system_get_learn_api_public_system_tasks_by_taskid

Get System Task Parameters:
ParameterTypeRequiredDefaultDescription
taskIdstringYesTask Id
fieldsstringNoA 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 Version

blackboard_system_patch_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid

Update Question Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
assessmentIdstringYesAssessment Id
questionIdstringYesQuestion Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
correctResponseFeedbackstringNoFeedback displayed to students when their submitted response is correct.
incorrectResponseFeedbackstringNoFeedback displayed to students when their submitted response is incorrect.
instructorNotesstringNoText added to the question as a note for the instructor. It is not intended to be displayed to students.
pointsnumberNoThe point value for the question.
positionintegerNoPosition of the Question on the Assessment Canvas.
questionHandlerobjectNoQuestion Handler
textstringNoThe main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor.
titlestringNoThe title of the question.

blackboard_system_patch_learn_api_public_lti_domains_by_domainid

Update Domain Config Parameters:
ParameterTypeRequiredDefaultDescription
domainIdstringYesDomain Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
allowGradesServicebooleanNoWhether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. Since: 3600.0.0
allowMembershipServicebooleanNoWhether the Tool is allowed to call the LTI Names and Roles service and get the course memberships.
clientIdstringNoThe client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 Since: 3600.0.0
customParametersobjectNoThe custom parameters for the given domain.
descriptionstringNoThe description of the domain configuration Since: 3900.23.0
jwksUrlstringNoThe JWKS URL of the tool, if specified. It is optional and can be null Since: 3800.17.0
keystringNoThe key value
namestringNoThe name of the domain configuration Since: 3900.23.0
primaryDomainstringNoThe primary domain name associated with this configuration.
publicKeystringNoThe public key of the tool, if specified. It is optional and can be null Since: 3800.17.0
secretstringNoThe secret value
sendEmailbooleanNoWhether the user’s email address can be sent to the LTI tool provider.
sendNamebooleanNoWhether the user’s name can be sent to the LTI tool provider.
sendRolebooleanNoWhether the user’s role can be sent to the LTI tool provider.
sendUserDataTypestringNoEnum indicating when user data can be sent to the LTI tool provider. | Type | Description | --------- | --------- | | Never | | | Sslonly | | | Always | Since: 3300.9.0 |
statusstringNoEnum 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 |
useSplashScreenbooleanNoWhether 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:
ParameterTypeRequiredDefaultDescription
placementIdstringYesPlacement Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
allowGradingbooleanNoWhether 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.
allowStudentsbooleanNoWhether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool.
authorIdstringNoId of the creator of the placement Deprecated: since 3900.0 not used
availabilityobjectNoSettings controlling availability of the placement.
customParametersobjectNoCustom launch parameters for the tool.
descriptionstringNoThe 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.
iconUrlstringNoThe 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.
instructorCreatedbooleanNoWhether an instructor created the placement or not (otherwise admin) Deprecated: since 3900.0 not used
keystringNoThe key value
launchInNewWindowbooleanNoWhether this placement link should be opened in a new window or not.
namestringNoThe 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.
secretstringNoThe secret value
urlstringNoThe 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:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
assessmentIdstringYesAssessment Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
correctResponseFeedbackstringNoFeedback displayed to students when their submitted response is correct.
incorrectResponseFeedbackstringNoFeedback displayed to students when their submitted response is incorrect.
instructorNotesstringNoText added to the question as a note for the instructor. It is not intended to be displayed to students.
pointsnumberNoThe point value for the question.
positionintegerNoPosition of the Question on the Assessment Canvas.
questionHandlerobjectNoQuestion Handler
textstringYesThe main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor.
titlestringNoThe title of the question.

blackboard_system_post_learn_api_public_lti_domains

Create Domain Config Parameters:
ParameterTypeRequiredDefaultDescription
allowGradesServicebooleanNoWhether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. Since: 3600.0.0
allowMembershipServicebooleanNoWhether the Tool is allowed to call the LTI Names and Roles service and get the course memberships.
clientIdstringNoThe client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 Since: 3600.0.0
customParametersobjectNoThe custom parameters for the given domain.
descriptionstringNoThe description of the domain configuration Since: 3900.23.0
jwksUrlstringNoThe JWKS URL of the tool, if specified. It is optional and can be null Since: 3800.17.0
keystringNoThe key value
namestringNoThe name of the domain configuration Since: 3900.23.0
primaryDomainstringNoThe primary domain name associated with this configuration.
publicKeystringNoThe public key of the tool, if specified. It is optional and can be null Since: 3800.17.0
secretstringNoThe secret value
sendEmailbooleanNoWhether the user’s email address can be sent to the LTI tool provider.
sendNamebooleanNoWhether the user’s name can be sent to the LTI tool provider.
sendRolebooleanNoWhether the user’s role can be sent to the LTI tool provider.
sendUserDataTypestringNoEnum indicating when user data can be sent to the LTI tool provider. | Type | Description | --------- | --------- | | Never | | | Sslonly | | | Always | Since: 3300.9.0 |
statusstringNoEnum 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 |
useSplashScreenbooleanNoWhether 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:
ParameterTypeRequiredDefaultDescription
allowGradingbooleanNoWhether 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.
allowStudentsbooleanNoWhether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool.
authorIdstringNoId of the creator of the placement Deprecated: since 3900.0 not used
availabilityobjectNoSettings controlling availability of the placement.
customParametersobjectNoCustom launch parameters for the tool.
descriptionstringNoThe 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.
handlestringYesThe 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.
iconUrlstringNoThe 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.
instructorCreatedbooleanNoWhether an instructor created the placement or not (otherwise admin) Deprecated: since 3900.0 not used
keystringNoThe key value
launchInNewWindowbooleanNoWhether this placement link should be opened in a new window or not.
namestringYesThe 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.
secretstringNoThe secret value
typestringYesThe 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 |
urlstringYesThe 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:
ParameterTypeRequiredDefaultDescription
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.