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

Tools

ToolDescription
blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentidDelete Content
blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentidDelete File Attachment
blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupidDelete Content Group
blackboard_content_get_learn_api_public_courses_by_courseid_contentsGet Contents
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentidGet Content
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rulesGet Rules
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleidGet Rule
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteriaGet Criteria
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria_by_criterionidGet Adaptive Release Rule Criterion
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachmentsGet File Attachments
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentidGet File Attachment
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid_downloadDownload
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_childrenGet Content Children
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groupsGet Content Groups
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupidGet Content Group
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatusGet Review Status
blackboard_content_get_learn_api_public_courses_by_courseid_resourcesGet Top Level Course Resources
blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceidGet Course Resource
blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid_childrenGet Course Resource Children
blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentidUpdate Content
blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatusUpdate Review Status
blackboard_content_post_learn_api_public_courses_by_courseid_contentsCreate Content
blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rulesCreate Rule
blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteriaCreate Adaptive Release Rule Criteria
blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_attachmentsCreate File Attachment
blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_childrenCreate Child
blackboard_content_post_learn_api_public_courses_by_courseid_contents_createassignmentCreate Assignment
blackboard_content_put_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupidCreate Content Group

blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid

Delete Content 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
allowChildCourseContentbooleanNoBy default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation.
deleteGradesbooleanNoIf true and there is a grade column associated with this content, that grade column will be marked as deleted. All attempts and grades will also be removed. If false, the grade column will not be marked as deleted. Attempts will not be deleted and grades will be converted to manually entered grades. Defaults to false.

blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid

Delete File Attachment Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
attachmentIdstringYesAttachment Id

blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid

Delete Content Group 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 |
contentIdstringYesContent Id
allowChildCourseContentbooleanNoBy default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation.
groupIdstringYesThe group 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:breakfastClub |

blackboard_content_get_learn_api_public_courses_by_courseid_contents

Get Contents Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
recursivebooleanNoSearch for child content recursively. A value of ‘true’ indicates that search results should include all content descendants within the hierarchy of the specified parent. A value of ‘false’ indicates results should be limited to immediate children only. Not setting this field defaults to ‘false’ behavior; only including immediate children. Since: 3100.2.0
titlestringNoSearch for content title. Will return all Content items whose title contains the supplied search value. Since: 3900.10.0
contentHandlerstringNoSearch for the specific content handler. Not setting this field will return all content handlers. Since: 3400.5.0
createdstringNoSearch for contents with a created date relative to this value. ‘createdCompare’ may also be sent to control search behavior. Since: 3700.1.0
createdComparestringNoUsed alongside the ‘created’ search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. Since: 3700.1.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |
modifiedstringNoSearch for contents with a modified date relative to this value. ‘modifiedCompare’ may also be sent to control search behavior. Since: 3700.4.0
modifiedComparestringNoUsed alongside the ‘modified’ search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. Since: 3700.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |
reviewablebooleanNoSearch contents by whether they are reviewable or not. Since: 3700.15.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid

Get Content 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules

Get Rules 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.
sortstringNoProperties to sort by. This is a comma-delimited list of JSON properties, with an optional “(desc)” suffix to request a descending sort for that property. e.g. “title(desc)” Supported fields are: - id - title Since: 3900.23.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid

Get Rule 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
ruleIdstringYesRule Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria

Get Criteria 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
ruleIdstringYesRule 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.
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. “title(desc)” Supported fields are: - id Since: 3900.23.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria_by_criterionid

Get Adaptive Release Rule Criterion 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
ruleIdstringYesRule Id
criterionIdstringYesCriterion Id

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments

Get File Attachments 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
offsetintegerNoThe number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
limitintegerNoThe maximum number of results to be returned. There may be less if the query returned less than the maximum.

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid

Get File Attachment Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
attachmentIdstringYesAttachment Id
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid_download

Download Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
attachmentIdstringYesAttachment Id

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_children

