> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# blackboard-content
> Blackboard Content - course content, file attachments, resources, review, and adaptive release
**Server path:** `/blackboard-content` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| [`blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid`](#blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid) | Delete Content |
| [`blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid`](#blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid) | Delete File Attachment |
| [`blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid`](#blackboard_content_delete_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid) | Delete Content Group |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents) | Get Contents |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid) | Get Content |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules) | Get Rules |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid) | Get Rule |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria) | Get Criteria |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria_by_criterionid`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria_by_criterionid) | Get Adaptive Release Rule Criterion |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments) | Get File Attachments |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid) | Get File Attachment |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid_download`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_attachments_by_attachmentid_download) | Download |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_children`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_children) | Get Content Children |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups) | Get Content Groups |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid) | Get Content Group |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatus`](#blackboard_content_get_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatus) | Get Review Status |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_resources`](#blackboard_content_get_learn_api_public_courses_by_courseid_resources) | Get Top Level Course Resources |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid`](#blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid) | Get Course Resource |
| [`blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid_children`](#blackboard_content_get_learn_api_public_courses_by_courseid_resources_by_resourceid_children) | Get Course Resource Children |
| [`blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid`](#blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid) | Update Content |
| [`blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatus`](#blackboard_content_patch_learn_api_public_courses_by_courseid_contents_by_contentid_users_by_userid_reviewstatus) | Update Review Status |
| [`blackboard_content_post_learn_api_public_courses_by_courseid_contents`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents) | Create Content |
| [`blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules) | Create Rule |
| [`blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_adaptiverelease_rules_by_ruleid_criteria) | Create Adaptive Release Rule Criteria |
| [`blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_attachments`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_attachments) | Create File Attachment |
| [`blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_children`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents_by_contentid_children) | Create Child |
| [`blackboard_content_post_learn_api_public_courses_by_courseid_contents_createassignment`](#blackboard_content_post_learn_api_public_courses_by_courseid_contents_createassignment) | Create Assignment |
| [`blackboard_content_put_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid`](#blackboard_content_put_learn_api_public_courses_by_courseid_contents_by_contentid_groups_by_groupid) | Create Content Group |
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "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": {
"type": "boolean",
"description": "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."
}
},
"required": [
"PCID",
"courseId",
"contentId"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Attachment Id"
}
},
"required": [
"PCID",
"courseId",
"contentId",
"attachmentId"
]
}
```
***
## 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 \| |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "Content Id"
},
"allowChildCourseContent": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "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 |"
}
},
"required": [
"PCID",
"courseId",
"contentId",
"groupId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"recursive": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "Search for content title. Will return all Content items whose title contains the supplied search value. **Since**: 3900.10.0"
},
"contentHandler": {
"type": "string",
"description": "Search for the specific content handler. Not setting this field will return all content handlers. **Since**: 3400.5.0"
},
"created": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.1.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"modified": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"reviewable": {
"type": "boolean",
"description": "Search contents by whether they are reviewable or not. **Since**: 3700.15.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId"
]
}
```
***
## blackboard\_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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"contentId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"sort": {
"type": "string",
"description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"title(desc)\" Supported fields are: - id - title **Since**: 3900.23.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"contentId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Rule Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"contentId",
"ruleId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Rule Id"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"sort": {
"type": "string",
"description": "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": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"contentId",
"ruleId"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Rule Id"
},
"criterionId": {
"type": "string",
"description": "Criterion Id"
}
},
"required": [
"PCID",
"courseId",
"contentId",
"ruleId",
"criterionId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
}
},
"required": [
"PCID",
"courseId",
"contentId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Attachment Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"contentId",
"attachmentId"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Attachment Id"
}
},
"required": [
"PCID",
"courseId",
"contentId",
"attachmentId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"recursive": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "Search for content title. Will return all Content items whose title contains the supplied search value. **Since**: 3900.10.0"
},
"contentHandler": {
"type": "string",
"description": "Search for the specific content handler. Not setting this field will return all content handlers. **Since**: 3400.5.0"
},
"created": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.1.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"modified": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Used alongside the 'modified' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"reviewable": {
"type": "boolean",
"description": "Search contents by whether they are reviewable or not. **Since**: 3700.15.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"contentId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "Content Id"
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"contentId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "Content Id"
},
"groupId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"contentId",
"groupId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"contentId",
"userId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"type": {
"type": "string",
"description": "Search for Resources whose Type matches the specified value. Valid values are 'File' and 'Folder'. | Type | Description | --------- | --------- | | File | | | Folder | |",
"enum": [
"File",
"Folder"
]
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId"
]
}
```
***
## blackboard\_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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"resourceId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"resourceId"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"resourceId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Search for Resources whose Type matches the specified value. Valid values are 'File' and 'Folder'. | Type | Description | --------- | --------- | | File | | | Folder | |",
"enum": [
"File",
"Folder"
]
},
"offset": {
"type": "integer",
"description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter."
},
"limit": {
"type": "integer",
"description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"resourceId"
]
}
```
***
## 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 \ 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the content to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether the content is currently available to students. Instructors can always access the content. If set to 'PartiallyVisible', the title will be available to students but the body will not. Defaults to Yes. | Type | Description | --------- | --------- | | Yes | | | No | | | PartiallyVisible | |",
"enum": [
"Yes",
"No",
"PartiallyVisible"
]
},
"allowGuests": {
"type": "boolean",
"description": "Whether this content is available to users with the 'guest' role. Defaults to true."
},
"adaptiveRelease": {
"type": "object",
"description": "Settings controlling adaptive release of the content to students."
}
}
},
"body": {
"type": "string",
"description": "The body text associated with this content. This field supports BbML; see here for more information."
},
"contentHandler": {
"type": "object",
"description": "Content Handler",
"properties": {
"id": {
"type": "string",
"description": "The content handler's ID. Publicly supported handlers: | ID | Documentation | Since | |------------------------------------|---------------------------------|-----------| | resource/x-bb-document | ContentItemTOPubV1 | 3000.1.0 | | resource/x-bb-externallink | ExternalLinkTOPubV1 | 3000.1.0 | | resource/x-bb-folder | ContentFolderTOPubV1 | 3000.1.0 | | resource/x-bb-courselink | CourseLinkTOPubV1 | 3100.5.0 | | resource/x-bb-forumlink | DiscussionLinkTOPubV1 | 3100.6.0 | | resource/x-bb-blti-link | BasicLTITOPubV1 | 3200.6.0 | | resource/x-bb-file | ContentFileTOPubV1 | 3200.6.0 | | resource/x-bb-asmt-test-link | TestLinkTOPubV1 | 3300.5.0 | | resource/x-bb-assignment | AssignmentTOPubV1 | 3400.9.0 | | resource/x-bb-blti-bltiplacement-* | BasicLTIPlacementContentTOPubV1 | 3600.0.0 | For handlers that are not publicly supported yet, their ID will be shown here, and updates to common content attributes are allowed, but extended handler-specific attributes will not be visible."
}
}
},
"description": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "Indicates whether the content is going to open in a new window. **Since**: 3800.10.0"
},
"parentId": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "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": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "The title or name of this content. Typically shown as the main text to click in the course outline when accessing the content."
}
},
"required": [
"PCID",
"courseId",
"contentId"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The user ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"reviewed": {
"type": "boolean",
"description": "The current status of the content's 'reviewed' attribute. **Since**: 3700.16.0"
}
},
"required": [
"PCID",
"courseId",
"contentId",
"userId"
]
}
```
***
## 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 \ 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"allowChildCourseContent": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the content to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether the content is currently available to students. Instructors can always access the content. If set to 'PartiallyVisible', the title will be available to students but the body will not. Defaults to Yes. | Type | Description | --------- | --------- | | Yes | | | No | | | PartiallyVisible | |",
"enum": [
"Yes",
"No",
"PartiallyVisible"
]
},
"allowGuests": {
"type": "boolean",
"description": "Whether this content is available to users with the 'guest' role. Defaults to true."
},
"adaptiveRelease": {
"type": "object",
"description": "Settings controlling adaptive release of the content to students."
}
}
},
"body": {
"type": "string",
"description": "The body text associated with this content. This field supports BbML; see here for more information."
},
"contentHandler": {
"type": "object",
"description": "Content Handler",
"properties": {
"id": {
"type": "string",
"description": "The content handler's ID. Publicly supported handlers: | ID | Documentation | Since | |------------------------------------|---------------------------------|-----------| | resource/x-bb-document | ContentItemTOPubV1 | 3000.1.0 | | resource/x-bb-externallink | ExternalLinkTOPubV1 | 3000.1.0 | | resource/x-bb-folder | ContentFolderTOPubV1 | 3000.1.0 | | resource/x-bb-courselink | CourseLinkTOPubV1 | 3100.5.0 | | resource/x-bb-forumlink | DiscussionLinkTOPubV1 | 3100.6.0 | | resource/x-bb-blti-link | BasicLTITOPubV1 | 3200.6.0 | | resource/x-bb-file | ContentFileTOPubV1 | 3200.6.0 | | resource/x-bb-asmt-test-link | TestLinkTOPubV1 | 3300.5.0 | | resource/x-bb-assignment | AssignmentTOPubV1 | 3400.9.0 | | resource/x-bb-blti-bltiplacement-* | BasicLTIPlacementContentTOPubV1 | 3600.0.0 | For handlers that are not publicly supported yet, their ID will be shown here, and updates to common content attributes are allowed, but extended handler-specific attributes will not be visible."
}
}
},
"description": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "Indicates whether the content is going to open in a new window. **Since**: 3800.10.0"
},
"parentId": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "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": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "The title or name of this content. Typically shown as the main text to click in the course outline when accessing the content."
}
},
"required": [
"PCID",
"courseId",
"title"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"title": {
"type": "string",
"description": "Title given to the adaptive release rule"
}
},
"required": [
"PCID",
"courseId",
"contentId",
"title"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "Rule Id"
},
"id": {
"type": "string",
"description": "Internal Identifier of the Rule's criteria."
},
"type": {
"type": "string",
"description": "The type value"
}
},
"required": [
"PCID",
"courseId",
"contentId",
"ruleId"
]
}
```
***
## 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "object",
"description": "Request body"
}
},
"required": [
"PCID",
"courseId",
"contentId",
"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 \ 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the content to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether the content is currently available to students. Instructors can always access the content. If set to 'PartiallyVisible', the title will be available to students but the body will not. Defaults to Yes. | Type | Description | --------- | --------- | | Yes | | | No | | | PartiallyVisible | |",
"enum": [
"Yes",
"No",
"PartiallyVisible"
]
},
"allowGuests": {
"type": "boolean",
"description": "Whether this content is available to users with the 'guest' role. Defaults to true."
},
"adaptiveRelease": {
"type": "object",
"description": "Settings controlling adaptive release of the content to students."
}
}
},
"body": {
"type": "string",
"description": "The body text associated with this content. This field supports BbML; see here for more information."
},
"contentHandler": {
"type": "object",
"description": "Content Handler",
"properties": {
"id": {
"type": "string",
"description": "The content handler's ID. Publicly supported handlers: | ID | Documentation | Since | |------------------------------------|---------------------------------|-----------| | resource/x-bb-document | ContentItemTOPubV1 | 3000.1.0 | | resource/x-bb-externallink | ExternalLinkTOPubV1 | 3000.1.0 | | resource/x-bb-folder | ContentFolderTOPubV1 | 3000.1.0 | | resource/x-bb-courselink | CourseLinkTOPubV1 | 3100.5.0 | | resource/x-bb-forumlink | DiscussionLinkTOPubV1 | 3100.6.0 | | resource/x-bb-blti-link | BasicLTITOPubV1 | 3200.6.0 | | resource/x-bb-file | ContentFileTOPubV1 | 3200.6.0 | | resource/x-bb-asmt-test-link | TestLinkTOPubV1 | 3300.5.0 | | resource/x-bb-assignment | AssignmentTOPubV1 | 3400.9.0 | | resource/x-bb-blti-bltiplacement-* | BasicLTIPlacementContentTOPubV1 | 3600.0.0 | For handlers that are not publicly supported yet, their ID will be shown here, and updates to common content attributes are allowed, but extended handler-specific attributes will not be visible."
}
}
},
"description": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "Indicates whether the content is going to open in a new window. **Since**: 3800.10.0"
},
"parentId": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "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": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "The title or name of this content. Typically shown as the main text to click in the course outline when accessing the content."
}
},
"required": [
"PCID",
"courseId",
"contentId",
"title"
]
}
```
***
## 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 \ 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"allowChildCourseContent": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "The availability value",
"properties": {
"available": {
"type": "string",
"description": "Whether the created assignment is available to students. Instructors can always access the created assignment. If set to 'PartiallyVisible', the title will be available to students but the body will not. Defaults to Yes. | Type | Description | --------- | --------- | | Yes | | | No | | | PartiallyVisible | |",
"enum": [
"Yes",
"No",
"PartiallyVisible"
]
},
"allowGuests": {
"type": "boolean",
"description": "Whether the created assignment is available to users with the 'guest' role. Defaults to true."
},
"adaptiveRelease": {
"type": "object",
"description": "Settings controlling adaptive release of created assignment to students."
}
}
},
"description": {
"type": "string",
"description": "The description to use when creating the assignment content."
},
"fileUploadIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "File Upload Ids"
},
"grading": {
"type": "object",
"description": "The grading value",
"properties": {
"due": {
"type": "string",
"description": "Date and time that the created assignment will be due. If not specified, this will default to the specified \"availability.adaptiveRelease.end\" date. If that is also not specified, due date defaults to null."
},
"attemptsAllowed": {
"type": "integer",
"description": "The number of attempts allowed on the created assignment. Defaults to 1. Maximum allowed is 10 for an Ultra Assignment. Value will be ignored if isUnlimitedAttemptsAllowed is set to true."
},
"gradeSchemaId": {
"type": "string",
"description": "The grading schema to use for the created assignment. Defaults to Score."
},
"isUnlimitedAttemptsAllowed": {
"type": "boolean",
"description": "Determines if the assignment has unlimited number of attempts. **Since**: 3400.8.0"
}
}
},
"instructions": {
"type": "string",
"description": "The text instructions to use when creating the assignment content. This field supports BbML; see here for more information."
},
"originalityReportingTool": {
"type": "object",
"description": "Originality Reporting Tool",
"properties": {
"id": {
"type": "string",
"description": "The Originality Reporting Tools handler id."
}
}
},
"parentId": {
"type": "string",
"description": "The id of the parent content for the created assignment."
},
"position": {
"type": "integer",
"description": "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": {
"type": "object",
"description": "The score value",
"properties": {
"possible": {
"type": "number",
"description": "The number of points possible for the created assignment. Defaults to 100."
}
}
},
"title": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"courseId",
"title"
]
}
```
***
## 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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"courseId": {
"type": "string",
"description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"contentId": {
"type": "string",
"description": "Content Id"
},
"groupId": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
}
},
"required": [
"PCID",
"courseId",
"contentId",
"groupId"
]
}
```