/blackboard-communication | Type: Application | PCID required: Yes
Tools
blackboard_communication_delete_learn_api_public_announcements_by_announcementid
Delete Announcement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
announcementId | string | Yes | — | Announcement 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"
},
"announcementId": {
"type": "string",
"description": "Announcement 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",
"announcementId"
]
}
blackboard_communication_delete_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid
Delete Calendar Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
calendarItemType | string | Yes | — | Calendar Item Type |
calendarItemId | string | Yes | — | Calendar Item Id |
deleteSeries | boolean | No | — | delete the series calendar items or just one calendar item. true - delete the series, false - delete one calendar item. Defaults to false. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"calendarItemType": {
"type": "string",
"description": "Calendar Item Type",
"enum": [
"Course",
"GradebookColumn",
"Institution",
"OfficeHours",
"Personal"
]
},
"calendarItemId": {
"type": "string",
"description": "Calendar Item Id"
},
"deleteSeries": {
"type": "boolean",
"description": "delete the series calendar items or just one calendar item. true - delete the series, false - delete one calendar item. Defaults to false."
}
},
"required": [
"PCID",
"calendarItemType",
"calendarItemId"
]
}
blackboard_communication_get_learn_api_public_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. |
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."
},
"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_communication_get_learn_api_public_announcements_by_announcementid
Get Announcement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
announcementId | string | Yes | — | Announcement 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"
},
"announcementId": {
"type": "string",
"description": "Announcement 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",
"announcementId"
]
}
blackboard_communication_get_learn_api_public_calendars
Get Calendars 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. |
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."
},
"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_communication_get_learn_api_public_calendars_items
Get Calendar Items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
courseId | string | No | — | Specifies only calendar items associated with ‘courseId’ are to be returned. Since: 3400.9.0 |
type | string | No | — | Specifies only calendar items with the given type. Since: 3400.9.0 | Type | Description | --------- | --------- | | Course | | | GradebookColumn | Read only. | | Institution | | | OfficeHours | | | Personal | | |
since | string | No | — | Specifies only calendar items after the ‘since’ date (inclusive) are to be returned. Maximum of 16 weeks after the ‘since’ date will be returned. ISO-8601 date-time format is expected: [yyyy-MM-dd|yyyyMMdd][T(hh:mm[:ss[.sss]]|hhmm[ss[.sss]])]?[Z|[+-]hh:mm]] Since: 3400.9.0 |
until | string | No | — | Specifies only calendar items before the ‘until’ date (inclusive) are to be returned. Maximum of 16 weeks prior to the ‘until’ date will be returned. ISO-8601 date-time format is expected: [yyyy-MM-dd|yyyyMMdd][T(hh:mm[:ss[.sss]]|hhmm[ss[.sss]])]?[Z|[+-]hh:mm]] Since: 3400.9.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. |
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 - calendarId - title - start - end - modified Since: 3400.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"
},
"courseId": {
"type": "string",
"description": "Specifies only calendar items associated with 'courseId' are to be returned. **Since**: 3400.9.0"
},
"type": {
"type": "string",
"description": "Specifies only calendar items with the given type. **Since**: 3400.9.0 | Type | Description | --------- | --------- | | Course | | | GradebookColumn | Read only. | | Institution | | | OfficeHours | | | Personal | |",
"enum": [
"Course",
"GradebookColumn",
"Institution",
"OfficeHours",
"Personal"
]
},
"since": {
"type": "string",
"description": "Specifies only calendar items after the 'since' date (inclusive) are to be returned. Maximum of 16 weeks after the 'since' date will be returned. ISO-8601 date-time format is expected: [yyyy-MM-dd|yyyyMMdd][T(hh:mm[:ss[.sss]]|hhmm[ss[.sss]])]?[Z|[+-]hh:mm]] **Since**: 3400.9.0"
},
"until": {
"type": "string",
"description": "Specifies only calendar items before the 'until' date (inclusive) are to be returned. Maximum of 16 weeks prior to the 'until' date will be returned. ISO-8601 date-time format is expected: [yyyy-MM-dd|yyyyMMdd][T(hh:mm[:ss[.sss]]|hhmm[ss[.sss]])]?[Z|[+-]hh:mm]] **Since**: 3400.9.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."
},
"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 - calendarId - title - start - end - modified **Since**: 3400.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"
]
}
blackboard_communication_get_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid
Get Calendar Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
calendarItemType | string | Yes | — | Calendar Item Type |
calendarItemId | string | Yes | — | Calendar Item Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"calendarItemType": {
"type": "string",
"description": "Calendar Item Type",
"enum": [
"Course",
"GradebookColumn",
"Institution",
"OfficeHours",
"Personal"
]
},
"calendarItemId": {
"type": "string",
"description": "Calendar Item Id"
}
},
"required": [
"PCID",
"calendarItemType",
"calendarItemId"
]
}
blackboard_communication_get_learn_api_public_courses_by_courseid_discussions
Get Discussions 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. |
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),available” Supported fields are: - id - title - available - gradable - createdDate - modifiedDate - gradebookColumnId Since: 3900.19.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"
},
"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."
},
"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),available\" Supported fields are: - id - title - available - gradable - createdDate - modifiedDate - gradebookColumnId **Since**: 3900.19.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_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid
Get Discussion 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 | |
discussionId | string | Yes | — | Discussion 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 |"
},
"discussionId": {
"type": "string",
"description": "Discussion 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",
"discussionId"
]
}
blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid_messages
Get Discussion Messages 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 | |
discussionId | string | Yes | — | Discussion Id |
groupId | string | No | — | Search for messages which are associated with this groupId. Since: 3900.19.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. |
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. “createdDate(desc),givenName” Supported fields are: - id - discussionId - parentId - threadId - userId - groupId - givenName - familyName - status - body - createdDate - modifiedDate - isRead Since: 3900.19.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"
},
"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 |"
},
"discussionId": {
"type": "string",
"description": "Discussion Id"
},
"groupId": {
"type": "string",
"description": "Search for messages which are associated with this groupId. **Since**: 3900.19.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."
},
"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. \"createdDate(desc),givenName\" Supported fields are: - id - discussionId - parentId - threadId - userId - groupId - givenName - familyName - status - body - createdDate - modifiedDate - isRead **Since**: 3900.19.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",
"discussionId"
]
}
blackboard_communication_get_learn_api_public_courses_by_courseid_discussions_by_discussionid_messages_by_messageid_replies
Get Message Replies 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 | |
discussionId | string | Yes | — | Discussion Id |
messageId | string | Yes | — | Message 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. “createdDate(desc),givenName” Supported fields are: - id - discussionId - parentId - threadId - userId - groupId - givenName - familyName - status - body - createdDate - modifiedDate - isRead Since: 3900.19.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"
},
"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 |"
},
"discussionId": {
"type": "string",
"description": "Discussion Id"
},
"messageId": {
"type": "string",
"description": "Message 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. \"createdDate(desc),givenName\" Supported fields are: - id - discussionId - parentId - threadId - userId - groupId - givenName - familyName - status - body - createdDate - modifiedDate - isRead **Since**: 3900.19.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",
"discussionId",
"messageId"
]
}
blackboard_communication_patch_learn_api_public_announcements_by_announcementid
Update Announcement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
announcementId | string | Yes | — | Announcement Id |
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 System Announcement. |
body | string | No | — | The message body of the System Announcement. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’>here</a> for more information. |
showAtLogin | boolean | No | — | Whether this System Announcement should be displayed on the login page. |
showInCourses | boolean | No | — | Whether this System Announcement should be displayed on courses. |
title | string | No | — | The title of this System 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"
},
"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 System Announcement.",
"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 System Announcement. This field supports BbML; see <a target='_blank' href='https://docs.blackboard.com/learn/rest/advanced/bbml.html'>here</a> for more information."
},
"showAtLogin": {
"type": "boolean",
"description": "Whether this System Announcement should be displayed on the login page."
},
"showInCourses": {
"type": "boolean",
"description": "Whether this System Announcement should be displayed on courses."
},
"title": {
"type": "string",
"description": "The title of this System Announcement."
}
},
"required": [
"PCID",
"announcementId"
]
}
blackboard_communication_patch_learn_api_public_calendars_items_by_calendaritemtype_by_calendaritemid
Update Calendar Item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
calendarItemType | string | Yes | — | Calendar Item Type |
calendarItemId | string | Yes | — | Calendar Item Id |
updateSeries | boolean | No | — | update the series calendar items or just one calendar item. true - update the entire series, false - update a single calendar item. Defaults to false. When updating an entire series the full recurrence object must be populated just as if creating a new calendar series. If updating a single calendar entry the recurrence must not be specified. |
description | string | No | — | Description of the calendar item. |
disableResizing | boolean | No | — | Whether resizing of the calendar item should NOT be allowed. |
dynamicCalendarItemProps | object | No | — | Extra calendar item properties if it is a GradebookColumn calendar item. |
end | string | No | — | End date of the calendar item either in the past if the calendar item is for an event that’s already end OR in the future if it’s for an event to end in the future. This is always set and should occur after the start date. |
location | string | No | — | Location of the calendar item and it cannot exceed 1024 characters. |
recurrence | object | No | — | The recurrence value |
start | string | No | — | Start date of the calendar item either in the past if the calendar item is for an event that’s already started OR in the future if it’s for an event to start in the future. This is always set and should occur before the end date. |
title | string | No | — | Title of the calendar item. Title length cannot exceed 255 characters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"calendarItemType": {
"type": "string",
"description": "Calendar Item Type",
"enum": [
"Course",
"GradebookColumn",
"Institution",
"OfficeHours",
"Personal"
]
},
"calendarItemId": {
"type": "string",
"description": "Calendar Item Id"
},
"updateSeries": {
"type": "boolean",
"description": "update the series calendar items or just one calendar item. true - update the entire series, false - update a single calendar item. Defaults to false. When updating an entire series the full recurrence object must be populated just as if creating a new calendar series. If updating a single calendar entry the recurrence must not be specified."
},
"description": {
"type": "string",
"description": "Description of the calendar item."
},
"disableResizing": {
"type": "boolean",
"description": "Whether resizing of the calendar item should NOT be allowed."
},
"dynamicCalendarItemProps": {
"type": "object",
"description": "Extra calendar item properties if it is a GradebookColumn calendar item.",
"properties": {
"attemptable": {
"type": "boolean",
"description": "The dynamic calendar item can be attempted (can have attempts made against it) and the current user (in context) has permission/entitlement to grade attempts for the object represented by this calendar item."
},
"categoryId": {
"type": "string",
"description": "Returns the gradeableItem categoryId value .it is only set if the calendar event is dynamically created based on a single grade book column"
},
"dateRangeLimited": {
"type": "boolean",
"description": "The dynamic calendar item is only visible during a specific windows of time."
},
"eventType": {
"type": "string",
"description": "Returns a human readable string describing the type of calendar item represented (e.g. assignment, test, etc.)."
},
"gradable": {
"type": "boolean",
"description": "The dynamic calendar item can be graded and the current user (in context) has permission/entitlement to grade attempts for the object represented by this calendar item."
}
}
},
"end": {
"type": "string",
"description": "End date of the calendar item either in the past if the calendar item is for an event that's already end OR in the future if it's for an event to end in the future. This is always set and should occur after the start date."
},
"location": {
"type": "string",
"description": "Location of the calendar item and it cannot exceed 1024 characters."
},
"recurrence": {
"type": "object",
"description": "The recurrence value",
"properties": {
"count": {
"type": "integer",
"description": "Recurrence count indicating how many times the calendar item should be repeated. Either this count OR the 'until' date is/'should be' set. When creating a calendar item, 'until' date will be used if both 'until' date and the count are set."
},
"frequency": {
"type": "string",
"description": "Frequency of the calendar item repeated. | Type | Description | --------- | --------- | | Monthly | | | Weekly | | | Daily | |",
"enum": [
"Monthly",
"Weekly",
"Daily"
]
},
"interval": {
"type": "integer",
"description": "Interval between recurrences depends on the repeating type. For example, if the calendar times should be repeated every three weeks, you need set interval to 3 as well as frequency to \"Weekly\". Minimum and Maximum allowed Intervals are 1 and 100 respectively."
},
"monthRepeatDay": {
"type": "integer",
"description": "This property is used in conjunction with the 'Monthly' frequency and it indicates on which day of the month the calendar item is/'should be' repeated on. The valid values are valid month days, that is, 1 to 31. Either this OR both 'monthPosition' and 'repeatDay' should be set to create a recurring calendar item with 'Monthly' frequency."
},
"monthPosition": {
"type": "integer",
"description": "This property is used in conjunction with the 'Monthly' frequency and it indicates that the calendar item is/'should be' repeated on nth occurrence of 'repeatDay' in the month. Valid values for 'monthPosition' are integers in the range of -1 and 4 inclusive: -1 for the last occurrence, 1 for the first occurrence, 2 for the second occurrence, and so on. 0 is not used."
},
"originalStart": {
"type": "string",
"description": "The original start date for the calendar item."
},
"originalEnd": {
"type": "string",
"description": "The original end date for the calendar item."
},
"repeatBroken": {
"type": "boolean",
"description": "Calendar item that's repeated is part of a recurring series of calendar events but the item has been changed since its original creation. In other words, the calendar item has been modified to no longer align with the recurring series (day/time changed for example) of events. This can only be true if the calendar item is repeatable."
},
"repeatDay": {
"type": "string",
"description": "For monthly recurring event, repeat by day of week. | Type | Description | --------- | --------- | | Sunday | | | Monday | | | Tuesday | | | Wednesday | | | Thursday | | | Friday | | | Saturday | |",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"until": {
"type": "string",
"description": "The date the calendar item should be repeated until. Either this 'until' date OR the count is/'should be' set. When creating a calendar item, 'until' date will be used if both 'until' date and the count are set."
},
"weekDays": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"description": "This property is used in conjunction with the 'Weekly' frequency and it indicates the days of the week the calendar item should be repeated on."
}
}
},
"start": {
"type": "string",
"description": "Start date of the calendar item either in the past if the calendar item is for an event that's already started OR in the future if it's for an event to start in the future. This is always set and should occur before the end date."
},
"title": {
"type": "string",
"description": "Title of the calendar item. Title length cannot exceed 255 characters."
}
},
"required": [
"PCID",
"calendarItemType",
"calendarItemId"
]
}
blackboard_communication_post_learn_api_public_announcements
Create Announcement 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. |
availability | object | No | — | Settings controlling availability of the System Announcement. |
body | string | No | — | The message body of the System Announcement. This field supports BbML; see <a target=’_blank’ href=‘https://docs.blackboard.com/learn/rest/advanced/bbml.html’>here</a> for more information. |
showAtLogin | boolean | No | — | Whether this System Announcement should be displayed on the login page. |
showInCourses | boolean | No | — | Whether this System Announcement should be displayed on courses. |
title | string | Yes | — | The title of this System Announcement. |
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."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the System Announcement.",
"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 System Announcement. This field supports BbML; see <a target='_blank' href='https://docs.blackboard.com/learn/rest/advanced/bbml.html'>here</a> for more information."
},
"showAtLogin": {
"type": "boolean",
"description": "Whether this System Announcement should be displayed on the login page."
},
"showInCourses": {
"type": "boolean",
"description": "Whether this System Announcement should be displayed on courses."
},
"title": {
"type": "string",
"description": "The title of this System Announcement."
}
},
"required": [
"PCID",
"title"
]
}
blackboard_communication_post_learn_api_public_calendars_items
Create Calendar Item 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. |
calendarId | string | Yes | — | Calendar source identifier which indicates the calendar on which the calendar item was created. Examples of possible values : “PERSONAL”, “INSTITUTION”, and course id in the format of “_3_1”. |
description | string | No | — | Description of the calendar item. |
disableResizing | boolean | No | — | Whether resizing of the calendar item should NOT be allowed. |
dynamicCalendarItemProps | object | No | — | Extra calendar item properties if it is a GradebookColumn calendar item. |
end | string | No | — | End date of the calendar item either in the past if the calendar item is for an event that’s already end OR in the future if it’s for an event to end in the future. This is always set and should occur after the start date. |
location | string | No | — | Location of the calendar item and it cannot exceed 1024 characters. |
recurrence | object | No | — | The recurrence value |
start | string | No | — | Start date of the calendar item either in the past if the calendar item is for an event that’s already started OR in the future if it’s for an event to start in the future. This is always set and should occur before the end date. |
title | string | No | — | Title of the calendar item. Title length cannot exceed 255 characters. |
type | string | Yes | — | The type of this Calendar Item. | Type | Description | --------- | --------- | | Course | | | GradebookColumn | Read only. | | Institution | | | OfficeHours | | | Personal | | |
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."
},
"calendarId": {
"type": "string",
"description": "Calendar source identifier which indicates the calendar on which the calendar item was created. Examples of possible values : \"PERSONAL\", \"INSTITUTION\", and course id in the format of \"_3_1\"."
},
"description": {
"type": "string",
"description": "Description of the calendar item."
},
"disableResizing": {
"type": "boolean",
"description": "Whether resizing of the calendar item should NOT be allowed."
},
"dynamicCalendarItemProps": {
"type": "object",
"description": "Extra calendar item properties if it is a GradebookColumn calendar item.",
"properties": {
"attemptable": {
"type": "boolean",
"description": "The dynamic calendar item can be attempted (can have attempts made against it) and the current user (in context) has permission/entitlement to grade attempts for the object represented by this calendar item."
},
"categoryId": {
"type": "string",
"description": "Returns the gradeableItem categoryId value .it is only set if the calendar event is dynamically created based on a single grade book column"
},
"dateRangeLimited": {
"type": "boolean",
"description": "The dynamic calendar item is only visible during a specific windows of time."
},
"eventType": {
"type": "string",
"description": "Returns a human readable string describing the type of calendar item represented (e.g. assignment, test, etc.)."
},
"gradable": {
"type": "boolean",
"description": "The dynamic calendar item can be graded and the current user (in context) has permission/entitlement to grade attempts for the object represented by this calendar item."
}
}
},
"end": {
"type": "string",
"description": "End date of the calendar item either in the past if the calendar item is for an event that's already end OR in the future if it's for an event to end in the future. This is always set and should occur after the start date."
},
"location": {
"type": "string",
"description": "Location of the calendar item and it cannot exceed 1024 characters."
},
"recurrence": {
"type": "object",
"description": "The recurrence value",
"properties": {
"count": {
"type": "integer",
"description": "Recurrence count indicating how many times the calendar item should be repeated. Either this count OR the 'until' date is/'should be' set. When creating a calendar item, 'until' date will be used if both 'until' date and the count are set."
},
"frequency": {
"type": "string",
"description": "Frequency of the calendar item repeated. | Type | Description | --------- | --------- | | Monthly | | | Weekly | | | Daily | |",
"enum": [
"Monthly",
"Weekly",
"Daily"
]
},
"interval": {
"type": "integer",
"description": "Interval between recurrences depends on the repeating type. For example, if the calendar times should be repeated every three weeks, you need set interval to 3 as well as frequency to \"Weekly\". Minimum and Maximum allowed Intervals are 1 and 100 respectively."
},
"monthRepeatDay": {
"type": "integer",
"description": "This property is used in conjunction with the 'Monthly' frequency and it indicates on which day of the month the calendar item is/'should be' repeated on. The valid values are valid month days, that is, 1 to 31. Either this OR both 'monthPosition' and 'repeatDay' should be set to create a recurring calendar item with 'Monthly' frequency."
},
"monthPosition": {
"type": "integer",
"description": "This property is used in conjunction with the 'Monthly' frequency and it indicates that the calendar item is/'should be' repeated on nth occurrence of 'repeatDay' in the month. Valid values for 'monthPosition' are integers in the range of -1 and 4 inclusive: -1 for the last occurrence, 1 for the first occurrence, 2 for the second occurrence, and so on. 0 is not used."
},
"originalStart": {
"type": "string",
"description": "The original start date for the calendar item."
},
"originalEnd": {
"type": "string",
"description": "The original end date for the calendar item."
},
"repeatBroken": {
"type": "boolean",
"description": "Calendar item that's repeated is part of a recurring series of calendar events but the item has been changed since its original creation. In other words, the calendar item has been modified to no longer align with the recurring series (day/time changed for example) of events. This can only be true if the calendar item is repeatable."
},
"repeatDay": {
"type": "string",
"description": "For monthly recurring event, repeat by day of week. | Type | Description | --------- | --------- | | Sunday | | | Monday | | | Tuesday | | | Wednesday | | | Thursday | | | Friday | | | Saturday | |",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"until": {
"type": "string",
"description": "The date the calendar item should be repeated until. Either this 'until' date OR the count is/'should be' set. When creating a calendar item, 'until' date will be used if both 'until' date and the count are set."
},
"weekDays": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
]
},
"description": "This property is used in conjunction with the 'Weekly' frequency and it indicates the days of the week the calendar item should be repeated on."
}
}
},
"start": {
"type": "string",
"description": "Start date of the calendar item either in the past if the calendar item is for an event that's already started OR in the future if it's for an event to start in the future. This is always set and should occur before the end date."
},
"title": {
"type": "string",
"description": "Title of the calendar item. Title length cannot exceed 255 characters."
},
"type": {
"type": "string",
"description": "The type of this Calendar Item. | Type | Description | --------- | --------- | | Course | | | GradebookColumn | Read only. | | Institution | | | OfficeHours | | | Personal | |",
"enum": [
"Course",
"GradebookColumn",
"Institution",
"OfficeHours",
"Personal"
]
}
},
"required": [
"PCID",
"calendarId",
"type"
]
}