Get Content Children 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
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.
recursivebooleanNoSearch for child content recursively. A value of ‘true’ indicates that search results should include all content descendants within the hierarchy of the specified parent. A value of ‘false’ indicates results should be limited to immediate children only. Not setting this field defaults to ‘false’ behavior; only including immediate children. Since: 3100.2.0
titlestringNoSearch for content title. Will return all Content items whose title contains the supplied search value. Since: 3900.10.0
contentHandlerstringNoSearch for the specific content handler. Not setting this field will return all content handlers. Since: 3400.5.0
createdstringNoSearch for contents with a created date relative to this value. ‘createdCompare’ may also be sent to control search behavior. Since: 3700.1.0
createdComparestringNoUsed alongside the ‘created’ search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. Since: 3700.1.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |
modifiedstringNoSearch for contents with a modified date relative to this value. ‘modifiedCompare’ may also be sent to control search behavior. Since: 3700.4.0
modifiedComparestringNoUsed alongside the ‘modified’ search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. Since: 3700.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |
reviewablebooleanNoSearch contents by whether they are reviewable or not. Since: 3700.15.0
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups

Get Content Groups 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 |
contentIdstringYesContent 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_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid

Get Content Group 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 |
contentIdstringYesContent Id
groupIdstringYesThe group 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:breakfastClub |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatus

Get Review Status 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
userIdstringYesThe user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_content_get_learn_api_public_courses_by_courseid_resources

Get Top Level Course Resources 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 |
typestringNoSearch for Resources whose Type matches the specified value. Valid values are ‘File’ and ‘Folder’. | Type | Description | --------- | --------- | | File | | | Folder | |
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_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid

Get Course Resource 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 |
resourceIdstringYesThe xythos resource ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|--------------------------------------------------| | primary | _123_1 | | xid | xid-123_1-1 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.

blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid_children

Get Course Resource Children 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 |
resourceIdstringYesThe xythos resource ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|--------------------------------------------------| | primary | _123_1 | | xid | xid-123_1-1 |
typestringNoSearch for Resources whose Type matches the specified value. Valid values are ‘File’ and ‘Folder’. | Type | Description | --------- | --------- | | File | | | Folder | |
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_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid

Update Content 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
allowChildCourseContentbooleanNoBy default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation.
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
availabilityobjectNoSettings controlling availability of the content to students.
bodystringNoThe body text associated with this content. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’&gt;here&lt;/a> for more information.
contentHandlerobjectNoContent Handler
descriptionstringNoThe short description of this content. This field is not used in Classic courses. For Ultra courses this is used to show information directly on the course outline.
launchInNewWindowbooleanNoIndicates whether the content is going to open in a new window. Since: 3800.10.0
parentIdstringNoThe ID of the content’s parent. Note that top-level contents do not have parents. The ‘parentId’ field is a writable field as of the Bb Learn 3200.6.0 release. Specifying a new value in PATCH requests allows the Content object to be moved from one parent to another.
positionintegerNoThe position of this content within its parent folder. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent.
reviewablebooleanNoIndicates whether Review Status is enabled for this content. Content items with review status enabled can be marked as reviewed by students in classic courses and content items with review status enabled in Ultra are either in a Forced Sequence or content that should be counted towards the progress tracking feature as of 3900.19 This can be used to track performance and in Adaptive Release rules to control the release of other content. Since: 3700.15.0
titlestringNoThe title or name of this content. Typically shown as the main text to click in the course outline when accessing the content.

blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatus

Update Review Status 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
userIdstringYesThe user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
reviewedbooleanNoThe current status of the content’s ‘reviewed’ attribute. Since: 3700.16.0

blackboard_content_post_learn_api_public_courses_by_courseid_contents

