/blackboard-courses | Type: Application | PCID required: Yes
Tools
blackboard_courses_delete_learn_api_public_catalog_categories_by_categorytype_by_categoryid
Delete Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryType | string | Yes | — | Category Type |
categoryId | string | Yes | — | Category Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryType": {
"type": "string",
"description": "Category Type",
"enum": [
"Course",
"Organization"
]
},
"categoryId": {
"type": "string",
"description": "Category Id"
}
},
"required": [
"PCID",
"categoryType",
"categoryId"
]
}
blackboard_courses_delete_learn_api_public_catalog_categories_by_categorytype_by_categoryid_courses_by_courseid
Delete Membership Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryType | string | Yes | — | Category Type |
categoryId | string | Yes | — | Category Id |
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 | |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryType": {
"type": "string",
"description": "Category Type",
"enum": [
"Course",
"Organization"
]
},
"categoryId": {
"type": "string",
"description": "Category Id"
},
"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 |"
}
},
"required": [
"PCID",
"categoryType",
"categoryId",
"courseId"
]
}
blackboard_courses_delete_learn_api_public_courses_by_courseid
Delete Course 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 | |
removeFiles | boolean | No | — | Whether to delete course files. Defaults to true. |
Show inputSchema
Show inputSchema
{
"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 |"
},
"removeFiles": {
"type": "boolean",
"description": "Whether to delete course files. Defaults to true."
}
},
"required": [
"PCID",
"courseId"
]
}
blackboard_courses_delete_learn_api_public_courses_by_courseid_announcements_by_announcementid
Delete Announcement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
announcementId | string | Yes | — | Announcement Id |
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"announcementId": {
"type": "string",
"description": "Announcement Id"
},
"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."
}
},
"required": [
"PCID",
"announcementId",
"courseId"
]
}
blackboard_courses_delete_learn_api_public_courses_by_courseid_children_by_childcourseid
Remove Child Course 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 | |
childCourseId | 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 | |
separationStyle | string | No | — | The method by which the courses will be separated. Default: CompleteSeparation Since: 3900.4.0 | Type | Description | --------- | --------- | | completeSeparation | Re-enable the child course with enrollments and remove all the child enrollments from the master course. | | enrollmentsInBoth | Re-enable the child course with enrollments but leave all the child enrollments in the master course as well, marking them as unavailable. | |
Show inputSchema
Show inputSchema
{
"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 |"
},
"childCourseId": {
"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 |"
},
"separationStyle": {
"type": "string",
"description": "The method by which the courses will be separated. Default: CompleteSeparation **Since**: 3900.4.0 | Type | Description | --------- | --------- | | completeSeparation | Re-enable the child course with enrollments and remove all the child enrollments from the master course. | | enrollmentsInBoth | Re-enable the child course with enrollments but leave all the child enrollments in the master course as well, marking them as unavailable. |",
"enum": [
"completeSeparation",
"enrollmentsInBoth"
]
}
},
"required": [
"PCID",
"courseId",
"childCourseId"
]
}
blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype
Get Categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryType | string | Yes | — | Category Type |
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),start” Supported fields are: - id - categoryId - title - available - created Since: 3700.6.0 |
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. |
title | string | No | — | Search for categories with titles that contain this value. Since: 3700.8.0 |
categoryId | string | No | — | Search for categories with category IDs that contain this value. Since: 3700.8.0 |
created | string | No | — | Search for categories with a created date relative to this value. Since: 3700.8.0 |
createdCompare | string | No | — | Used alongside the ‘created’ search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. Since: 3700.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
dataSourceId | string | No | — | Search for categories with a data source id matching this value. Since: 3700.9.0 |
frontPage | boolean | No | — | Search for categories with a front page indicator matching this value. Since: 3700.9.0 |
available | boolean | No | — | Search for categories with availability matching this value. Since: 3700.9.0 |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryType": {
"type": "string",
"description": "Category Type",
"enum": [
"Course",
"Organization"
]
},
"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),start\" Supported fields are: - id - categoryId - title - available - created **Since**: 3700.6.0"
},
"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."
},
"title": {
"type": "string",
"description": "Search for categories with titles that contain this value. **Since**: 3700.8.0"
},
"categoryId": {
"type": "string",
"description": "Search for categories with category IDs that contain this value. **Since**: 3700.8.0"
},
"created": {
"type": "string",
"description": "Search for categories with a created date relative to this value. **Since**: 3700.8.0"
},
"createdCompare": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"dataSourceId": {
"type": "string",
"description": "Search for categories with a data source id matching this value. **Since**: 3700.9.0"
},
"frontPage": {
"type": "boolean",
"description": "Search for categories with a front page indicator matching this value. **Since**: 3700.9.0"
},
"available": {
"type": "boolean",
"description": "Search for categories with availability matching this value. **Since**: 3700.9.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",
"categoryType"
]
}
blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype_by_categoryid
Get Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryType | string | Yes | — | Category Type |
categoryId | string | Yes | — | Category Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryType": {
"type": "string",
"description": "Category Type",
"enum": [
"Course",
"Organization"
]
},
"categoryId": {
"type": "string",
"description": "Category 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",
"categoryType",
"categoryId"
]
}
blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype_by_categoryid_courses
Get Memberships Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryType | string | Yes | — | Category Type |
categoryId | string | Yes | — | Category 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. |
expand | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:<br><ul><li>course</li></ul> |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryType": {
"type": "string",
"description": "Category Type",
"enum": [
"Course",
"Organization"
]
},
"categoryId": {
"type": "string",
"description": "Category 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."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:<br><ul><li>course</li></ul>"
}
},
"required": [
"PCID",
"categoryType",
"categoryId"
]
}
blackboard_courses_get_learn_api_public_catalog_categories_by_categorytype_by_parentid_children
Get Child Categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryType | string | Yes | — | Category Type |
parentId | string | Yes | — | Parent 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),start” Supported fields are: - id - categoryId - title - available - created Since: 3700.6.0 |
title | string | No | — | Search for categories with titles that contain this value. Since: 3700.8.0 |
categoryId | string | No | — | Search for categories with category IDs that contain this value. Since: 3700.8.0 |
created | string | No | — | Search for categories with a created date relative to this value. Since: 3700.8.0 |
createdCompare | string | No | — | Used alongside the ‘created’ search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. Since: 3700.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
dataSourceId | string | No | — | Search for categories with a data source id matching this value. Since: 3700.9.0 |
frontPage | boolean | No | — | Search for categories with a front page indicator matching this value. Since: 3700.9.0 |
available | boolean | No | — | Search for categories with availability matching this value. Since: 3700.9.0 |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryType": {
"type": "string",
"description": "Category Type",
"enum": [
"Course",
"Organization"
]
},
"parentId": {
"type": "string",
"description": "Parent 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),start\" Supported fields are: - id - categoryId - title - available - created **Since**: 3700.6.0"
},
"title": {
"type": "string",
"description": "Search for categories with titles that contain this value. **Since**: 3700.8.0"
},
"categoryId": {
"type": "string",
"description": "Search for categories with category IDs that contain this value. **Since**: 3700.8.0"
},
"created": {
"type": "string",
"description": "Search for categories with a created date relative to this value. **Since**: 3700.8.0"
},
"createdCompare": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Supported values: - lessThan - greaterOrEqual Defaults to greaterOrEqual if not specified. **Since**: 3700.8.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"dataSourceId": {
"type": "string",
"description": "Search for categories with a data source id matching this value. **Since**: 3700.9.0"
},
"frontPage": {
"type": "boolean",
"description": "Search for categories with a front page indicator matching this value. **Since**: 3700.9.0"
},
"available": {
"type": "boolean",
"description": "Search for categories with availability matching this value. **Since**: 3700.9.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",
"categoryType",
"parentId"
]
}
blackboard_courses_get_learn_api_public_courses
Get Courses Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
modified | string | No | — | Search for courses with a modified date relative to this value. ‘modifiedCompare’ may also be sent to control search behavior. Since: 3500.4.0 |
modifiedCompare | string | No | — | Used alongside the ‘modified’ search parameter. Defaults to greaterOrEqual if not specified. Since: 3500.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
courseId | string | No | — | Search for courses with courseId properties that contain this value. Since: 3100.0.0 |
name | string | No | — | Search for courses with name properties that contain this value. Since: 3100.0.0 |
description | string | No | — | Search for courses with description properties that contain this value. Since: 3100.0.0 |
externalId | string | No | — | Search for courses with externalId properties that contain this value. Since: 3100.0.0 |
created | string | No | — | Search for courses with a created date relative to this value. ‘createdCompare’ may also be sent to control search behavior. Since: 3100.0.0 |
allowGuests | boolean | No | — | Search for courses which are configured to allow/disallow guest access, based on input. Default: n/a (return courses regardless of guests allowed) Since: 3200.3.0 |
createdCompare | string | No | — | Used alongside the ‘created’ search parameter. Defaults to greaterOrEqual if not specified. Since: 3100.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
availability.available | string | No | — | Search for courses with availability.available properties that contain this value. Since: 3000.13.0 | Type | Description | --------- | --------- | | Yes | Students may access the course. | | No | Students may not access the course. | | Disabled | Disabled by the SIS. Students may not access the course. Since: 3100.0.0 | | Term | Availability is inherited from the term settings. Requires a termId be set. | |
dataSourceId | string | No | — | Search for courses with this dataSourceId. This may optionally be the data source’s externalId using the syntax “externalId:math101”. Since: 3100.0.0 |
termId | string | No | — | Search for courses with this termId. This may optionally be the term’s externalId using the syntax “externalId:spring2015”. Since: 3100.0.0 |
organization | boolean | No | — | Search for courses by organization flag. A value of ‘true’ indicates that search results should be limited to only Organizations. A value of ‘false’ indicates results should be limited to Courses. Not setting this field indicates that both Courses and Organizations should be returned. Since: 3100.0.0 |
sort | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional “(desc)” suffix to request a descending sort for that property. e.g. “name(desc),created” Supported fields are: - courseId - name - externalId - created - modified Since: 3400.8.0 |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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."
},
"modified": {
"type": "string",
"description": "Search for courses with a modified date relative to this value. 'modifiedCompare' may also be sent to control search behavior. **Since**: 3500.4.0"
},
"modifiedCompare": {
"type": "string",
"description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3500.4.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"courseId": {
"type": "string",
"description": "Search for courses with courseId properties that contain this value. **Since**: 3100.0.0"
},
"name": {
"type": "string",
"description": "Search for courses with name properties that contain this value. **Since**: 3100.0.0"
},
"description": {
"type": "string",
"description": "Search for courses with description properties that contain this value. **Since**: 3100.0.0"
},
"externalId": {
"type": "string",
"description": "Search for courses with externalId properties that contain this value. **Since**: 3100.0.0"
},
"created": {
"type": "string",
"description": "Search for courses with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3100.0.0"
},
"allowGuests": {
"type": "boolean",
"description": "Search for courses which are configured to allow/disallow guest access, based on input. Default: n/a (return courses regardless of guests allowed) **Since**: 3200.3.0"
},
"createdCompare": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. **Since**: 3100.0.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"availability.available": {
"type": "string",
"description": "Search for courses with availability.available properties that contain this value. **Since**: 3000.13.0 | Type | Description | --------- | --------- | | Yes | Students may access the course. | | No | Students may not access the course. | | Disabled | Disabled by the SIS. Students may not access the course. **Since**: 3100.0.0 | | Term | Availability is inherited from the term settings. Requires a termId be set. |",
"enum": [
"Yes",
"No",
"Disabled",
"Term"
]
},
"dataSourceId": {
"type": "string",
"description": "Search for courses with this dataSourceId. This may optionally be the data source's externalId using the syntax \"externalId:math101\". **Since**: 3100.0.0"
},
"termId": {
"type": "string",
"description": "Search for courses with this termId. This may optionally be the term's externalId using the syntax \"externalId:spring2015\". **Since**: 3100.0.0"
},
"organization": {
"type": "boolean",
"description": "Search for courses by organization flag. A value of 'true' indicates that search results should be limited to only Organizations. A value of 'false' indicates results should be limited to Courses. Not setting this field indicates that both Courses and Organizations should be returned. **Since**: 3100.0.0"
},
"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. \"name(desc),created\" Supported fields are: - courseId - name - externalId - created - modified **Since**: 3400.8.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"
]
}
blackboard_courses_get_learn_api_public_courses_by_courseid
Get Course 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"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 |"
},
"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_courses_get_learn_api_public_courses_by_courseid_announcements
Get Announcements Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. |
limit | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. |
created | string | No | — | Search for announcements with a created date relative to this value. ‘createdCompare’ may also be sent to control search behavior. Since: 3500.3.0 |
createdCompare | string | No | — | Used alongside the ‘created’ search parameter. Defaults to greaterOrEqual if not specified. ‘lessThan’ also an accepted value. Since: 3500.3.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
modified | string | No | — | Search for announcements with a modified date relative to this value. ‘createdCompare’ may also be sent to control search behavior. Since: 3500.3.0 |
modifiedCompare | string | No | — | Used alongside the ‘modified’ search parameter. Defaults to greaterOrEqual if not specified. ‘lessThan’ also an accepted value. Since: 3500.3.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | | |
title | string | No | — | Search for announcements with a title like the provided value. Since: 3500.3.0 |
sort | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional “(desc)” suffix to request a descending sort for that property. e.g. “title(desc),created” Supported fields are: - title - modified Since: 3500.3.0 |
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"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."
},
"created": {
"type": "string",
"description": "Search for announcements with a created date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3500.3.0"
},
"createdCompare": {
"type": "string",
"description": "Used alongside the 'created' search parameter. Defaults to greaterOrEqual if not specified. 'lessThan' also an accepted value. **Since**: 3500.3.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"modified": {
"type": "string",
"description": "Search for announcements with a modified date relative to this value. 'createdCompare' may also be sent to control search behavior. **Since**: 3500.3.0"
},
"modifiedCompare": {
"type": "string",
"description": "Used alongside the 'modified' search parameter. Defaults to greaterOrEqual if not specified. 'lessThan' also an accepted value. **Since**: 3500.3.0 | Type | Description | --------- | --------- | | lessThan | | | greaterOrEqual | |",
"enum": [
"lessThan",
"greaterOrEqual"
]
},
"title": {
"type": "string",
"description": "Search for announcements with a title like the provided value. **Since**: 3500.3.0"
},
"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),created\" Supported fields are: - title - modified **Since**: 3500.3.0"
},
"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."
}
},
"required": [
"PCID",
"courseId"
]
}
blackboard_courses_get_learn_api_public_courses_by_courseid_announcements_by_announcementid
Get Announcement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
announcementId | string | Yes | — | Announcement Id |
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"announcementId": {
"type": "string",
"description": "Announcement Id"
},
"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."
}
},
"required": [
"PCID",
"announcementId",
"courseId"
]
}
blackboard_courses_get_learn_api_public_courses_by_courseid_categories
Get Memberships 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. |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
expand | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:<br><ul><li>category</li></ul> |
Show inputSchema
Show inputSchema
{
"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."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:<br><ul><li>category</li></ul>"
}
},
"required": [
"PCID",
"courseId"
]
}
blackboard_courses_get_learn_api_public_courses_by_courseid_children
Get Course 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 | |
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. |
expand | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:<br><ul><li>childCourse</li></ul> |
Show inputSchema
Show inputSchema
{
"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."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:<br><ul><li>childCourse</li></ul>"
}
},
"required": [
"PCID",
"courseId"
]
}
blackboard_courses_get_learn_api_public_courses_by_courseid_children_by_childcourseid
Get 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 | |
childCourseId | 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. |
expand | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:<br><ul><li>childCourse</li></ul> |
Show inputSchema
Show inputSchema
{
"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 |"
},
"childCourseId": {
"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."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:<br><ul><li>childCourse</li></ul>"
}
},
"required": [
"PCID",
"courseId",
"childCourseId"
]
}
blackboard_courses_get_learn_api_public_courses_by_courseid_crosslistset
Get Cross List Set 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. |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"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."
},
"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_courses_get_learn_api_public_courses_by_courseid_tasks_by_taskid
Get Task 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 | |
taskId | string | Yes | — | Task Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"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 |"
},
"taskId": {
"type": "string",
"description": "Task 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",
"taskId"
]
}
blackboard_courses_patch_learn_api_public_catalog_categories_by_categorytype_by_categoryid
Update Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryType | string | Yes | — | Category Type |
categoryId | string | Yes | — | Category Id |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
available | boolean | No | — | Boolean indicating whether or not the category is available |
description | string | No | — | The description of the category |
frontPage | boolean | No | — | Boolean indicating whether or not the category should appear on the catalog front page |
institutionRoleIds | string[] | No | — | The roles for which this category is available, if category is set to restricted. Not populated for lists of categories, only for individual category |
restricted | boolean | No | — | Boolean indicating whether or not category is available to all roles, or restricted to a specific set of roles. |
title | string | No | — | The title of category |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryType": {
"type": "string",
"description": "Category Type",
"enum": [
"Course",
"Organization"
]
},
"categoryId": {
"type": "string",
"description": "Category Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"available": {
"type": "boolean",
"description": "Boolean indicating whether or not the category is available"
},
"description": {
"type": "string",
"description": "The description of the category"
},
"frontPage": {
"type": "boolean",
"description": "Boolean indicating whether or not the category should appear on the catalog front page"
},
"institutionRoleIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The roles for which this category is available, if category is set to restricted. Not populated for lists of categories, only for individual category"
},
"restricted": {
"type": "boolean",
"description": "Boolean indicating whether or not category is available to all roles, or restricted to a specific set of roles."
},
"title": {
"type": "string",
"description": "The title of category"
}
},
"required": [
"PCID",
"categoryType",
"categoryId"
]
}
blackboard_courses_patch_learn_api_public_courses_by_courseid
Update Course 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 | |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
allowGuests | boolean | No | — | Whether guests (users with the role guest) are allowed access to the course. Defaults to true. |
availability | object | No | — | Settings controlling availability of the course to students. |
closedComplete | boolean | No | — | This status does not affect availability of the course for viewing in any way. closedComplete is valid for both Ultra and Classic courses. If an Ultra course is in closedComplete mode, updates are not possible. For a Classic course in closedComplete mode, updates are still possible (through Web UI but not through REST i.e. closed is enforced for original courses when updated through REST the same way Ultra courses are blocked) but new notifications are not generated. |
dataSourceId | string | No | — | The ID of the data source associated with this course. This may optionally be the data source’s externalId using the syntax “externalId:math101”. |
description | string | No | — | The description of the course. |
enrollment | object | No | — | Settings controlling how students may enroll in the course. |
externalId | string | No | — | An optional externally-defined unique ID for the course. Defaults to the courseId. Formerly known as ‘batchUid’. |
locale | object | No | — | Settings controlling localization within the course. |
name | string | No | — | The name of the course. |
termId | string | No | — | The ID of the term associated to this course. This may optionally be the term’s externalId using the syntax “externalId:spring.2016”. |
Show inputSchema
Show inputSchema
{
"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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"allowGuests": {
"type": "boolean",
"description": "Whether guests (users with the role guest) are allowed access to the course. Defaults to true."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the course to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether the course is currently available to students. Instructors can always access the course if they have 'Access unavailable course' entitlement. If set to 'Term', the course's parent term availability settings will be used. | Type | Description | --------- | --------- | | Yes | Students may access the course. | | No | Students may not access the course. | | Disabled | Disabled by the SIS. Students may not access the course. @since 3100.0.0 | | Term | Availability is inherited from the term settings. Requires a termId be set. |",
"enum": [
"Yes",
"No",
"Disabled",
"Term"
]
},
"duration": {
"type": "object",
"description": "Settings controlling the length of time the course is available."
}
}
},
"closedComplete": {
"type": "boolean",
"description": "This status does not affect availability of the course for viewing in any way. closedComplete is valid for both Ultra and Classic courses. If an Ultra course is in closedComplete mode, updates are not possible. For a Classic course in closedComplete mode, updates are still possible (through Web UI but not through REST i.e. closed is enforced for original courses when updated through REST the same way Ultra courses are blocked) but new notifications are not generated."
},
"dataSourceId": {
"type": "string",
"description": "The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax \"externalId:math101\"."
},
"description": {
"type": "string",
"description": "The description of the course."
},
"enrollment": {
"type": "object",
"description": "Settings controlling how students may enroll in the course.",
"properties": {
"type": {
"type": "string",
"description": "Specifies the enrollment options for the course. Defaults to InstructorLed. | Type | Description | --------- | --------- | | InstructorLed | Enrollment tasks for the course can only performed by the instructor | | SelfEnrollment | Instructors have the ability to enroll users, and students can also enroll themselves in the course | | EmailEnrollment | Instructors have the ability to enroll users, and students can email requests to the instructor for enrollment |",
"enum": [
"InstructorLed",
"SelfEnrollment",
"EmailEnrollment"
]
},
"start": {
"type": "string",
"description": "The date on which enrollments are allowed for the course. May only be set if enrollment.type is SelfEnrollment."
},
"end": {
"type": "string",
"description": "The date on which enrollment in this course ends. May only be set if enrollment.type is SelfEnrollment."
},
"accessCode": {
"type": "string",
"description": "The enrollment access code associated with this course. May only be set if enrollment.type is SelfEnrollment."
}
}
},
"externalId": {
"type": "string",
"description": "An optional externally-defined unique ID for the course. Defaults to the courseId. Formerly known as 'batchUid'."
},
"locale": {
"type": "object",
"description": "Settings controlling localization within the course.",
"properties": {
"id": {
"type": "string",
"description": "The locale of this course."
},
"force": {
"type": "boolean",
"description": "Whether students are forced to use the course's specified locale."
}
}
},
"name": {
"type": "string",
"description": "The name of the course."
},
"termId": {
"type": "string",
"description": "The ID of the term associated to this course. This may optionally be the term's externalId using the syntax \"externalId:spring.2016\"."
}
},
"required": [
"PCID",
"courseId"
]
}
blackboard_courses_patch_learn_api_public_courses_by_courseid_announcements_by_announcementid
Update Announcement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
announcementId | string | Yes | — | Announcement Id |
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 | — | Settings controlling availability of the course to students. |
body | string | No | — | The message body of the Announcement. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’>here</a> for more information. |
draft | boolean | No | — | An indication of whether or not the Announcement is in draft status. |
title | string | No | — | The title of this Announcement. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"announcementId": {
"type": "string",
"description": "Announcement Id"
},
"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": "Settings controlling availability of the course to students.",
"properties": {
"duration": {
"type": "object",
"description": "Duration indicates when the System Announcement is Available based on whether it is Permanent or if the date/time of the request falls within its Start & End dates."
}
}
},
"body": {
"type": "string",
"description": "The message body of the Announcement. This field supports BbML; see <a target='_blank' href='https://docs.blackboard.com/learn/rest/advanced/bbml.html'>here</a> for more information."
},
"draft": {
"type": "boolean",
"description": "An indication of whether or not the Announcement is in draft status."
},
"title": {
"type": "string",
"description": "The title of this Announcement."
}
},
"required": [
"PCID",
"announcementId",
"courseId"
]
}
blackboard_courses_post_learn_api_public_catalog_categories_by_categorytype
Create Category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryType | string | Yes | — | Category Type |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
available | boolean | Yes | — | Boolean indicating whether or not the category is available |
categoryId | string | Yes | — | The human-readable id of the category |
description | string | No | — | The description of the category |
frontPage | boolean | No | — | Boolean indicating whether or not the category should appear on the catalog front page |
institutionRoleIds | string[] | No | — | The roles for which this category is available, if category is set to restricted. Not populated for lists of categories, only for individual category |
parentId | string | No | — | The ID of this category’s parent category |
restricted | boolean | No | — | Boolean indicating whether or not category is available to all roles, or restricted to a specific set of roles. |
title | string | Yes | — | The title of category |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryType": {
"type": "string",
"description": "Category Type",
"enum": [
"Course",
"Organization"
]
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"available": {
"type": "boolean",
"description": "Boolean indicating whether or not the category is available"
},
"categoryId": {
"type": "string",
"description": "The human-readable id of the category"
},
"description": {
"type": "string",
"description": "The description of the category"
},
"frontPage": {
"type": "boolean",
"description": "Boolean indicating whether or not the category should appear on the catalog front page"
},
"institutionRoleIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The roles for which this category is available, if category is set to restricted. Not populated for lists of categories, only for individual category"
},
"parentId": {
"type": "string",
"description": "The ID of this category's parent category"
},
"restricted": {
"type": "boolean",
"description": "Boolean indicating whether or not category is available to all roles, or restricted to a specific set of roles."
},
"title": {
"type": "string",
"description": "The title of category"
}
},
"required": [
"PCID",
"categoryType",
"available",
"categoryId",
"title"
]
}
blackboard_courses_post_learn_api_public_courses
Create Course Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
allowGuests | boolean | No | — | Whether guests (users with the role guest) are allowed access to the course. Defaults to true. |
availability | object | No | — | Settings controlling availability of the course to students. |
closedComplete | boolean | No | — | This status does not affect availability of the course for viewing in any way. closedComplete is valid for both Ultra and Classic courses. If an Ultra course is in closedComplete mode, updates are not possible. For a Classic course in closedComplete mode, updates are still possible (through Web UI but not through REST i.e. closed is enforced for original courses when updated through REST the same way Ultra courses are blocked) but new notifications are not generated. |
courseId | string | Yes | — | The Course ID attribute, shown to users in the UI. |
dataSourceId | string | No | — | The ID of the data source associated with this course. This may optionally be the data source’s externalId using the syntax “externalId:math101”. |
description | string | No | — | The description of the course. |
enrollment | object | No | — | Settings controlling how students may enroll in the course. |
externalId | string | No | — | An optional externally-defined unique ID for the course. Defaults to the courseId. Formerly known as ‘batchUid’. |
locale | object | No | — | Settings controlling localization within the course. |
name | string | Yes | — | The name of the course. |
organization | boolean | No | — | Whether this object represents an Organization. Defaults to false. |
termId | string | No | — | The ID of the term associated to this course. This may optionally be the term’s externalId using the syntax “externalId:spring.2016”. |
ultraStatus | string | No | — | Whether the course is rendered using Classic or Ultra Course View. | Type | Description | --------- | --------- | | Undecided | The ultra status is not decided. | | Classic | The course is decided as classic. | | Ultra | The course is decided as ultra | | UltraPreview | The course is currently in Ultra mode but during the preview state where it may still be reverted via a Restore to the classic state | |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"allowGuests": {
"type": "boolean",
"description": "Whether guests (users with the role guest) are allowed access to the course. Defaults to true."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the course to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether the course is currently available to students. Instructors can always access the course if they have 'Access unavailable course' entitlement. If set to 'Term', the course's parent term availability settings will be used. | Type | Description | --------- | --------- | | Yes | Students may access the course. | | No | Students may not access the course. | | Disabled | Disabled by the SIS. Students may not access the course. @since 3100.0.0 | | Term | Availability is inherited from the term settings. Requires a termId be set. |",
"enum": [
"Yes",
"No",
"Disabled",
"Term"
]
},
"duration": {
"type": "object",
"description": "Settings controlling the length of time the course is available."
}
}
},
"closedComplete": {
"type": "boolean",
"description": "This status does not affect availability of the course for viewing in any way. closedComplete is valid for both Ultra and Classic courses. If an Ultra course is in closedComplete mode, updates are not possible. For a Classic course in closedComplete mode, updates are still possible (through Web UI but not through REST i.e. closed is enforced for original courses when updated through REST the same way Ultra courses are blocked) but new notifications are not generated."
},
"courseId": {
"type": "string",
"description": "The Course ID attribute, shown to users in the UI."
},
"dataSourceId": {
"type": "string",
"description": "The ID of the data source associated with this course. This may optionally be the data source's externalId using the syntax \"externalId:math101\"."
},
"description": {
"type": "string",
"description": "The description of the course."
},
"enrollment": {
"type": "object",
"description": "Settings controlling how students may enroll in the course.",
"properties": {
"type": {
"type": "string",
"description": "Specifies the enrollment options for the course. Defaults to InstructorLed. | Type | Description | --------- | --------- | | InstructorLed | Enrollment tasks for the course can only performed by the instructor | | SelfEnrollment | Instructors have the ability to enroll users, and students can also enroll themselves in the course | | EmailEnrollment | Instructors have the ability to enroll users, and students can email requests to the instructor for enrollment |",
"enum": [
"InstructorLed",
"SelfEnrollment",
"EmailEnrollment"
]
},
"start": {
"type": "string",
"description": "The date on which enrollments are allowed for the course. May only be set if enrollment.type is SelfEnrollment."
},
"end": {
"type": "string",
"description": "The date on which enrollment in this course ends. May only be set if enrollment.type is SelfEnrollment."
},
"accessCode": {
"type": "string",
"description": "The enrollment access code associated with this course. May only be set if enrollment.type is SelfEnrollment."
}
}
},
"externalId": {
"type": "string",
"description": "An optional externally-defined unique ID for the course. Defaults to the courseId. Formerly known as 'batchUid'."
},
"locale": {
"type": "object",
"description": "Settings controlling localization within the course.",
"properties": {
"id": {
"type": "string",
"description": "The locale of this course."
},
"force": {
"type": "boolean",
"description": "Whether students are forced to use the course's specified locale."
}
}
},
"name": {
"type": "string",
"description": "The name of the course."
},
"organization": {
"type": "boolean",
"description": "Whether this object represents an Organization. Defaults to false."
},
"termId": {
"type": "string",
"description": "The ID of the term associated to this course. This may optionally be the term's externalId using the syntax \"externalId:spring.2016\"."
},
"ultraStatus": {
"type": "string",
"description": "Whether the course is rendered using Classic or Ultra Course View. | Type | Description | --------- | --------- | | Undecided | The ultra status is not decided. | | Classic | The course is decided as classic. | | Ultra | The course is decided as ultra | | UltraPreview | The course is currently in Ultra mode but during the preview state where it may still be reverted via a Restore to the classic state |",
"enum": [
"Undecided",
"Classic",
"Ultra",
"UltraPreview"
]
}
},
"required": [
"PCID",
"courseId",
"name"
]
}
blackboard_courses_post_learn_api_public_courses_by_courseid_announcements
Create Announcement 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 | |
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 course to students. |
body | string | No | — | The message body of the Announcement. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’>here</a> for more information. |
draft | boolean | No | — | An indication of whether or not the Announcement is in draft status. |
title | string | Yes | — | The title of this Announcement. |
Show inputSchema
Show inputSchema
{
"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 |"
},
"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 course to students.",
"properties": {
"duration": {
"type": "object",
"description": "Duration indicates when the System Announcement is Available based on whether it is Permanent or if the date/time of the request falls within its Start & End dates."
}
}
},
"body": {
"type": "string",
"description": "The message body of the Announcement. This field supports BbML; see <a target='_blank' href='https://docs.blackboard.com/learn/rest/advanced/bbml.html'>here</a> for more information."
},
"draft": {
"type": "boolean",
"description": "An indication of whether or not the Announcement is in draft status."
},
"title": {
"type": "string",
"description": "The title of this Announcement."
}
},
"required": [
"PCID",
"courseId",
"title"
]
}
blackboard_courses_post_learn_api_public_courses_by_courseid_copy
Copy Course 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 | |
copy | object | No | — | The options which will be used when copying the specified course |
targetCourse | object | Yes | — | The destination course to copy into. This can be either a new course, defined by the courseId field, or an existing course, defined by the id field. |
Show inputSchema
Show inputSchema
{
"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 |"
},
"copy": {
"type": "object",
"description": "The options which will be used when copying the specified course",
"properties": {
"adaptiveReleaseRules": {
"type": "boolean",
"description": "Represents whether or not the adaptive release rules will be copied."
},
"announcements": {
"type": "boolean",
"description": "Represents whether or not the announcements will be copied."
},
"assessments": {
"type": "boolean",
"description": "Represents whether or not the assessments will be copied."
},
"blogs": {
"type": "boolean",
"description": "Represents whether or not the blogs will be copied."
},
"calendar": {
"type": "boolean",
"description": "Represents whether or not the calendar will be copied."
},
"contacts": {
"type": "boolean",
"description": "Represents whether or not the contacts information will be copied."
},
"contentAlignments": {
"type": "boolean",
"description": "Represents whether or not the content alignments will be copied."
},
"contentAreas": {
"type": "boolean",
"description": "Represents whether or not the content areas will be copied."
},
"discussions": {
"type": "string",
"description": "Represents whether and how to copy the discussion forum | Type | Description | --------- | --------- | | None | Discussion board will not be copied | | ForumsAndStarterPosts | Discussion board with Formus and starter posts will be copied | | ForumsOnly | Discussion board with only forums will be copied |",
"enum": [
"None",
"ForumsAndStarterPosts",
"ForumsOnly"
]
},
"glossary": {
"type": "boolean",
"description": "Represents whether or not the glossary will be copied."
},
"gradebook": {
"type": "boolean",
"description": "Represents whether or not the grade book, columns and settings will be copied."
},
"groupSettings": {
"type": "boolean",
"description": "Represents whether or not the group settings will be copied."
},
"journals": {
"type": "boolean",
"description": "Represents whether or not the journals will be copied."
},
"retentionRules": {
"type": "boolean",
"description": "Represents whether or not the retention rules will be copied."
},
"rubrics": {
"type": "boolean",
"description": "Represents whether or not the rubrics will be copied."
},
"settings": {
"type": "object",
"description": "The course settings to be copied"
},
"tasks": {
"type": "boolean",
"description": "Represents whether or not the tasks will be copied."
},
"wikis": {
"type": "boolean",
"description": "Represents whether or not the wikis will be copied."
}
}
},
"targetCourse": {
"type": "object",
"description": "The destination course to copy into. This can be either a new course, defined by the courseId field, or an existing course, defined by the id field.",
"properties": {
"courseId": {
"type": "string",
"description": "The CourseId that will represent the new course."
},
"id": {
"type": "object",
"description": "The id value"
}
}
}
},
"required": [
"PCID",
"courseId",
"targetCourse"
]
}
blackboard_courses_put_learn_api_public_catalog_categories_by_categorytype_by_categoryid_courses_by_courseid
Create Membership Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryType | string | Yes | — | Category Type |
categoryId | string | Yes | — | Category Id |
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"categoryType": {
"type": "string",
"description": "Category Type",
"enum": [
"Course",
"Organization"
]
},
"categoryId": {
"type": "string",
"description": "Category Id"
},
"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."
}
},
"required": [
"PCID",
"categoryType",
"categoryId",
"courseId"
]
}
blackboard_courses_put_learn_api_public_courses_by_courseid_children_by_childcourseid
Add Child Course 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 | |
childCourseId | 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 | |
ignoreEnrollmentErrors | boolean | No | — | By default, enrollment errors encountered during a course merge will result in a 409 CONFLICT response. The ignoreEnrollmentErrors parameter can be sent as true in order to bypass enrollment errors. |
fields | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
Show inputSchema
Show inputSchema
{
"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 |"
},
"childCourseId": {
"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 |"
},
"ignoreEnrollmentErrors": {
"type": "boolean",
"description": "By default, enrollment errors encountered during a course merge will result in a 409 CONFLICT response. The ignoreEnrollmentErrors parameter can be sent as true in order to bypass enrollment errors."
},
"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",
"childCourseId"
]
}