Blackboard
Anthology Adopt powered by Pendo allows institutions to gain insights on Blackboard Learn usage and take action through in-app messages, digital walkthrough guides, and tooltips.
This is a first-class FlyMyAI MCP. Agents discover it automatically via tool search and call the actions below on demand - you never wire it up by hand. See the Composio catalog for how discovery works.
Connect
Blackboard connects with a single OAuth click - there is no token to paste. The first time an agent uses a Blackboard action, FlyMyAI asks you to authorize your Blackboard account. Approve it once and the connection is reused for every later run.
- Provider: Blackboard
Actions
Every action this integration exposes. Agents pick the right one from the task; you do not call them by name.
| Action | What it does | Required inputs |
|---|---|---|
BLACKBOARD_ACCESS_CONTROLLED_COURSE_ANNOUNCEMENTS | Retrieves a list of announcements for a specific course in the blackboard learning management system. this endpoint allows users to access important messages, updates, or notifications related to a particular course. it should be used when there's a need to f… | courseId |
BLACKBOARD_ACCESS_COURSE_ANNOUNCEMENTS_BASED_ON_PERMISSIONS | Retrieves a specific announcement from a particular course in the blackboard learn system. this endpoint allows users to fetch detailed information about a single announcement, including its content, creation date, and any attachments. it is particularly usef… | announcementId, courseId |
BLACKBOARD_ADD_CHILD_COURSE | This endpoint updates the relationship between a parent course and its child course in the blackboard learning management system. it is used to modify existing course hierarchies, allowing administrators to restructure course organizations or adjust course re… | courseId, childCourseId |
BLACKBOARD_ATTACH_FILE | This endpoint allows for the upload and attachment of files to a specific attempt within a course's gradebook in the blackboard learning management system. it is used to associate submitted work, supporting documents, or any relevant files with a student's at… | courseId, attemptId |
BLACKBOARD_AUTHORIZATION_CODE | Initiates the oauth 2.0 authorization code flow for the blackboard api. this endpoint is used to obtain an authorization code, which is a crucial step in the oauth 2.0 authentication process. the authorization code can later be exchanged for an access token,… | - |
BLACKBOARD_CONDITIONAL_GRADE_ACCESS | Retrieves the gradebook information for a specific user within a particular course in blackboard. this endpoint allows instructors or authorized personnel to access individual student grade data, including assignment scores, overall course grade, and any cust… | courseId, userId |
BLACKBOARD_COPY_COURSE | The coursecopytool allows you to create a copy of a blackboard course with fine-grained control over which elements are included in the copy. this endpoint is used when you need to duplicate a course, either creating a new course or overwriting an existing on… | courseId |
BLACKBOARD_COURSE_AND_ORG_DUPLICATION_PERMISSIONS_UPDATE | This endpoint creates a copy of an existing course in the blackboard learning management system. it allows instructors or administrators to duplicate course content, settings, and structure into a new or existing course. use this endpoint when you need to rep… | courseId, courseId |
BLACKBOARD_COURSE_ANNOUNCEMENT_CREATION_PERMISSION | Creates a new announcement within a specified course in the blackboard learning management system. this endpoint allows instructors or course administrators to post important messages, updates, or notifications to all enrolled students. the announcement can b… | courseId, title |
BLACKBOARD_COURSE_DATA_ACCESS_CONTROL_BY_USER_ENTITLEMENT | Retrieves a list of courses from the blackboard learn platform. this endpoint allows developers to fetch information about courses available in the learning management system. it can be used to integrate course data into external applications, create custom d… | - |
BLACKBOARD_COURSE_ENDPOINT_ENTITLEMENT_ACCESS | Retrieves detailed information about a specific course in the blackboard learn platform using its unique identifier. this endpoint allows users to fetch comprehensive course data, which may include the course name, code, description, enrollment information, i… | courseId |
BLACKBOARD_COURSE_ENTITLEMENT_AND_DATA_ACCESS_CONTROL | Retrieves detailed information about a specific course in the blackboard learning management system. this endpoint allows users to fetch comprehensive data related to a course, such as its title, description, start and end dates, enrollment information, and o… | courseId |
BLACKBOARD_COURSE_GROUP_INITIATION | Creates a new group within a specified course in the blackboard learn system. this endpoint allows for detailed customization of group properties, including its name, description, availability, and enrollment settings. it's particularly useful for organizing… | courseId, name |
BLACKBOARD_COURSE_GROUP_MODIFICATION | Updates the properties of a specific group within a blackboard learn course. this endpoint allows modification of group details such as name, description, availability, and enrollment settings. it's particularly useful for adjusting group configurations after… | courseId, groupId |
BLACKBOARD_COURSE_MODIFICATION_PERMISSIONS | Updates an existing course in the blackboard learn system. this endpoint allows modification of various course attributes including basic information, availability settings, enrollment options, and localization preferences. it's used to adjust course details… | courseId |
BLACKBOARD_COURSE_MODIFICATION_PERMISSION_CHECKS | The patchcourse endpoint allows for updating specific details and settings of an existing course in the blackboard learn system. it is used when modifications to course properties such as name, description, availability, enrollment options, or localization se… | courseId |
BLACKBOARD_COURSE_ORG_SYNC_REMOVAL | Deletes a specific course from the blackboard learn platform. this endpoint should be used when an administrator or authorized user needs to permanently remove a course from the system, including all associated content, enrollments, and data. it is particular… | courseId |
BLACKBOARD_COURSE_OR_ORGANIZATION_CREATION | Creates a new course in the blackboard learn system with specified settings and configurations. this endpoint allows administrators or instructors to set up a course with various parameters including its basic information, availability, enrollment options, an… | courseId, name |
BLACKBOARD_COURSE_USER_REMOVAL | Removes a specific user from a particular course in the blackboard learning management system. this endpoint should be used when an administrator or instructor needs to unenroll a student, remove a teaching assistant, or disassociate any user from a course. i… | courseId, userId |
BLACKBOARD_CREATE_ADAPTIVE_RELEASE_ACL_USER_PREDICATE | This endpoint updates a user-specific criterion within an adaptive release rule for a particular content item in a blackboard course. it allows for fine-tuning of content visibility based on individual user conditions. use this endpoint when you need to modif… | courseId, contentId, ruleId, criterionId, userId |
BLACKBOARD_CREATE_ADAPTIVE_RELEASE_RULE_CRITERIA | This endpoint allows for the creation of new adaptive release criteria for a specific rule within a course's content in blackboard. it is used to define conditions under which course content will be made available to students, such as completion of prerequisi… | courseId, contentId, ruleId |
BLACKBOARD_CREATE_ANNOUNCEMENT | Creates a new system-wide announcement in the blackboard learn environment. this endpoint allows administrators to compose and configure announcements that can be displayed to users across the platform. the announcement can be customized with rich text conten… | title |
BLACKBOARD_CREATE_ASSIGNMENT | Creates a new assignment within a specified blackboard course. this endpoint allows instructors to set up detailed assignments with customizable settings for availability, grading, and plagiarism detection. it supports rich text instructions using bbml, adapt… | courseId, title |
BLACKBOARD_CREATE_ATTENDANCE_RECORD | Adds a user to a specific meeting within a blackboard course and sets their attendance status. this endpoint is essential for managing attendance and user participation in course meetings. it allows instructors or authorized users to update a student's attend… | courseId, meetingId, meetingId, userId, status |
BLACKBOARD_CREATE_CALENDAR_ITEM | This endpoint creates a new calendar item in the blackboard platform. it allows users to add various types of events, such as course-related activities, personal appointments, or institution-wide events, to specific calendars within the system. the endpoint s… | type, calendarId |
BLACKBOARD_CREATE_CATEGORY | Creates a new category in the blackboard catalog system. this endpoint allows administrators to define and organize content categories within the learning management system. use this tool to add a new category with specific properties such as title, descripti… | categoryType, categoryId, title, available |
BLACKBOARD_CREATE_CHILD | Creates a new content item within a specified course and parent content in the blackboard learn platform. this endpoint allows for the creation of various types of content, such as documents, external links, folders, and assignments. it provides extensive con… | courseId, contentId, title |
BLACKBOARD_CREATE_CHILD_NODE | Creates a new child node within the institutional hierarchy of blackboard learn. this endpoint allows administrators to expand and organize the structure of their educational institution by adding new nodes as children of existing ones. it is particularly use… | nodeId, title |
BLACKBOARD_CREATE_COLUMN_ATTEMPT | Creates a new attempt for a specific gradebook column in a blackboard course. this endpoint allows instructors or authorized users to add a new attempt record for a student's assignment or assessment. it can be used to manually enter grades, provide feedback,… | columnId, courseId |
BLACKBOARD_CREATE_COLUMN_GROUP_ATTEMPT | The creategroupattempt endpoint allows for the creation or update of a group attempt for a specific gradebook column in a blackboard learn course. this tool is essential for managing group submissions, tracking their progress, and facilitating the grading pro… | courseId, columnId, groupId |
BLACKBOARD_CREATE_CONTENT | Creates new content within a specified blackboard course. this endpoint allows for the addition of various types of content, including documents, external links, folders, and more, with detailed configuration options. it supports rich text formatting through… | courseId, title |
BLACKBOARD_CREATE_CONTENT_GROUP | This endpoint updates the association between a specific content item and a group within a blackboard learn course. it is used to modify existing content-group relationships, enabling instructors or administrators to manage group-specific content access or vi… | courseId, contentId, groupId |
BLACKBOARD_CREATE_COURSE | Creates a new course in the blackboard learn system with specified attributes and settings. this endpoint allows for the detailed configuration of a course, including its basic information, availability, enrollment options, and localization settings. it suppo… | courseId, name |
BLACKBOARD_CREATE_COURSE_MEETING | Creates a new meeting for a specific course within the blackboard learning management system. this endpoint allows you to schedule and define the details of a course meeting, including its title, description, start and end times, and an optional external link… | courseId, courseId, title, description, start, end |
BLACKBOARD_CREATE_DATA_SOURCE | Creates a new data source in the blackboard learn system. this endpoint is used to establish a unique identifier for an external data source, which can then be referenced in other api calls or integrations. it's particularly useful when setting up integration… | externalId |
BLACKBOARD_CREATE_DISCUSSION | Creates a new discussion forum within a specified course in the blackboard learning management system. this endpoint allows instructors or course administrators to set up a discussion topic, define its availability, and optionally make it gradable. it's parti… | courseId, title |
BLACKBOARD_CREATE_DOMAIN_CONFIG | Creates or updates an lti (learning tools interoperability) domain configuration in blackboard learn. this endpoint allows administrators to set up and manage integrations with external learning tools, configuring various aspects such as user data sharing, se… | - |
BLACKBOARD_CREATE_FILE_ATTACHMENT | Adds an attachment to a specific content item within a blackboard learn course. this endpoint allows developers to programmatically upload and associate files with course materials, enhancing the content available to students. it should be used when integrati… | courseId, contentId |
BLACKBOARD_CREATE_GRADE_COLUMN | Creates a new grade column in a course's gradebook within the blackboard learn platform. this endpoint allows instructors or administrators to set up various types of grade columns, including manual entry, calculated grades, and those based on student attempt… | courseId, name |
BLACKBOARD_CREATE_GRADE_NOTATION | Creates a new grade notation in the gradebook for a specific course in blackboard. this endpoint allows instructors or administrators to add custom performance codes and their corresponding descriptions to the grading system. it's particularly useful for impl… | courseId, code, description |
BLACKBOARD_CREATE_GRADE_SCHEMA | Creates a new gradebook schema for a specific course in blackboard learn. this endpoint allows instructors or administrators to define custom grading structures tailored to their course needs. it supports various grading scales including percentage, score-bas… | courseId, title |
BLACKBOARD_CREATE_GRADING_PERIOD | Creates a new grading period within a specific course's gradebook in the blackboard learn system. this endpoint allows instructors or administrators to define and organize temporal segments for grade collection and management. it's particularly useful for str… | courseId, title |
BLACKBOARD_CREATE_GROUP | Creates a new group within a specified course in the blackboard learning management system. this endpoint allows instructors or administrators to set up and configure groups for collaborative work, discussions, or other course-related activities. the function… | courseId, name |
BLACKBOARD_CREATE_GROUP_MEMBERSHIP | This endpoint updates a user's information within a specific group in a blackboard course. it allows administrators or instructors to modify user details, roles, or permissions for a particular user in the context of a course group. use this endpoint when you… | courseId, groupId, userId |
BLACKBOARD_CREATE_GROUP_PREDICATE | This endpoint updates the criteria for a specific group within an adaptive release rule for a particular content item in a blackboard course. it allows instructors or course administrators to modify how and when course content is made available to different g… | courseId, contentId, ruleId, criterionId, groupId |
BLACKBOARD_CREATE_GROUP_SET | Creates a new group set within a specified course in the blackboard learn platform. this endpoint allows instructors or administrators to set up a structured group of students for collaborative work, discussions, or other course activities. the group set can… | courseId, name |
BLACKBOARD_CREATE_GROUP_SET_CHILD | Creates a new group within a specified course group set in the blackboard learn platform. this endpoint allows instructors or administrators to set up groups with customizable settings for student collaboration and activities. it provides options for controll… | groupId, courseId, name |
BLACKBOARD_CREATE_MEMBERSHIP | This endpoint updates an existing course within a specific category in the blackboard catalog. it allows administrators or authorized users to modify course details such as title, description, or other attributes associated with the course. the endpoint shoul… | categoryType, categoryId, courseId |
BLACKBOARD_CREATE_MESSAGE | Creates a new message within a specific blackboard course. this endpoint allows users to compose and send messages to course participants, supporting rich text formatting through bbml, file attachments, and flexible recipient management. it's ideal for course… | courseId |
BLACKBOARD_CREATE_MESSAGE_REPLY | Creates a reply to a specific message within a blackboard course discussion. this endpoint allows users to contribute to ongoing discussions by posting responses to existing messages. it supports both course-wide and group-specific discussions, with options t… | courseId, discussionId, messageId, body |
BLACKBOARD_CREATE_NODE | Creates a new node in the institutional hierarchy of blackboard. this endpoint allows for the addition of organizational elements such as departments, courses, or other structural units within an educational institution's blackboard system. it is used to buil… | title |
BLACKBOARD_CREATE_NODE_COURSE_ASSOCIATION | This endpoint updates the association between a specific course and a node in the blackboard institutional hierarchy. it allows you to set or change whether the specified node is the primary association for the given course. use this endpoint when you need to… | nodeId, courseId |
BLACKBOARD_CREATE_NODE_USER_ASSOCIATION | Updates a user's information or association within a specific node of the institutional hierarchy in blackboard. this endpoint is used to modify a user's relationship or details within a particular organizational unit, such as a department, school, or other i… | nodeId, userId |
BLACKBOARD_CREATE_OBSERVER | Updates the observer relationship between a user and an observer in the blackboard learn platform. this endpoint is used to modify existing observer connections, such as changing the level of access or updating the relationship status between a student and a… | userId, observerId |
BLACKBOARD_CREATE_PLACEMENT | Creates a new lti (learning tools interoperability) placement in the blackboard learn system. this endpoint allows integration of external tools and services into the learning management system, enhancing the capabilities and user experience. it supports vari… | name, handle, type, url |
BLACKBOARD_CREATE_PRONOUN | Creates a new pronoun entry in the blackboard learning management system. this endpoint is used to add new pronouns to the system's user identity management, supporting inclusive and diverse user representation. it should be used when administrators or author… | name, status |
BLACKBOARD_CREATE_QUESTION | This endpoint creates a new question within an existing blackboard assessment. it supports various question types and allows for customization of content, feedback, and scoring. use it to build or modify assessments by adding new questions. note that while ma… | courseId, assessmentId, text |
BLACKBOARD_CREATE_RUBRIC | Creates a new rubric for a specific course in blackboard learn. this endpoint allows instructors or course designers to define a structured evaluation tool with customizable criteria, performance levels, and scoring methods. the rubric can be used for various… | courseId, title, rubricType |
BLACKBOARD_CREATE_RUBRIC_ASSOCIATION | Creates a new association between a rubric and a specific course content item in the blackboard learning management system. this endpoint allows instructors or course designers to link a rubric to elements such as assignments, discussions, or other gradable i… | courseId, rubricId, usedForGrading |
BLACKBOARD_CREATE_RUBRIC_EVALUATIONS | Creates or updates a rubric evaluation for a specific course, rubric, and rubric association in the blackboard learn platform. this endpoint allows instructors or authorized users to submit detailed evaluations of student work using predefined rubrics. it sup… | courseId, rubricId, rubricAssociationId |
BLACKBOARD_CREATE_RULE | Creates a new adaptive release rule for a specific content item within a blackboard course. this endpoint allows instructors or course administrators to set up conditions for releasing course content to students based on various criteria. the rule is identifi… | contentId, courseId, title |
BLACKBOARD_CREATE_TERM | Creates a new term in the blackboard learn system with the specified attributes. this endpoint allows administrators to define academic periods or sessions, setting up the structure for courses and student enrollments. it provides options for customizing term… | externalId, name |
BLACKBOARD_CREATE_USER | Creates a new user account in the blackboard learn system with detailed profile information. this endpoint allows for the creation of user profiles with comprehensive data, including personal details, educational information, institutional and system roles, c… | userName, password |
BLACKBOARD_DELETE_ACL_USER_PREDICATE | Removes a specific user from an adaptive release rule criterion for a particular content item within a course. this endpoint is used to modify the conditions under which course content is made available to individual students. it should be used when an instru… | courseId, contentId, ruleId, criterionId, userId |
BLACKBOARD_DELETE_ADAPTIVE_RELEASE_RULE_CRITERION | Deletes a specific criterion from an adaptive release rule for a content item within a blackboard course. this endpoint allows instructors or course administrators to remove individual conditions that control when content becomes available to students. use th… | courseId, contentId, ruleId, criterionId |
BLACKBOARD_DELETE_ALL_ATTENDANCE_BY_USER_ID | Deletes all meeting attendance records for a specific user within a particular course in the blackboard system. this endpoint is used when an administrator or instructor needs to remove all attendance data for a student, which may be necessary for course tran… | courseId, userId |
BLACKBOARD_DELETE_ALL_ATTENDANCE_RECORDS_BY_COURSE_AND_USER_ID | This endpoint removes a user from a meeting within a specific course in the blackboard learning management system. it should be used when an administrator or instructor needs to revoke a user's access to a particular course meeting, such as when a student dro… | courseId, userId |
BLACKBOARD_DELETE_ALL_MEETINGS_IN_COURSE | Deletes all meetings associated with a specific course in the blackboard learn platform. this endpoint should be used when an instructor or administrator needs to remove virtual sessions or scheduled meetings from a course, potentially at the end of a term or… | courseId |
BLACKBOARD_DELETE_ALL_RECORDS_IN_MEETING | Deletes all attendance records in the course meeting for a given meeting id. the 'course.attendance.delete' entitlement is required to delete attendance records. since: 3500.7.0 | courseId, meetingId |
BLACKBOARD_DELETE_ANNOUNCEMENT | Deletes a specific announcement from the blackboard learning management system (lms) using its unique identifier. this endpoint should be used when an instructor, administrator, or authorized user needs to permanently remove an announcement from a course or t… | announcementId |
BLACKBOARD_DELETE_ATTACHMENT | Deletes a specific file associated with an attempt in a course's gradebook within the blackboard learn environment. this endpoint should be used when an instructor or administrator needs to remove a file that was incorrectly uploaded or is no longer relevant… | courseId, attemptId, attemptFileId |
BLACKBOARD_DELETE_ATTENDANCE_RECORD | Delete attendance record for meeting.it will delete meeting attendance within a course meeting. the 'course.attendance.delete' entitlement is required to delete attendance record. since: 3500.7.0 | courseId, meetingId, userId |
BLACKBOARD_DELETE_CALENDAR_ITEM | This endpoint deletes a specific calendar item from the blackboard learn system. it allows users to remove events from personal, course, organization, or institution calendars. the endpoint should be used when a calendar item needs to be permanently removed f… | calendarItemType, calendarItemId |
BLACKBOARD_DELETE_CATEGORY | This endpoint deletes a specific category from the blackboard catalog based on the provided category type and id. it should be used when an administrator or authorized user needs to remove a category that is no longer needed or relevant. the operation is perm… | categoryType, categoryId |
BLACKBOARD_DELETE_CONTENT | Deletes a specific content item from a course in the blackboard learning management system. this endpoint should be used when an administrator or authorized user needs to remove outdated, incorrect, or unnecessary learning materials from a course. it permanen… | courseId, contentId |
BLACKBOARD_DELETE_CONTENT_GROUP | This endpoint deletes a specific group associated with a content item within a blackboard course. it is used to remove group assignments or collaborations tied to particular course content. the operation is irreversible and should be used with caution, as it… | courseId, contentId, groupId |
BLACKBOARD_DELETE_COURSE | Deletes a specific course from the blackboard learning management system. this endpoint permanently removes all course data, including content, assignments, and student records associated with the specified course. it should be used with caution, typically at… | courseId |
BLACKBOARD_DELETE_COURSE_MEETING | This endpoint deletes a specific meeting within a course in the blackboard learning management system. it should be used when an administrator or instructor needs to remove a scheduled meeting from a course, such as cancelling a virtual class session or remov… | courseId, meetingId |
BLACKBOARD_DELETE_DATA_SOURCE | Deletes a specific data source from the blackboard learn platform. this endpoint should be used when an administrator needs to permanently remove a data source, such as those related to users, courses, or enrollments, from the system. it's crucial to use this… | dataSourceId |
BLACKBOARD_DELETE_DOMAIN_CONFIG | Deletes a specific lti (learning tools interoperability) domain from the blackboard learning management system. this endpoint is used to remove an existing domain configuration, which may include associated lti tool integrations and settings. it should be use… | domainId |
BLACKBOARD_DELETE_FILE_ATTACHMENT | Deletes a specific attachment from a content item within a course in blackboard learn. this endpoint should be used when an instructor or authorized user needs to remove an attachment from course materials. it permanently removes the specified attachment from… | courseId, contentId, attachmentId |
BLACKBOARD_DELETE_GRADE_COLUMN | Deletes a specific gradebook column from a course in the blackboard learn system. this endpoint should be used when an instructor or administrator needs to permanently remove a column from the gradebook, such as when a graded item is no longer relevant or was… | courseId, columnId |
BLACKBOARD_DELETE_GRADE_NOTATION | Deletes a specific grade notation from a course's gradebook in blackboard learn. this endpoint should be used when an instructor or administrator needs to remove an existing grade notation that is no longer relevant or was created in error. it permanently rem… | courseId, gradeNotationId |
BLACKBOARD_DELETE_GRADING_PERIOD | Deletes a specific gradebook period from a course in the blackboard learning management system. this endpoint allows administrators or instructors to remove a grading period that is no longer needed or was created in error. it should be used when restructurin… | courseId, periodId |
BLACKBOARD_DELETE_GROUP | This endpoint deletes a specific group from a course in the blackboard learning management system. it is used to remove a group that is no longer needed or has been created in error. the operation is permanent and cannot be undone, so it should be used with c… | groupId, courseId |
BLACKBOARD_DELETE_GROUP_MEMBERSHIP | Removes a specific user from a particular group within a course in the blackboard learning management system. this endpoint is used when an instructor or administrator needs to remove a student or participant from a group, perhaps due to course changes, group… | courseId, groupId, userId |
BLACKBOARD_DELETE_GROUP_PREDICATE | Removes a specific group from a criterion within an adaptive release rule for a particular content item in a blackboard course. this endpoint is used to modify the access conditions for course content by eliminating a group's inclusion in the release criteria… | courseId, contentId, ruleId, criterionId, groupId |
BLACKBOARD_DELETE_GROUP_SET | This endpoint deletes a specific group set within a course in the blackboard learning management system. it permanently removes the entire group set, including all associated groups and their memberships, from the specified course. this operation should be us… | courseId, groupId |
BLACKBOARD_DELETE_MEMBERSHIP | Removes a specific course from a designated category within the blackboard learning management system (lms) catalog. this endpoint is used when you need to disassociate a course from a particular category, which can be useful for reorganizing the course catal… | categoryType, categoryId, courseId |
BLACKBOARD_DELETE_MESSAGE | This endpoint deletes a specific message within a course in the blackboard learning management system. it should be used when an instructor or authorized user needs to remove a particular message from a course's communication thread. the deletion is permanent… | courseId, messageId |
BLACKBOARD_DELETE_NODE | Deletes a specific node from the institutional hierarchy in blackboard learn. this endpoint should be used when an administrator needs to remove a node, such as a department, school, or program, from the institution's organizational structure. it permanently… | nodeId |
BLACKBOARD_DELETE_NODE_ADMIN | Removes an administrator's access from a specific node in the institutional hierarchy of blackboard learn. this endpoint should be used when you need to revoke administrative privileges for a user at a particular level of the institution's structure. it's par… | nodeId, userId |
BLACKBOARD_DELETE_NODE_COURSE_ASSOCIATION | Removes a specific course from a designated node in the institutional hierarchy of blackboard learn. this endpoint is used for managing the organizational structure of courses within an institution's blackboard environment. it allows administrators to disasso… | nodeId, courseId |
BLACKBOARD_DELETE_NODE_USER_ASSOCIATION | This endpoint removes a specified user from a particular node within the institutional hierarchy of blackboard learn. it is used to disassociate a user (such as a student, faculty member, or staff) from a specific organizational unit (e.g., school, department… | nodeId, userId |
BLACKBOARD_DELETE_OBSERVER | This endpoint removes a specific observer from a user's list of observers in the blackboard learning management system. it is used to terminate the observer-user relationship, revoking the observer's ability to monitor or view the specified user's activities… | userId, observerId |
BLACKBOARD_DELETE_PLACEMENT | This endpoint deletes a specific learning tools interoperability (lti) placement from the blackboard learn platform. lti placements define where and how external learning tools are integrated within the blackboard user interface. use this endpoint when you ne… | placementId |
BLACKBOARD_DELETE_PRONOUN | Deletes a specific pronoun setting from the blackboard learning management system. this endpoint is used to remove a user's pronoun preference from the system, identified by a unique pronounid. it should be used when a pronoun setting is no longer needed, suc… | pronounId |
BLACKBOARD_DELETE_QUESTION | Deletes a specific question from an assessment within a blackboard course. this endpoint allows instructors or course administrators to remove individual questions from existing assessments, which can be useful for updating or refining assessment content. the… | courseId, assessmentId, questionId |
BLACKBOARD_DELETE_RUBRIC | Deletes a specific rubric associated with a given course in the blackboard learn system. this endpoint should be used when an instructor or administrator needs to permanently remove a rubric from a course, such as when the rubric is no longer relevant or has… | courseId, rubricId |
BLACKBOARD_DELETE_RUBRIC_ASSOCIATION | Deletes a specific rubric association within a course in the blackboard learn platform. this endpoint removes the link between a rubric and its associated item (such as an assignment or assessment) in a given course. it should be used when an instructor or ad… | courseId, rubricId, rubricAssociationId |
BLACKBOARD_DELETE_TERM | The deleteterm endpoint removes a specific academic term from the blackboard learning management system. it should be used when an administrator needs to permanently remove a term that is no longer needed, such as an outdated or erroneously created term. this… | termId |
BLACKBOARD_DELETE_USER | This endpoint permanently deletes a user account from the blackboard learn platform. it should be used when an administrator needs to remove a user's access and information from the system, such as when a student graduates or an employee leaves the institutio… | userId |
BLACKBOARD_DEPRECATED_GRADE_COLUMN_ACCESS | Retrieves detailed information about a specific gradebook column for a particular course in the blackboard learning management system. this endpoint allows educators and administrators to access the configuration and content of individual grading components w… | courseId, columnId |
BLACKBOARD_DEPRECATE_COURSE_GROUP_DELETE | This endpoint deletes a specific group within a course in the blackboard learning management system. it is used to remove a group that is no longer needed or to clean up the course structure. the operation is permanent and cannot be undone, so it should be us… | courseId, groupId |
BLACKBOARD_DOWNLOAD | Downloads a specific attachment from a course's content in the blackboard learning management system. this endpoint retrieves the file associated with the given attachmentid, which is linked to a particular content item (contentid) within a specific course (c… | courseId, contentId, attachmentId |
BLACKBOARD_ENHANCE_GRADEBOOK_ENTRIES | Updates a specific user's grade information within a course's gradebook column in the blackboard learning management system. this endpoint allows instructors or authorized users to modify various aspects of a student's grade, including the textual representat… | courseId, columnId, userId |
BLACKBOARD_ENROLL_COURSE_WITH_PERMISSIONS | Updates a user's enrollment details in a specific blackboard learn course. this endpoint allows for modifying various aspects of a user's course membership, including their role, availability status, and association with cross-listed courses. it's particularl… | courseId, userId |
BLACKBOARD_FETCH_COURSE_CATEGORY_ASSOCIATIONS | Retrieves a list of categories for a specific course within the blackboard learning management system. this endpoint allows developers to access the organizational structure of a course, providing information about how content is categorized and arranged. it… | courseId |
BLACKBOARD_FETCH_COURSE_RUBRIC_ASSESSMENTS | Retrieves the evaluations associated with a specific rubric for a particular course and rubric association in the blackboard learning management system. this endpoint is designed for instructors, administrators, or authorized personnel to access and review as… | courseId, rubricId, rubricAssociationId |
BLACKBOARD_FETCH_GROUP_ATTEMPT_RUBRIC_SCORES | Retrieves the rubric evaluations for a specific group attempt within a gradebook column of a blackboard course. this endpoint is designed to fetch detailed assessment data based on predefined rubric criteria for group assignments or projects. it should be use… | courseId, columnId, groupAttemptId |
BLACKBOARD_FILTER_GRADES_WITH_EXCLUSIONS_AND_SECURITY | Retrieves the grades for all users associated with a specific gradebook column in a particular blackboard course. this endpoint is useful for instructors or administrators who need to access and analyze grade data for a single assignment or grade item across… | courseId, columnId |
BLACKBOARD_GENERATE_ATTENDANCE_DATA_DOWNLOAD_URL | Retrieves a download url for meeting-related resources within a specific blackboard course. this endpoint should be used when access to downloadable content associated with course meetings is required, such as meeting recordings, shared documents, or other me… | courseId |
BLACKBOARD_GET_ACTIVE_SESSIONS | Retrieves a list of active sessions from the blackboard learn platform. this endpoint provides information about ongoing learning activities, such as class meetings, online discussions, or interactive modules. it can be used to monitor current engagement, tra… | - |
BLACKBOARD_GET_ADAPTIVE_RELEASE_ACL_GROUP_PREDICATES | Retrieves the groups associated with a specific criterion of an adaptive release rule for a particular content item within a blackboard course. this endpoint is used to get information about which groups are part of the conditions for releasing content based… | courseId, contentId, ruleId, criterionId |
BLACKBOARD_GET_ADAPTIVE_RELEASE_ACL_USER_PREDICATES | Retrieves a list of users who meet a specific criterion within an adaptive release rule for a particular content item in a blackboard learn course. this endpoint is used to identify which users have satisfied the conditions set by the adaptive release criteri… | courseId, contentId, ruleId, criterionId |
BLACKBOARD_GET_ADAPTIVE_RELEASE_RULE_CRITERION | Retrieves detailed information about a specific criterion within an adaptive release rule for a particular content item in a blackboard learn course. this endpoint allows instructors or administrators to examine the conditions set for releasing content to stu… | courseId, contentId, ruleId, criterionId |
BLACKBOARD_GET_ANNOUNCEMENT | Retrieves a specific announcement from the blackboard learn platform using its unique identifier. this endpoint allows users to fetch detailed information about a single announcement, such as its title, content, publication date, and author. it's particularly… | announcementId |
BLACKBOARD_GET_ANNOUNCEMENTS | Retrieves a list of announcements from the blackboard learn platform. this endpoint allows users to fetch announcements, which are important messages or updates shared within courses or across the institution. it can be used to display recent announcements to… | - |
BLACKBOARD_GET_ATTEMPT_FILE_META_DATA | Retrieves a specific file associated with a student's attempt in a course's gradebook within the blackboard learn system. this endpoint allows authorized users, such as instructors or administrators, to access individual files submitted as part of a student's… | courseId, attemptId, attemptFileId |
BLACKBOARD_GET_ATTEMPT_FILE_META_DATA_LIST | Retrieves the files associated with a specific gradebook attempt for a given course in the blackboard learning management system. this endpoint allows access to student-submitted files for a particular assignment or assessment attempt. it is useful for instru… | courseId, attemptId |
BLACKBOARD_GET_ATTEMPT_RECEIPT | Retrieves detailed information about a specific attempt receipt in the blackboard learning management system. this endpoint allows users to access data related to a student's attempt on an assessment, test, or other evaluated activity. it should be used when… | attemptReceiptId |
BLACKBOARD_GET_ATTENDANCE_RECORD | Returns a course meeting attendance information for the given meeting and user id. the "course.attendance.view" entitlement is required to view a course meeting attendance. since: 3500.7.0 | courseId, meetingId, userId |
BLACKBOARD_GET_ATTENDANCE_RECORDS_BY_MEETING_ID | Returns a list of course meeting attendance for a given meeting id. the "course.attendance.view" entitlement is required to view a course meeting attendance. since: 3500.7.0 | courseId, meetingId |
BLACKBOARD_GET_ATTENDANCE_RECORDS_BY_USER_ID | Retrieves detailed information about a specific user's participation or engagement in meetings for a particular course within the blackboard learning management system. this endpoint is useful for instructors, administrators, or analytics tools to gather data… | courseId, userId |
BLACKBOARD_GET_CALENDARS | Get the list of calendars. this endpoint will return all calendars viewable by the user. all users can request a list of calendars viewable to them. since: 3400.9.0 | - |
BLACKBOARD_GET_CALENDAR_ITEM | Retrieves detailed information about a specific calendar item from the blackboard learning management system. this endpoint allows you to fetch data for a single calendar entry, such as an event, appointment, or assignment, based on its type and unique identi… | calendarItemType, calendarItemId |
BLACKBOARD_GET_CALENDAR_ITEMS | Retrieves calendar items from the blackboard learn platform. this endpoint allows users to fetch a list of calendar events, which may include course schedules, assignment deadlines, and institution-wide events. it provides access to the integrated calendar sy… | - |
BLACKBOARD_GET_CATEGORIES | Retrieves a list of categories from the blackboard catalog based on the specified category type. this endpoint is used to fetch organized groups of resources or content within the blackboard learn platform, such as course categories, program categories, or de… | categoryType |
BLACKBOARD_GET_CATEGORY | Retrieves detailed information about a specific category in the blackboard catalog system. this endpoint allows users to access category data based on the category type and its unique identifier. it is useful for obtaining metadata, structure, or any other re… | categoryType, categoryId |
BLACKBOARD_GET_CHILD | Retrieves detailed information about a specific child course within a parent course in the blackboard learn platform. this endpoint is useful for accessing hierarchical course structures, allowing developers to fetch data about nested or sub-courses. use this… | courseId, childCourseId |
BLACKBOARD_GET_CHILDREN_GOALS | Retrieves the child elements (sub-goals, tasks, or related items) of a specified goal in the blackboard learning management system. this endpoint is used to fetch the hierarchical structure of educational objectives, allowing users to view and manage the brea… | goalId |
BLACKBOARD_GET_CHILD_CATEGORIES | Retrieves the child categories of a specified parent category within the blackboard catalog system. this endpoint allows users to navigate through the hierarchical structure of categories, which is crucial for organizing and accessing educational content. it… | categoryType, parentId |
BLACKBOARD_GET_COLUMN_ATTEMPT | Retrieves detailed information about a specific attempt for a gradebook column within a course in the blackboard learn system. this endpoint allows users to access individual submission data, such as scores, comments, or other relevant information associated… | courseId, columnId, attemptId |
BLACKBOARD_GET_COLUMN_ATTEMPTS | Retrieves attempt data for a specific gradebook column within a course in the blackboard learn platform. this endpoint allows users to access detailed information about student attempts for a particular assessment or assignment. it's useful for analyzing stud… | courseId, columnId |
BLACKBOARD_GET_COLUMN_GRADE | Retrieves a specific user's grade for a particular gradebook column in a blackboard course. this endpoint is useful for accessing individual student performance data within a course, allowing for targeted grade retrieval and analysis. it should be used when d… | courseId, columnId, userId |
BLACKBOARD_GET_COLUMN_GRADES | Retrieves user data associated with a specific gradebook column for a given course in blackboard. this endpoint allows educators and administrators to access detailed information about students' performance or participation in a particular graded item or cate… | courseId, columnId |
BLACKBOARD_GET_COLUMN_GRADE_LAST_CHANGED | Retrieves information about the last changes made to a specific gradebook column for a particular course in blackboard. this endpoint is useful for tracking recent modifications to grades, comments, or other gradebook data, enhancing transparency and accounta… | courseId, columnId |
BLACKBOARD_GET_COLUMN_GROUP_ATTEMPTS | Retrieves group attempts data for a specific gradebook column within a course in blackboard learn. this endpoint allows users to access detailed information about group submissions, including submission dates, grades, and potentially group member contribution… | columnId |
BLACKBOARD_GET_CONTENT | Retrieves specific content within a blackboard course using the course id and content id. this endpoint allows users to access detailed information about a particular content item, such as a lecture, assignment, or resource, within the context of a specific c… | courseId, contentId |
BLACKBOARD_GET_CONTENTS | Retrieves the contents of a specific course in the blackboard learn platform. this endpoint allows you to fetch all learning materials, resources, and content items associated with a given course. it should be used when you need to access or display the struc… | courseId |
BLACKBOARD_GET_CONTENT_CHILDREN | Retrieves a list of child content items for a specific content within a blackboard learn course. this endpoint is used to navigate the hierarchical structure of course materials, allowing users to explore sub-items or nested content within a parent content it… | courseId, contentId |
BLACKBOARD_GET_CONTENT_COLLECTION_RESOURCE | Retrieves a specific resource from a content collection in blackboard learn. this endpoint allows developers to access detailed information about a particular resource, such as a document, video, or other educational material, stored within blackboard's conte… | resourceId |
BLACKBOARD_GET_CONTENT_GROUP | Retrieves detailed information about a specific group within a content item of a course in the blackboard learn platform. this endpoint is used to access group-related data, such as group name, description, membership, and any associated settings or propertie… | courseId, contentId, groupId |
BLACKBOARD_GET_CONTENT_GROUPS | Retrieves the groups associated with a specific content item within a blackboard course. this endpoint is useful for understanding the group structure or permissions related to particular course content. it should be used when you need to list all groups that… | courseId, contentId |
BLACKBOARD_GET_COURSE | Retrieves detailed information about a specific course in the blackboard learn system. this endpoint is used to access course data such as title, description, availability, enrollment information, and other course-specific attributes. it's particularly useful… | courseId |
BLACKBOARD_GET_COURSES | Retrieves a list of courses from the blackboard learning management system. this endpoint allows users to fetch information about multiple courses at once, providing an overview of the available courses within the institution's blackboard environment. it's pa… | - |
BLACKBOARD_GET_COURSE_CHILDREN | Retrieves a list of child courses or sub-courses associated with a specified parent course in the blackboard learn platform. this endpoint is useful for exploring the hierarchical structure of courses, such as main courses and their associated sections or mod… | courseId |
BLACKBOARD_GET_COURSE_COLUMN_LOGS | Retrieves the log entries for a specific gradebook column within a blackboard course. this endpoint provides a detailed history of all actions and changes made to the specified gradebook column, including grade modifications, updates to comments, and other re… | courseId, columnId |
BLACKBOARD_GET_COURSE_GOAL_ALIGNMENTS | Retrieves the course goal alignments for a specified course in blackboard. this endpoint allows users to fetch detailed information about how course goals are linked to specific learning objectives within a particular course. it is essential for educators and… | courseId |
BLACKBOARD_GET_COURSE_GRADEBOOK_LOGS | Retrieves the gradebook logs for a specific course in the blackboard learning management system. this endpoint provides a historical record of all gradebook-related activities and changes within the specified course. it's particularly useful for instructors a… | courseId |
BLACKBOARD_GET_COURSE_MEETING | Retrieves detailed information about a specific meeting within a course in the blackboard learning management system. this endpoint is used to fetch comprehensive data about a scheduled meeting, including its date, time, duration, participants, and any associ… | meetingId |
BLACKBOARD_GET_COURSE_MEETINGS | Retrieves a list of meetings associated with a specific course in the blackboard learning management system. this endpoint is used to fetch details about scheduled meetings, such as virtual classroom sessions, office hours, or other course-related events. it… | courseId |
BLACKBOARD_GET_COURSE_MEMBERSHIPS | Retrieves a list of users enrolled in a specific course within the blackboard learning management system. this endpoint is used to access information about students, instructors, and other roles associated with a particular course. it's particularly useful fo… | courseId |
BLACKBOARD_GET_COURSE_RESOURCE | Retrieves a specific resource from a particular course within the blackboard learning management system. this endpoint is used to access detailed information about a single course resource, such as a document, assignment, or any other learning material. it sh… | courseId, resourceId |
BLACKBOARD_GET_COURSE_RESOURCE_CHILDREN | Retrieves a list of child resources associated with a specific resource within a blackboard course. this endpoint is useful for exploring the hierarchical structure of course materials, such as folders, documents, or assignments nested within a parent resourc… | courseId, resourceId |
BLACKBOARD_GET_COURSE_ROLE | Retrieves detailed information about a specific course role in blackboard learn using its unique identifier. this endpoint is used to fetch the properties, permissions, and settings associated with a particular role within a course. it's essential for underst… | roleId |
BLACKBOARD_GET_COURSE_ROLES | Retrieves a list of available course roles in the blackboard learn system. this endpoint allows users to fetch all predefined roles that can be assigned to users within courses. it is useful for administrators and developers who need to understand the availab… | - |
BLACKBOARD_GET_CRITERIA | Retrieves the criteria associated with a specific adaptive release rule for a particular content item within a blackboard course. this endpoint allows instructors or administrators to view the conditions that must be met for students to access the content. it… | courseId, contentId, ruleId |
BLACKBOARD_GET_CROSS_LIST_SET | Retrieves the cross-listed course set for a specified course in blackboard learn. this endpoint is used to obtain information about courses that are linked together, typically representing different sections of the same course that share content. it's particu… | courseId |
BLACKBOARD_GET_CURRENT_ACTIVE_USER_BY_ID | Retrieves the active or historical sessions for a specific user in the blackboard learn platform. this endpoint allows developers to access detailed information about a user's interaction with the system, including login times, duration, and potentially other… | userId |
BLACKBOARD_GET_DATA_SOURCE | Retrieves detailed information about a specific data source within the blackboard learn platform. this endpoint allows you to access metadata and configuration details for a particular data source, which can be crucial for understanding the origin and nature… | dataSourceId |
BLACKBOARD_GET_DATA_SOURCES | Retrieves a list of data sources available in the blackboard learning management system. this endpoint provides information about various data sources that can be used for integrating external systems, reporting, or data analysis within the blackboard platfor… | - |
BLACKBOARD_GET_DISCUSSION | Retrieves detailed information about a specific discussion thread within a course on the blackboard learn platform. this endpoint allows users to access the content, metadata, and other relevant details of a discussion, enabling them to view or analyze discus… | courseId, discussionId |
BLACKBOARD_GET_DISCUSSIONS | Retrieves all discussions associated with a specific course in the blackboard learning management system. this endpoint allows developers to access the discussion forums and threads for a particular course, enabling integration of course discussions into exte… | courseId |
BLACKBOARD_GET_DISCUSSION_MESSAGES | Retrieves all messages within a specific discussion for a given course in the blackboard learning management system. this endpoint allows users to fetch the entire conversation thread, including all posts and replies, for a particular discussion topic. it's u… | courseId, discussionId |
BLACKBOARD_GET_DOMAIN_CONFIG | Retrieves detailed information about a specific lti (learning tools interoperability) domain within the blackboard learn system. this endpoint is used to fetch configuration details, status, and other relevant information for a particular lti domain integrati… | domainId |
BLACKBOARD_GET_DOMAIN_CONFIGS | Retrieves a list of lti (learning tools interoperability) domains registered with the blackboard learn platform. this endpoint is used to obtain information about the external tools and platforms that have been integrated with blackboard using the lti specifi… | - |
BLACKBOARD_GET_FILE_ATTACHMENT | Retrieves detailed information about a specific attachment associated with a particular content item within a blackboard course. this endpoint allows users to access metadata and potentially the content of an attachment, such as a document, image, or other fi… | courseId, contentId, attachmentId |
BLACKBOARD_GET_FILE_ATTACHMENTS | Retrieves the attachments associated with a specific content item within a blackboard course. this endpoint allows users to access files, documents, or other resources that have been attached to a particular piece of course content. it's useful for applicatio… | courseId, contentId |
BLACKBOARD_GET_FOLDERS | Retrieves a list of message folders for a specific course in the blackboard learning management system. this endpoint allows users to access the organizational structure of course messages, providing an overview of how communication is categorized within the… | courseId |
BLACKBOARD_GET_GOALS | The getgoals endpoint retrieves a list of educational goals within the blackboard learning management system. it provides access to goal information that can be used to track student progress, align curriculum with objectives, or generate reports on learning… | - |
BLACKBOARD_GET_GOALS_FROM_SET_AND_CATEGORY | This endpoint retrieves a list of goals associated with a specific category within a goal set in the blackboard learning management system. it allows administrators and educators to access and review the goals that have been set for a particular category, ena… | goalSetCategoryId, goalSetId |
BLACKBOARD_GET_GOAL_ALIGNMENTS | Retrieves the alignments associated with a specific educational goal in the blackboard learning management system. this endpoint allows users to fetch the learning activities or assessments that are linked to a particular goal, enabling educators and administ… | goalId |
BLACKBOARD_GET_GOAL_BY_ID | Retrieves detailed information about a specific learning goal within the blackboard learn platform. this endpoint allows educators and administrators to access comprehensive data about an individual goal, including its description, associated courses, and pro… | goalId |
BLACKBOARD_GET_GOAL_SETS | Retrieves a list of goal sets from the blackboard learn platform. this endpoint allows users to fetch collections of goals, which are likely used for organizing and categorizing educational objectives within the system. it's part of the public api, making it… | - |
BLACKBOARD_GET_GOAL_SET_BY_ID | Retrieves detailed information about a specific goal set within the blackboard learning management system. this endpoint allows educators and administrators to access comprehensive data about a particular collection of educational objectives or targets. it sh… | goalSetId |
BLACKBOARD_GET_GOAL_SET_CATEGORY_BY_ID | Retrieves detailed information about a specific goal category within a designated goal set in the blackboard learn platform. this endpoint allows users to access the properties and metadata of a particular goal category, which is useful for understanding the… | goalSetId, goalSetCategoryId |
BLACKBOARD_GET_GRADEBOOK_CATEGORIES | Retrieves the list of gradebook categories for a specific course in the blackboard learning management system. this endpoint allows users to fetch the organizational structure of a course's gradebook, including the categories used to group different types of… | courseId |
BLACKBOARD_GET_GRADEBOOK_CATEGORY | Retrieves detailed information about a specific gradebook category within a course in the blackboard learning management system. this endpoint allows users to access important data about how grades are organized and weighted within a course, which is crucial… | courseId, categoryId |
BLACKBOARD_GET_GRADE_COLUMN | Retrieves detailed information about a specific gradebook column within a particular course in the blackboard learning management system. this endpoint allows users to access the properties and settings of an individual grading column, such as its name, descr… | courseId, columnId |
BLACKBOARD_GET_GRADE_COLUMNS | Retrieves a list of gradebook columns for a specified course in the blackboard learn environment. this endpoint allows users to access detailed information about the structure and components of a course's gradebook. it should be used when there's a need to vi… | courseId |
BLACKBOARD_GET_GRADE_NOTATION | Retrieves detailed information about a specific grade notation within a course's gradebook in the blackboard learning management system. this endpoint allows users to fetch individual grade notation data, which may include the notation symbol, description, an… | courseId, gradeNotationId |
BLACKBOARD_GET_GRADE_NOTATIONS | Retrieves the grade notations for a specific course's gradebook in the blackboard learning management system. grade notations are symbols or short texts used to represent specific grading statuses or conditions (e.g., 'a', 'b+', 'incomplete', 'withdrawn'). th… | courseId |
BLACKBOARD_GET_GRADE_SCHEMAS | Retrieves the gradebook schemas for a specific course in the blackboard learning management system. this endpoint allows developers to access the structure and format of the gradebook data for a given course, which is crucial for understanding how grades are… | courseId |
BLACKBOARD_GET_GRADING_PERIOD | Retrieves detailed information about a specific gradebook period within a course in the blackboard learning management system. this endpoint allows users to access important data related to a particular grading period, such as its start and end dates, associa… | courseId, periodId |
BLACKBOARD_GET_GRADING_PERIODS | Retrieves the gradebook periods for a specified course in the blackboard learning management system. this endpoint allows users to fetch information about the temporal structure of grade entries and assessments within a particular course. it is useful for und… | courseId |
BLACKBOARD_GET_GROUP | Retrieves detailed information about a specific group within a particular course in the blackboard learning management system. this endpoint is used to access group data, which may include the group's name, description, membership, and other relevant details.… | courseId, groupId |
BLACKBOARD_GET_GROUPS | Retrieves a list of all groups associated with a specific course in the blackboard learning management system. this endpoint is useful for obtaining information about the various student groups, project teams, or study circles within a particular course. it s… | courseId |
BLACKBOARD_GET_GROUP_MEMBERSHIP | Retrieves detailed information about a specific user's membership or role within a group in a particular course on the blackboard platform. this endpoint is used to access user-specific data in the context of their group participation within a course. it prov… | courseId, groupId, userId |
BLACKBOARD_GET_GROUP_MEMBERSHIPS | Retrieves a list of users belonging to a specific group within a blackboard learn course. this endpoint is used to access user information for group-based activities, collaborative assignments, or administrative purposes. it provides details about the members… | groupId, courseId |
BLACKBOARD_GET_GROUP_SET | Retrieves detailed information about a specific group set within a course in the blackboard learning management system. this endpoint allows users to fetch the properties and configuration of a particular group set, which may include details such as the group… | courseId, groupId |
BLACKBOARD_GET_GROUP_SETS | Retrieves all group sets associated with a specific course in the blackboard learning management system. group sets are collections of groups within a course that can be used for various collaborative activities, such as group projects, discussions, or assign… | courseId |
BLACKBOARD_GET_GROUP_SET_CHILDREN | Retrieves a list of groups within a specific group set for a given course in the blackboard learning management system. this endpoint allows educators and administrators to access detailed information about the groups created within a particular group set, fa… | groupId, courseId |
BLACKBOARD_GET_INFO | Retrieves system information about the blackboard learn platform. this endpoint provides essential metadata about the current state of the blackboard system, which can include details such as the platform version, configuration settings, and operational statu… | - |
BLACKBOARD_GET_INSTITUTION_ROLE | Retrieves detailed information about a specific institutional role in the blackboard learning management system. this endpoint should be used when you need to access the properties, permissions, or settings associated with a particular role within an educatio… | roleId |
BLACKBOARD_GET_INSTITUTION_ROLES | Retrieves a list of all institution roles defined within the blackboard learn environment. this endpoint is crucial for administrators and developers who need to understand and manage the various roles available in their institution's blackboard system. it pr… | - |
BLACKBOARD_GET_LOGIN_AS_SESSIONS | Retrieves active login sessions for users in the blackboard learning management system. this endpoint is used to monitor and manage current user sessions across the platform. it provides a list of all ongoing login sessions, which can be crucial for system ad… | - |
BLACKBOARD_GET_MEMBERSHIP | Retrieves detailed information about a specific user within a particular course in the blackboard learning management system. this endpoint is used to fetch user-specific data in the context of a given course, which may include enrollment status, role in the… | courseId, userId |
BLACKBOARD_GET_MEMBERSHIPS | Retrieves a list of courses associated with a specific category in the blackboard catalog. this endpoint allows users to fetch course information based on the category type and category id, providing a way to browse or search for courses within a particular o… | categoryType, categoryId |
BLACKBOARD_GET_MESSAGES | Retrieves all messages associated with a specific course in the blackboard learning management system. this endpoint is used to access course-related communication, announcements, and notifications. it provides a comprehensive view of all messages within the… | courseId |
BLACKBOARD_GET_MESSAGE_PARTICIPANTS | Retrieves a list of participants for a specific message within a blackboard course. this endpoint allows users to access information about who is involved in a particular course message, which can be useful for tracking student engagement, managing communicat… | courseId, messageId |
BLACKBOARD_GET_MESSAGE_REPLIES | Retrieves all replies to a specific message within a discussion thread of a course in the blackboard learning management system. this endpoint allows users to access the responses and interactions related to a particular message in a course discussion. it is… | courseId, discussionId, messageId |
BLACKBOARD_GET_NODE | Retrieves detailed information about a specific node within the institutional hierarchy of blackboard. this endpoint allows users to fetch data about a particular component or entity in the educational institution's structure. it should be used when specific… | nodeId |
BLACKBOARD_GET_NODES | Retrieves information about the nodes within the institutional hierarchy of a blackboard learning environment. this endpoint allows users to fetch data representing the organizational structure of an educational institution, such as departments, schools, or o… | - |
BLACKBOARD_GET_NODES_FOR_COURSE | Retrieves a list of nodes (modules or units) for a specific course in the blackboard learning management system. this endpoint allows developers to access the structure and content organization of a course, enabling them to build applications that can navigat… | courseId |
BLACKBOARD_GET_NODES_FOR_USER | Retrieves a list of nodes associated with a specific user in the blackboard learn platform. nodes typically represent courses, organizations, or content areas that the user has access to. this endpoint is useful for obtaining an overview of a user's course en… | userId |
BLACKBOARD_GET_NODE_ADMIN | Retrieves the administrative status of a specific user for a particular node within the blackboard institutional hierarchy. this endpoint allows you to check whether a user has administrative privileges for a given organizational unit, such as a department or… | nodeId, userId |
BLACKBOARD_GET_NODE_ADMINS | Retrieves the list of administrators associated with a specific node in the blackboard institutional hierarchy. this endpoint is used to fetch administrative information for a particular organizational unit, such as a department, school, or program within an… | nodeId |
BLACKBOARD_GET_NODE_CHILDREN | Retrieves the immediate child nodes of a specified parent node in the blackboard learn institutional hierarchy. this endpoint is used to navigate and explore the hierarchical structure of an educational institution, allowing administrators and authorized user… | nodeId |
BLACKBOARD_GET_NODE_COURSE_ASSOCIATIONS | Retrieves a list of courses associated with a specific node in the institutional hierarchy of blackboard. this endpoint is used to fetch all courses linked to a particular organizational unit (such as a department, faculty, or program) within the educational… | nodeId |
BLACKBOARD_GET_NODE_USER_ASSOCIATIONS | Retrieves a list of users associated with a specific node in the blackboard learn institutional hierarchy. this endpoint allows administrators and authorized users to fetch user information within the context of the institution's organizational structure. it… | nodeId |
BLACKBOARD_GET_OBSERVEES | Retrieves a list of observees associated with a specific user in the blackboard learning management system. this endpoint is used to fetch information about individuals or entities that the specified user is authorized to observe or monitor within the system.… | userId |
BLACKBOARD_GET_OBSERVERS | Retrieves the list of observers associated with a specific user in the blackboard learning management system. this endpoint is used to fetch information about individuals or entities that have been granted observer access to a particular user's activities and… | userId |
BLACKBOARD_GET_PLACEMENT | Retrieves detailed information about a specific lti (learning tools interoperability) placement within the blackboard learn platform. this endpoint allows developers and administrators to fetch the configuration, settings, and integration details for a partic… | placementId |
BLACKBOARD_GET_PLACEMENTS | Retrieves a list of all available lti (learning tools interoperability) placements within the blackboard learn environment. this endpoint allows developers and administrators to obtain information about where external learning tools can be integrated within t… | - |
BLACKBOARD_GET_POLICIES | Retrieves the current privacy policy for the blackboard system. this endpoint provides access to the most up-to-date privacy policy information, which is crucial for understanding how user data is handled and protected within the blackboard platform. it shoul… | - |
BLACKBOARD_GET_PROCTORING_SERVICE | Retrieves detailed information about a specific proctoring service integrated with blackboard learn. this endpoint allows users to fetch configuration details, availability status, and other relevant information for a particular online exam proctoring solutio… | proctoringServiceId |
BLACKBOARD_GET_PROCTORING_SERVICES | Retrieves a list of available proctoring services integrated with the blackboard learn platform. this endpoint is part of blackboard's proctoring services framework and is designed to support online examination security. it should be used when administrators… | - |
BLACKBOARD_GET_PRONOUNS | Retrieves the list of available pronouns in the blackboard learning management system. this endpoint is used to fetch the predefined set of pronouns that users can choose from when setting up or updating their profile. it's particularly useful for application… | - |
BLACKBOARD_GET_QUESTIONS | Retrieves a list of questions for a specific assessment within a blackboard course. this endpoint allows users to access the questions associated with a particular assessment, such as a quiz, test, or assignment, in a given course. it's useful for instructors… | courseId, assessmentId |
BLACKBOARD_GET_QUESTION_BY_ID | Retrieves detailed information about a specific question within an assessment for a particular course in the blackboard learning management system. this endpoint allows users to access question content, type, scoring information, and other relevant details. i… | courseId, assessmentId, questionId |
BLACKBOARD_GET_RESOURCES | Retrieves a list of resources from a specified content collection within a blackboard learn course. this endpoint enables access to various educational materials in a course's content collection. it supports pagination and is useful for applications that need… | - |
BLACKBOARD_GET_RESOURCE_CHILDREN | Retrieves a list of child resources for a specified parent resource within the blackboard content collection. this endpoint is used to navigate through the hierarchical structure of educational content, allowing users to explore sub-items or nested resources… | resourceId |
BLACKBOARD_GET_REVIEW_STATUS | Retrieves the review status of a specific content item for a particular user within a blackboard learn course. this endpoint is useful for instructors or administrators to track whether a student has reviewed or interacted with a particular piece of course co… | courseId, contentId, userId |
BLACKBOARD_GET_REVIEW_STATUS_BY_COURSE_ID | Retrieves the content review status for a specific course in the blackboard learning management system. this endpoint provides information about the current state of content reviews within the course, which may include details such as the number of items pend… | courseId |
BLACKBOARD_GET_RUBRICS | Retrieves all rubrics associated with a specific course in the blackboard learn platform. this endpoint allows users to access the grading criteria and assessment tools set up for a particular course. it's useful for instructors, teaching assistants, or admin… | courseId |
BLACKBOARD_GET_RUBRIC_ASSOCIATIONS | Retrieves the associations of a specific rubric within a given course in blackboard learn. this endpoint allows users to fetch information about how a particular rubric is linked to various course elements such as assignments, discussions, or other assessable… | courseId, rubricId |
BLACKBOARD_GET_RUBRIC_ASSOCIATIONS_BY_COLUMN_ID | Retrieves the rubric associations for a specific gradebook column within a blackboard course. this endpoint allows users to access detailed information about how rubrics are connected to a particular grading column, which is crucial for understanding the asse… | courseId, columnId |
BLACKBOARD_GET_RUBRIC_ASSOCIATION_BY_ID | Retrieves detailed information about a specific rubric association within a blackboard learn course. this endpoint allows users to access the configuration and application details of a rubric to a particular assessment or assignment. it is particularly useful… | courseId, rubricId, rubricAssociationId |
BLACKBOARD_GET_RUBRIC_BY_ID | Retrieves a specific rubric for a given course in the blackboard learning management system. this endpoint allows users to access detailed information about a rubric, including its criteria, scoring methods, and any associated metadata. it is particularly use… | courseId, rubricId |
BLACKBOARD_GET_RUBRIC_EVALUATIONS | Retrieves the rubric evaluations for a specific attempt on a gradebook item within a blackboard course. this endpoint allows instructors or administrators to access detailed rubric-based assessment data for a particular student's submission. it is useful for… | courseId, columnId, attemptId |
BLACKBOARD_GET_RUBRIC_EVALUATION_BY_ID | Retrieves detailed information about a specific rubric evaluation within a blackboard course. this endpoint allows users to access the assessment data, including scores and feedback, for a particular rubric evaluation associated with a course component. it is… | courseId, rubricId, rubricAssociationId, rubricEvaluationId |
BLACKBOARD_GET_RULES | Retrieves the adaptive release rules associated with a specific content item within a blackboard course. this endpoint allows instructors or administrators to view the conditions under which the content becomes available to students. it should be used when th… | courseId, contentId |
BLACKBOARD_GET_SETTINGS | Retrieves the current upload settings for the blackboard learn platform. this endpoint allows administrators and authorized users to fetch the configuration parameters related to file uploads within the blackboard system. it provides information about various… | - |
BLACKBOARD_GET_SIS_LOGS_BY_DATA_SET_UID | Retrieves a specific student information system (sis) dataset from the blackboard learn platform using its unique identifier. this endpoint is used to access detailed information about a particular sis dataset, which may include student records, course enroll… | id |
BLACKBOARD_GET_SYSTEM_ROLE | Retrieves detailed information about a specific system role in the blackboard learning management system. this endpoint should be used when you need to access the properties, permissions, or other attributes associated with a particular role. it's useful for… | roleId |
BLACKBOARD_GET_SYSTEM_ROLES | Retrieves a list of all system roles defined in the blackboard learn platform. this endpoint provides comprehensive information about the various roles that can be assigned to users within the system, including their associated permissions and access levels.… | - |
BLACKBOARD_GET_SYSTEM_TASK | Retrieves detailed information about a specific system task in the blackboard learn platform. this endpoint allows developers to fetch the current status, details, and metadata of an individual task identified by its unique taskid. it should be used when moni… | taskId |
BLACKBOARD_GET_TASK | Retrieves detailed information about a specific task within a course in the blackboard learn platform. this endpoint allows users to fetch comprehensive data about an individual assignment, activity, or any other task associated with a particular course. it s… | courseId, taskId |
BLACKBOARD_GET_TERM | Retrieves detailed information about a specific academic term in the blackboard learn system. this endpoint is used to fetch comprehensive data about a term, such as its name, start date, end date, and any associated metadata. it's particularly useful for app… | termId |
BLACKBOARD_GET_TERMS | Retrieves a list of academic terms or information about specific terms in the blackboard learning management system. this endpoint provides access to term definitions, including start and end dates, term names, and other relevant metadata. it's useful for app… | - |
BLACKBOARD_GET_TOC_ITEMS | Retrieves the table of contents (toc) items for a specified course in the blackboard learning management system. this endpoint provides access to the structured organization of educational materials within a course, including modules, lessons, assignments, an… | courseId |
BLACKBOARD_GET_TOKEN_INFO | Retrieves detailed information about a specified oauth2 token used for authentication in the blackboard learn api. this endpoint allows developers to verify the validity, scope, and associated details of an access token. it should be used when an application… | access_token |
BLACKBOARD_GET_TOOLS | Retrieves detailed information about a specific tool associated with a particular node in the blackboard institutional hierarchy. this endpoint is used to fetch configuration, settings, or status details for a given tool type within a specific organizational… | nodeId, toolType |
BLACKBOARD_GET_TOP_LEVEL_COURSE_RESOURCES | Retrieves a list of resources associated with a specific course in the blackboard learning management system (lms). this endpoint allows users to access educational materials, such as assignments, readings, and other study materials, that are linked to a part… | courseId |
BLACKBOARD_GET_TYPES | Retrieves a list of available goal set types in the blackboard learn system. this endpoint allows users to fetch information about the different categories or classifications of goal sets that can be created or managed within the learning management system. i… | - |
BLACKBOARD_GET_USER | Retrieves detailed information about a specific user in the blackboard learn system. this endpoint allows you to fetch user profile data, such as name, email, system role, and other relevant details associated with the user account. it should be used when you… | userId |
BLACKBOARD_GET_USERS | The getusersendpoint retrieves user information from the blackboard learn system. this endpoint allows you to fetch a list of users with their associated details, supporting various query parameters for filtering, sorting, and pagination. it's particularly us… | - |
BLACKBOARD_GET_USER_AVATAR | Retrieves the avatar (profile picture) for a specified user in the blackboard learn platform. this endpoint allows you to fetch the current profile image associated with a user's account based on their unique user id. it should be used when you need to displa… | userId |
BLACKBOARD_GET_USER_GRADES | Retrieves detailed gradebook information for a specific user within a particular course in the blackboard learning management system. this endpoint allows educators, administrators, or authorized users to access individual student performance data, including… | courseId, userId |
BLACKBOARD_GET_USER_MEMBERSHIPS | Retrieves a list of courses associated with a specific user in the blackboard learn platform. this endpoint is used to fetch all courses that a user is enrolled in or has access to, providing essential information for course management and user-specific conte… | userId |
BLACKBOARD_GET_USER_PRONUNCIATION_AUDIO | Retrieves the pronunciation audio associated with a specific user's profile in blackboard learn. this endpoint allows applications to access the audio file that contains the correct pronunciation of the user's name. it should be used when there's a need to pl… | userId |
BLACKBOARD_GET_VERSION | Retrieves the current version information of the blackboard learn system. this endpoint should be used when developers or administrators need to check the specific version of the blackboard instance they are working with. it's particularly useful for ensuring… | - |
BLACKBOARD_GRADE_ACCESS_WITH_RIGHTS_VALIDATION | Retrieves a specific user's grade for a particular gradebook column in a blackboard learn course. this endpoint allows instructors or administrators to fetch individual grade entries, providing a targeted way to access student performance data. it's particula… | courseId, columnId, userId |
BLACKBOARD_GROUP_MEMBERSHIP_API_DETAILS | Retrieves a list of users belonging to a specific group within a course in the blackboard learning management system. this endpoint is useful for obtaining detailed information about group members, such as their names, roles, and other relevant data. it shoul… | groupId, courseId |
BLACKBOARD_INITIALIZE_EDUCATIONAL_ENTITY | Creates a new course in the blackboard learn system with specified attributes and settings. this endpoint allows for the creation of both academic courses and organizational units, with extensive customization options for course properties, availability, enro… | courseId, name |
BLACKBOARD_INITIATE_GROUP_MEMBER_ADDITION | Updates a user's information within a specific group of a course in blackboard learn. this endpoint allows for modifying user-related data or settings in the context of a particular course group. it should be used when changes need to be made to a user's stat… | courseId, groupId, userId |
BLACKBOARD_LIST_GOAL_SET_CATEGORIES | Retrieves the categories associated with a specific goal set in the blackboard learning management system. this endpoint is used to fetch the organizational structure of educational objectives within a predefined set of goals. it should be used when needing t… | goalSetId |
BLACKBOARD_LIST_GRADEBOOK_COLUMNS | Retrieves all gradebook columns for a specified course in the blackboard learning management system. this endpoint allows instructors or authorized users to access the structure and details of the gradebook for a particular course. it returns information abou… | courseId |
BLACKBOARD_LOAD_COURSE_GROUP_DETAILS | Retrieves detailed information about a specific group within a blackboard course. this endpoint is used to fetch comprehensive data about a group, including its name, description, membership details, and other relevant attributes. it's particularly useful for… | courseId, groupId |
BLACKBOARD_LOAD_COURSE_GROUP_USER_INFO | Retrieves detailed information about a specific user within a group in a blackboard learn course. this endpoint allows developers to access user data in the context of both the course and the group, providing insights into the user's role, permissions, and ac… | courseId, groupId, userId |
BLACKBOARD_MANAGE_COURSE_DATA_ACCESS | Retrieves a list of courses from the blackboard learn environment. this endpoint is essential for applications that need to access and display course information within the learning management system (lms). it allows developers to fetch course data for variou… | - |
BLACKBOARD_MANUAL_GRADE_COLUMN_CREATION | Creates a new grade column in a blackboard course's gradebook. this endpoint allows instructors or administrators to add a new column for recording and managing student grades within a specific course. it provides extensive customization options for grading m… | courseId, name |
BLACKBOARD_MANUAL_GRADE_COLUMN_MODIFICATION | This endpoint allows for updating specific properties of an existing grade column within a course's gradebook in the blackboard learn platform. it provides granular control over various aspects of the grade column, including its metadata, scoring configuratio… | courseId, columnId |
BLACKBOARD_MODIFY_COURSE_ANNOUNCEMENT_ACCESS | This endpoint allows you to update an existing course announcement in the blackboard learn platform. it can modify the announcement's title, body content, draft status, and availability settings. the body content supports rich text formatting using bbml (blac… | announcementId, courseId |
BLACKBOARD_PATCH_TOOL | This endpoint allows you to update the settings of a specific tool within a node of blackboard's institutional hierarchy. it provides granular control over tool availability and configuration for different user types (regular, guest, and observer). use this e… | nodeId, toolType, toolId |
BLACKBOARD_POST_ULTRA_COURSE_DISCUSSION_REPLY | Posts a new message to a specific discussion within a blackboard learn course. this endpoint allows users to contribute to course discussions by adding new messages, supporting both general course discussions and group-specific discussions. it provides option… | courseId, discussionId, body |
BLACKBOARD_REMOVE_CHILD_COURSE | Deletes a specified child course from a parent course in the blackboard learning management system. this endpoint is used to remove a sub-course or section from the main course structure, helping to organize and manage course hierarchies. it should be used wh… | courseId, childCourseId |
BLACKBOARD_REMOVE_COURSE_GROUP | This endpoint removes a specific user from a designated group within a course in blackboard learn. it is used when an administrator or instructor needs to adjust group membership, such as when a student changes project teams or is no longer part of a specific… | courseId, groupId, userId |
BLACKBOARD_REMOVE_COURSE_NOTICE | This endpoint deletes a specific announcement within a course in the blackboard learn platform. it allows administrators or authorized users to remove outdated, incorrect, or unnecessary announcements from a course, helping to maintain clear and relevant comm… | announcementId, courseId |
BLACKBOARD_REMOVE_SPECIFIC_GRADE_FIELD | Deletes a specific gradebook column from a course in blackboard learn. this endpoint allows instructors or administrators to remove a column from the gradebook, which may be necessary for course restructuring or correcting errors in grade calculations. it sho… | courseId, columnId |
BLACKBOARD_REMOVE_ULTRA_COURSE_DISCUSSION_POST | This endpoint allows for the deletion of a specific message within a discussion thread in a blackboard course. it should be used when an instructor or authorized user needs to remove inappropriate, outdated, or incorrect content from a course discussion. the… | courseId, discussionId, messageId |
BLACKBOARD_REQUEST_TOKEN | Obtains an oauth2 token for authenticating and authorizing requests to the blackboard api. this endpoint is essential for securing access to blackboard's resources and should be used before making any api calls that require authentication. the token obtained… | - |
BLACKBOARD_RETRIEVE_STUDENT_SUBMISSION_FILE | This endpoint allows for downloading a specific file associated with a student's attempt on an assignment within a blackboard course. it retrieves the file content based on the provided course, attempt, and file identifiers. this tool should be used when acce… | courseId, attemptId, attemptFileId |
BLACKBOARD_REVISE_ULTRA_COURSE_DISCUSSION_POST | Updates a specific message within a course discussion on the blackboard platform. this endpoint allows for modifying the status and/or content of an existing message. it can be used to publish drafts, soft-delete messages, or update the body text of a message… | courseId, discussionId, messageId |
BLACKBOARD_ROLE_BASED_GRADE_ATTEMPT_VISIBILITY | Retrieves attempt data for a specific gradebook column within a blackboard course. this endpoint allows instructors and administrators to access detailed information about student attempts on assignments, tests, or other graded activities associated with the… | courseId, columnId |
BLACKBOARD_SECURE_GRADE_ATTEMPT_VERSION | Retrieves detailed information about a specific attempt for a gradebook column in a blackboard course. this endpoint allows instructors or authorized users to access individual student attempt data, including scores, submission dates, and potentially feedback… | courseId, columnId, attemptId |
BLACKBOARD_SET_NODE_ADMIN_ASSOCIATION | Updates the roles of an administrative user for a specific node within the institutional hierarchy of blackboard. this endpoint allows you to modify the permissions and responsibilities of an admin user by assigning or changing their roles for a particular no… | nodeId, userId, nodeRoles |
BLACKBOARD_SYNCHRONOUS_COURSE_OR_ORG_REMOVAL | The deletecourse endpoint permanently removes a specific course from the blackboard learn platform. this operation deletes all associated course content, assignments, and student data for the specified course. it should be used with extreme caution, typically… | courseId |
BLACKBOARD_UPDATE_ADAPTIVE_RELEASE_RULE_CRITERION | Updates a specific criterion within an adaptive release rule for a course content item in blackboard learn. this endpoint allows instructors or administrators to modify the conditions under which course materials become available to students. it can be used t… | courseId, contentId, ruleId, criterionId |
BLACKBOARD_UPDATE_ANNOUNCEMENT | This endpoint allows you to update an existing system announcement in blackboard. it provides the ability to modify the announcement's title, content (using bbml formatting), availability settings, and display options. use this endpoint when you need to chang… | announcementId |
BLACKBOARD_UPDATE_ATTENDANCE_RECORD | Update the course meeting attendance data for the given course/organization. the "course.attendance.modify" entitlement is required to update a course meeting attendance. the "course.attendance.view" entitlement is required to view a course meeting attendance… | courseId, meetingId, userId |
BLACKBOARD_UPDATE_ATTENDANCE_RECORDS | Creates or updates attendance records for the meeting for all users in the course. user required both of the entitlements below. if the user does not have the required entitlements,no records are created or modified. entitlement | user access ------------|---… | courseId, meetingId, meetingId, userId, status |
BLACKBOARD_UPDATE_CALENDAR_ITEM | This endpoint allows you to update an existing calendar item in the blackboard system. it can be used to modify various aspects of an event, assignment, or other calendar entries, including basic details, recurrence settings, and lti (learning tools interoper… | calendarItemType, calendarItemId |
BLACKBOARD_UPDATE_CATEGORY | Updates specific details of a category in the blackboard catalog system. this endpoint allows modification of various category attributes such as title, description, front page visibility, availability, access restrictions, and associated institution roles. i… | categoryType, categoryId |
BLACKBOARD_UPDATE_COLUMN_ATTEMPT | This endpoint allows for updating specific attributes of a gradebook attempt for a particular course, column, and attempt id. it is used to modify various aspects of a student's submission, including its status, score, feedback, and grading properties. the pa… | columnId, attemptId, courseId |
BLACKBOARD_UPDATE_COLUMN_GRADE | The updategrade endpoint allows instructors to modify various aspects of a student's grade for a specific course and gradebook column in the blackboard learning management system. this patch operation enables overriding grades, adding instructor notes and fee… | courseId, columnId, userId |
BLACKBOARD_UPDATE_CONTENT | This endpoint allows you to update existing content within a specific blackboard learn course. it provides extensive control over content properties, including title, body, description, position, availability, and more. use this endpoint when you need to modi… | courseId, contentId |
BLACKBOARD_UPDATE_COURSE | Updates an existing course in blackboard learn with the provided information. this endpoint allows modification of various course attributes including basic details, availability settings, enrollment options, and localization preferences. it's particularly us… | courseId |
BLACKBOARD_UPDATE_COURSE_MEETING | This endpoint allows you to update the details of a specific meeting within a course in the blackboard learning management system. it uses a patch request to modify one or more attributes of an existing meeting, such as its title, description, start and end t… | courseId, meetingId |
BLACKBOARD_UPDATE_DATA_SOURCE | This endpoint allows for updating specific attributes of an existing data source in the blackboard system. it uses the patch method to apply partial modifications to a data source identified by its unique datasourceid. the primary use case is to update the ex… | dataSourceId |
BLACKBOARD_UPDATE_DISCUSSION | Updates a specific discussion forum within a blackboard learn course. this endpoint allows for partial updates to discussion properties such as title, availability, grading options, and the main topic content. it is used when modifying existing discussions wi… | courseId, discussionId |
BLACKBOARD_UPDATE_DOMAIN_CONFIG | This endpoint allows updating an existing lti (learning tools interoperability) domain configuration in the blackboard learn platform. it is used to modify various settings related to lti tool integration, including domain information, security settings, user… | domainId |
BLACKBOARD_UPDATE_GRADE_COLUMN | This endpoint updates a specific grade column in a course's gradebook. it allows modification of column details, scoring settings, availability, grading options, and rubric associations. use it to adjust existing columns for changes in course structure or gra… | courseId, columnId |
BLACKBOARD_UPDATE_GRADE_NOTATION | This endpoint allows you to update an existing grade notation for a specific course in the blackboard learning management system. it's used to modify the performance code and/or description associated with a grade notation in the course's gradebook. this tool… | courseId, gradeNotationId |
BLACKBOARD_UPDATE_GRADING_PERIOD | Updates a specific grading period within a course's gradebook in the blackboard learn system. this endpoint allows for modification of various attributes of an existing grading period, including its title, description, position in the gradebook, date settings… | courseId, periodId |
BLACKBOARD_UPDATE_GROUP | Updates an existing group within a specified course in the blackboard learn system. this endpoint allows for modification of various group properties including its external id, name, description, availability status, and enrollment settings. it's particularly… | courseId, groupId |
BLACKBOARD_UPDATE_GROUP_SET | Updates the properties of an existing group within a specific course in the blackboard learn platform. this endpoint allows for modifying various aspects of a group, including its name, description, availability to students, and enrollment settings. it's part… | groupId, courseId |
BLACKBOARD_UPDATE_MEMBERSHIP | Updates a user's membership details within a specific blackboard course. this endpoint allows for modifying various aspects of a user's enrollment, including their role, availability, and position within the course hierarchy. it's particularly useful for mana… | courseId, userId |
BLACKBOARD_UPDATE_MESSAGE | Updates the read status of a specific message within a blackboard course. this endpoint allows you to mark a message as read or unread, which can be useful for tracking user engagement or managing message statuses. use this when you need to update the read st… | courseId, messageId |
BLACKBOARD_UPDATE_NODE | This endpoint allows for updating specific properties of a node within the institutional hierarchy of blackboard. it is used to modify existing nodes, enabling administrators to keep the institutional structure up-to-date. the endpoint supports partial update… | nodeId |
BLACKBOARD_UPDATE_NODE_COURSE_ASSOCIATION | Updates the association between a course and a node in the blackboard learn institutional hierarchy. this endpoint allows you to modify the primary status of a course-node association. use this when you need to change whether a specific node is the primary as… | nodeId, courseId |
BLACKBOARD_UPDATE_PLACEMENT | This endpoint allows you to update an existing lti (learning tools interoperability) placement in the blackboard learning management system. it provides granular control over various aspects of the placement, including its name, description, icon, url, visibi… | placementId |
BLACKBOARD_UPDATE_PRONOUN | Updates the information for a specific pronoun in the blackboard system. this endpoint allows modification of an existing pronoun's name and status, identified by the pronoun id in the url path. it's used to manage the list of available pronouns that users ca… | pronounId |
BLACKBOARD_UPDATE_QUESTION | This endpoint allows you to update an existing question within a specific assessment in a blackboard course. it provides the ability to modify various aspects of the question, including its title, content, scoring, feedback, and positioning within the assessm… | courseId, assessmentId, questionId |
BLACKBOARD_UPDATE_REVIEW_STATUS | Updates the review status of a specific content item for a particular user within a blackboard learn course. this endpoint allows for marking course materials as reviewed or not reviewed, which can be useful for tracking student progress or ensuring complianc… | courseId, contentId, userId |
BLACKBOARD_UPDATE_RUBRIC | Updates a specific rubric within a blackboard learn course. this endpoint allows for modification of various aspects of an existing rubric, including its title, description, type, and detailed grading criteria. it's used to refine assessment tools, adjust gra… | courseId, rubricId |
BLACKBOARD_UPDATE_RUBRIC_ASSOCIATION | Updates the properties of a rubric association within a specific blackboard course. this endpoint allows for modifying various aspects of how a rubric is associated with course content, including its visibility to students and its use in grading. it can be us… | courseId, rubricId, rubricAssociationId |
BLACKBOARD_UPDATE_RUBRIC_EVALUATION | Updates a specific rubric evaluation for a course in the blackboard learning management system. this endpoint allows for modifying the scores and feedback for individual criteria within a rubric that has been associated with a course item (such as an assignme… | courseId, rubricId, rubricAssociationId, rubricEvaluationId |
BLACKBOARD_UPDATE_TERM | Updates an existing term in the blackboard learn platform. this endpoint allows modification of various term properties, including its external id, name, description, availability settings, and duration. it's particularly useful for adjusting term dates, chan… | termId |
BLACKBOARD_UPDATE_TOC_ITEM | Updates the visibility settings for a specific table of contents (toc) item within a blackboard course. this endpoint allows you to modify guest and observer access permissions for a particular toc item. use this when you need to change who can view certain c… | courseId, tocId |
BLACKBOARD_UPDATE_USER | Updates a user's profile in the blackboard learning management system. this endpoint allows for partial or complete updates to various aspects of a user's account, including personal information, contact details, system roles, and preferences. it's particular… | userId |
BLACKBOARD_UPLOAD | Uploads a file to the blackboard learn platform. this endpoint allows users to add various types of educational content, such as documents, images, or multimedia files, to courses or other areas within blackboard. it should be used when new materials need to… | - |
BLACKBOARD_VIEW_COURSE_GROUP_ACCESSIBILITIES | Retrieves a list of all groups associated with a specific course in the blackboard learning management system. this endpoint allows educators and administrators to access information about the various student groups created within a particular course. it is u… | courseId |
Links
We love our partners - FlyMy.AI builds with the best. Thanks, Blackboard!