Create Content 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 |
allowChildCourseContentbooleanNoBy default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation.
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
availabilityobjectNoSettings controlling availability of the content to students.
bodystringNoThe body text associated with this content. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’&gt;here&lt;/a> for more information.
contentHandlerobjectNoContent Handler
descriptionstringNoThe short description of this content. This field is not used in Classic courses. For Ultra courses this is used to show information directly on the course outline.
launchInNewWindowbooleanNoIndicates whether the content is going to open in a new window. Since: 3800.10.0
parentIdstringNoThe ID of the content’s parent. Note that top-level contents do not have parents. The ‘parentId’ field is a writable field as of the Bb Learn 3200.6.0 release. Specifying a new value in PATCH requests allows the Content object to be moved from one parent to another.
positionintegerNoThe position of this content within its parent folder. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent.
reviewablebooleanNoIndicates whether Review Status is enabled for this content. Content items with review status enabled can be marked as reviewed by students in classic courses and content items with review status enabled in Ultra are either in a Forced Sequence or content that should be counted towards the progress tracking feature as of 3900.19 This can be used to track performance and in Adaptive Release rules to control the release of other content. Since: 3700.15.0
titlestringYesThe title or name of this content. Typically shown as the main text to click in the course outline when accessing the content.

blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules

Create Rule 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
titlestringYesTitle given to the adaptive release rule

blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria

Create Adaptive Release Rule Criteria 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
ruleIdstringYesRule Id
idstringNoInternal Identifier of the Rule’s criteria.
typestringNoThe type value

blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_attachments

Create File Attachment Parameters:
ParameterTypeRequiredDefaultDescription
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
bodyobjectYesRequest body

blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_children

Create Child 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 |
contentIdstringYesThe Content ID. This may be the primary ID, or any of the following keywords: interactive, indirect, root. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | keyword | root |
allowChildCourseContentbooleanNoBy default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation.
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
availabilityobjectNoSettings controlling availability of the content to students.
bodystringNoThe body text associated with this content. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’&gt;here&lt;/a> for more information.
contentHandlerobjectNoContent Handler
descriptionstringNoThe short description of this content. This field is not used in Classic courses. For Ultra courses this is used to show information directly on the course outline.
launchInNewWindowbooleanNoIndicates whether the content is going to open in a new window. Since: 3800.10.0
parentIdstringNoThe ID of the content’s parent. Note that top-level contents do not have parents. The ‘parentId’ field is a writable field as of the Bb Learn 3200.6.0 release. Specifying a new value in PATCH requests allows the Content object to be moved from one parent to another.
positionintegerNoThe position of this content within its parent folder. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent.
reviewablebooleanNoIndicates whether Review Status is enabled for this content. Content items with review status enabled can be marked as reviewed by students in classic courses and content items with review status enabled in Ultra are either in a Forced Sequence or content that should be counted towards the progress tracking feature as of 3900.19 This can be used to track performance and in Adaptive Release rules to control the release of other content. Since: 3700.15.0
titlestringYesThe title or name of this content. Typically shown as the main text to click in the course outline when accessing the content.

blackboard_content_post_learn_api_public_courses_by_courseid_contents_createassignment

Create Assignment Parameters:
ParameterTypeRequiredDefaultDescription
allowChildCourseContentbooleanNoBy default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation.
courseIdstringYesThe course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.
availabilityobjectNoThe availability value
descriptionstringNoThe description to use when creating the assignment content.
fileUploadIdsstring[]NoFile Upload Ids
gradingobjectNoThe grading value
instructionsstringNoThe text instructions to use when creating the assignment content. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’&gt;here&lt;/a> for more information.
originalityReportingToolobjectNoOriginality Reporting Tool
parentIdstringNoThe id of the parent content for the created assignment.
positionintegerNoThe position of the created assignment within the other other content of its parent. Position values are zero-based (the first element has a position value of zero, not one). Default position is last in the list of child contents under the parent.
scoreobjectNoThe score value
titlestringYesThe title used for the created assignment content and gradebook column. Typically shown as the main text to click in the course outline when accessing the assignment.

blackboard_content_put_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid

Create Content Group 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 |
contentIdstringYesContent Id
groupIdstringYesThe group 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:breakfastClub |
allowChildCourseContentbooleanNoBy default, child courses of a cross listed course can not have their contents modified. The allowChildCourseContent parameter can be sent as true in order to bypass this validation.
fieldsstringNoA comma-delimited list of fields to include in the response. If not specified, all fields will be returned.