/blackboard-content | Type: Application | PCID required: Yes
Tools
blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid
Delete Content 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 | |
contentId | string | Yes | — | The 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 | |
allowChildCourseContent | boolean | No | — | By 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. |
deleteGrades | boolean | No | — | If 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:| 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 | |
contentId | string | Yes | — | The 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 | |
attachmentId | string | Yes | — | Attachment Id |
blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid
Delete Content Group 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 | |
contentId | string | Yes | — | Content Id |
allowChildCourseContent | boolean | No | — | By 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. |
groupId | string | Yes | — | The 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:| 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. |
recursive | boolean | No | — | Search 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 |
title | string | No | — | Search for content title. Will return all Content items whose title contains the supplied search value. Since: 3900.10.0 |
contentHandler | string | No | — | Search for the specific content handler. Not setting this field will return all content handlers. Since: 3400.5.0 |
created | string | No | — | Search for contents with a created date relative to this value. ‘createdCompare’ may also be sent to control search behavior. Since: 3700.1.0 |
createdCompare | string | No | — | Used alongside the ‘created’ search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. Since: 3700.1.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
modified | string | No | — | Search for contents with a modified date relative to this value. ‘modifiedCompare’ may also be sent to control search behavior. Since: 3700.4.0 |
modifiedCompare | string | No | — | Used alongside the ‘modified’ search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. Since: 3700.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
reviewable | boolean | No | — | Search contents by whether they are reviewable or not. Since: 3700.15.0 |
fields | string | No | — | A 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:| 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 | |
contentId | string | Yes | — | The 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 | |
fields | string | No | — | A 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:| 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 | |
contentId | string | Yes | — | The 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 | |
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)” suffix to request a descending sort for that property. e.g. “title(desc)” Supported fields are: - id - title Since: 3900.23.0 |
fields | string | No | — | A 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:| 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 | |
contentId | string | Yes | — | The 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 | |
ruleId | string | Yes | — | Rule Id |
fields | string | No | — | A 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:| 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 | |
contentId | string | Yes | — | The 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 | |
ruleId | string | Yes | — | Rule 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. |
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. “title(desc)” Supported fields are: - id Since: 3900.23.0 |
fields | string | No | — | A 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:| 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 | |
contentId | string | Yes | — | The 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 | |
ruleId | string | Yes | — | Rule Id |
criterionId | string | Yes | — | Criterion Id |
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments
Get File Attachments 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 | |
contentId | string | Yes | — | The 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 | |
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. |
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid
Get File 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 | |
contentId | string | Yes | — | The 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 | |
attachmentId | string | Yes | — | Attachment Id |
fields | string | No | — | A 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:| 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 | |
contentId | string | Yes | — | The 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 | |
attachmentId | string | Yes | — | Attachment Id |
blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_children
Get Content Children 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 | |
contentId | string | Yes | — | The 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 | |
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. |
recursive | boolean | No | — | Search 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 |
title | string | No | — | Search for content title. Will return all Content items whose title contains the supplied search value. Since: 3900.10.0 |
contentHandler | string | No | — | Search for the specific content handler. Not setting this field will return all content handlers. Since: 3400.5.0 |
created | string | No | — | Search for contents with a created date relative to this value. ‘createdCompare’ may also be sent to control search behavior. Since: 3700.1.0 |
createdCompare | string | No | — | Used alongside the ‘created’ search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. Since: 3700.1.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
modified | string | No | — | Search for contents with a modified date relative to this value. ‘modifiedCompare’ may also be sent to control search behavior. Since: 3700.4.0 |
modifiedCompare | string | No | — | Used alongside the ‘modified’ search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. Since: 3700.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
reviewable | boolean | No | — | Search contents by whether they are reviewable or not. Since: 3700.15.0 |
fields | string | No | — | A 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:| 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 | |
contentId | string | Yes | — | Content 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_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid
Get Content Group 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 | |
contentId | string | Yes | — | Content Id |
groupId | string | Yes | — | The 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 | |
fields | string | No | — | A 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:| 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 | |
contentId | string | Yes | — | The 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 | |
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. |
blackboard_content_get_learn_api_public_courses_by_courseid_resources
Get Top Level Course Resources 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 | |
type | string | No | — | Search for Resources whose Type matches the specified value. Valid values are ‘File’ and ‘Folder’. | Type | Description | --------- | --------- | | File | | | Folder | | |
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_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid
Get Course Resource 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 | |
resourceId | string | Yes | — | The 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 | |
fields | string | No | — | A 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:| 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 | |
resourceId | string | Yes | — | The 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 | |
type | string | No | — | Search for Resources whose Type matches the specified value. Valid values are ‘File’ and ‘Folder’. | Type | Description | --------- | --------- | | File | | | Folder | | |
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_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid
Update Content 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 | |
contentId | string | Yes | — | The 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 | |
allowChildCourseContent | boolean | No | — | By 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. |
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 availability of the content to students. |
body | string | No | — | The body text associated with this content. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’>here</a> for more information. |
contentHandler | object | No | — | Content Handler |
description | string | No | — | The 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. |
launchInNewWindow | boolean | No | — | Indicates whether the content is going to open in a new window. Since: 3800.10.0 |
parentId | string | No | — | The 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. |
position | integer | No | — | The 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. |
reviewable | boolean | No | — | Indicates 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 |
title | string | No | — | The 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:| 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 | |
contentId | string | Yes | — | The 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 | |
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. |
reviewed | boolean | No | — | The 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:| 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 | |
allowChildCourseContent | boolean | No | — | By 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. |
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 availability of the content to students. |
body | string | No | — | The body text associated with this content. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’>here</a> for more information. |
contentHandler | object | No | — | Content Handler |
description | string | No | — | The 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. |
launchInNewWindow | boolean | No | — | Indicates whether the content is going to open in a new window. Since: 3800.10.0 |
parentId | string | No | — | The 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. |
position | integer | No | — | The 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. |
reviewable | boolean | No | — | Indicates 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 |
title | string | Yes | — | The 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:| 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 | |
contentId | string | Yes | — | The 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
title | string | Yes | — | Title 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:| 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 | |
contentId | string | Yes | — | The 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 | |
ruleId | string | Yes | — | Rule Id |
id | string | No | — | Internal Identifier of the Rule’s criteria. |
type | string | No | — | The type value |
blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_attachments
Create File 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 | |
contentId | string | Yes | — | The 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 | |
body | object | Yes | — | Request body |
blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_children
Create Child 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 | |
contentId | string | Yes | — | The 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 | |
allowChildCourseContent | boolean | No | — | By 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. |
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 availability of the content to students. |
body | string | No | — | The body text associated with this content. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’>here</a> for more information. |
contentHandler | object | No | — | Content Handler |
description | string | No | — | The 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. |
launchInNewWindow | boolean | No | — | Indicates whether the content is going to open in a new window. Since: 3800.10.0 |
parentId | string | No | — | The 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. |
position | integer | No | — | The 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. |
reviewable | boolean | No | — | Indicates 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 |
title | string | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
allowChildCourseContent | boolean | No | — | By 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. |
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 | — | The availability value |
description | string | No | — | The description to use when creating the assignment content. |
fileUploadIds | string[] | No | — | File Upload Ids |
grading | object | No | — | The grading value |
instructions | string | No | — | The 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’>here</a> for more information. |
originalityReportingTool | object | No | — | Originality Reporting Tool |
parentId | string | No | — | The id of the parent content for the created assignment. |
position | integer | No | — | The 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. |
score | object | No | — | The score value |
title | string | Yes | — | The 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:| 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 | |
contentId | string | Yes | — | Content Id |
groupId | string | Yes | — | The 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 | |
allowChildCourseContent | boolean | No | — | By 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. |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |

