Blackboard

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 compatibility with other tools or services that integrate with blackboard, or for troubleshooting version-specific issues. the endpoint returns version details of the system, which may include the major, minor, and patch version numbers. it does not provide information about individual components or modules within the blackboard system, focusing solely on the overall system version.

Action Parameters

Action Response

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 administrators who need to review, analyze, or manage the rubrics used for assignments and assessments within a course. the endpoint returns a list of rubrics, including their titles, descriptions, and criteria, which are essential for maintaining consistent and transparent grading practices. it should be used when there’s a need to programmatically access or audit the assessment structure of a course. note that this endpoint only provides read access to rubrics and does not allow for creation, modification, or deletion of rubrics.

Action Parameters

Action Response

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 times, or associated external link. this tool is particularly useful for making changes to scheduled meetings, correcting information, or updating virtual meeting links without having to recreate the entire meeting entry. when using this endpoint, you can selectively update only the fields that need to be changed, leaving other attributes untouched. note that you must have appropriate permissions within the blackboard system to modify course meetings, and changes made through this api will be reflected in the course’s meeting schedule visible to students and instructors.

Action Parameters

Action Response

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 node. it is used when you need to adjust an admin’s access or capabilities within a specific part of the institution’s structure. the endpoint requires the node id, user id, and a list of roles to be assigned. it’s important to note that this operation replaces the existing roles for the user at the specified node, so all desired roles should be included in the request.

Action Parameters

Action Response

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 restructuring the gradebook’s temporal organization or when cleaning up unused grading periods. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint does not return the deleted data, only performs the deletion action.

Action Parameters

Action Response

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 students, instructors, or administrators, keeping them informed about course-related information, deadlines, or institutional news. the endpoint supports optional filtering by course and pagination of results. it’s particularly useful for building dashboards, notification systems, or integrating blackboard announcements into external applications. note that the specific content and visibility of announcements may depend on the user’s role and permissions within the blackboard learn system.

Action Parameters

Action Response

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 category. it should be used when there’s a need to analyze or report on student data for a specific gradebook column, such as assignment scores or participation grades. the endpoint provides a focused view of user data, limited to the context of the specified course and gradebook column, and does not include overall course performance or data from other columns.

Action Parameters

Action Response

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 of a particular group, which can be useful for instructors or administrators managing course activities. the endpoint should be used when you need to obtain user data for a specific group context, rather than for the entire course. it’s important to note that this endpoint only provides user information within the scope of the specified group and course, and does not offer details about user activities or performance outside of this context.

Action Parameters

Action Response

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 transfers, data corrections, or privacy compliance. it should be used with caution as it permanently removes all attendance records for the specified user in the given course. this operation cannot be undone, so it’s important to verify the necessity of this action before proceeding. the endpoint does not provide any information about the deleted records or return a list of affected meetings.

Action Parameters

Action Response

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 particular course. it should be used when there’s a need to fetch all available resources for a given course, which can be useful for building course content viewers, resource management tools, or for synchronizing course materials with external systems. the endpoint does not provide the actual content of the resources, but rather metadata and references to access them. it’s important to note that the accessibility of resources may depend on the user’s permissions within the blackboard system.

Action Parameters

Action Response

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 assessment. this tool is particularly useful for refining assessment questions after initial creation, adjusting difficulty levels, or incorporating new information into existing questions. it supports a wide range of question types, from simple multiple-choice to complex ai-driven chat questions, making it versatile for different educational needs. when using this endpoint, ensure that the updates maintain the integrity and educational objectives of the assessment.

Action Parameters

Action Response

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, and other content types. it should be used when needing to display or analyze the content structure of a course, such as for building a course navigation interface or auditing course materials. the endpoint returns only the toc structure and does not include the actual content of the items. it’s particularly useful for applications that need to understand or replicate the course layout without accessing the full content details.

Action Parameters

Action Response

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 used to adjust rubric settings after initial setup, enabling instructors to fine-tune their assessment strategies. the endpoint is particularly useful for changing rubric visibility or toggling whether the rubric is used for grading without creating a new association. note that this endpoint updates an existing association; it cannot create new associations or completely remove existing ones.

Action Parameters

Action Response

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 used with caution as it cannot be undone and will affect all students assigned to groups within the set. the endpoint is particularly useful for instructors or administrators who need to restructure group assignments or remove outdated group configurations. it should not be used to temporarily disable group functionality, as deletion is permanent. note that this operation does not affect the course structure itself or any other group sets within the course.

Action Parameters

Action Response

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 institutional division. it allows for the management of user data in the context of the institution’s structure, enabling administrators to keep user information accurate and up-to-date within the hierarchy. this tool should be used when there’s a need to change a user’s status, role, or other attributes specific to their position within a certain part of the institution. it’s particularly useful for large educational organizations with complex hierarchical structures.

Action Parameters

Action Response

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 availability and duration, which is crucial for managing access to educational content over time. the created term can be associated with a specific data source, enabling integration with external systems. use this endpoint when setting up a new academic year, semester, or any other defined study period in your institution’s blackboard environment.

Action Parameters

Action Response

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, or program) in the institution’s structure. this operation is typically performed when a user no longer needs access to or association with a particular part of the institution, such as when a student changes departments or a faculty member leaves a specific program. the endpoint does not delete the user from the system entirely, but only removes their association with the specified node. it’s important to note that this action may affect the user’s access rights and visibility within the blackboard learn environment related to the specific node.

Action Parameters

Action Response

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 used when an institution needs to discontinue the use of a particular lti domain, perhaps due to changes in tool usage, administrative restructuring, or cleanup of unused integrations. caution should be exercised when using this endpoint, as deletion is permanent and may affect existing course content or tool accessibility that relies on the deleted domain.

Action Parameters

Action Response

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 communication. the operation is irreversible, so it should be used with caution. this tool is particularly useful for content clean-up, managing course information, and ensuring that students only see current and applicable announcements.

Action Parameters

Action Response

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 structure and organization of goals within a course or program. it should be used when detailed information about a specific goal category is needed, such as when displaying category details or preparing for goal management tasks. the endpoint does not modify any data and is intended for read-only operations.

Action Parameters

Action Response

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 properties. it should be used when you need to fetch comprehensive information about a particular group in the context of a specific course and content item. the endpoint does not modify any data and is suitable for read-only operations. it’s particularly useful for applications that need to display or process group information within the structure of blackboard’s course content organization.

Action Parameters

Action Response

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 enrollments, or other education-related data integrated into blackboard. it’s particularly useful for administrators and developers who need to audit, analyze, or synchronize sis data with external systems. the endpoint should be used when specific dataset details are required, rather than for bulk data retrieval. note that access to sis datasets may be restricted based on user roles and permissions within the blackboard system.

Action Parameters

Action Response

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 course. it should be used when needing to understand the message folder hierarchy or before performing operations on specific message folders. the endpoint returns only the folder structure and does not include the actual messages within these folders. it’s particularly useful for applications that need to display or manage course communication organization.

Action Parameters

Action Response

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 useful for instructors reviewing assessments, students viewing their feedback, or administrators analyzing evaluation data. the endpoint requires specific identifiers for the course, rubric, association, and evaluation to pinpoint the exact evaluation record. it should be used when detailed evaluation data is needed, but won’t provide an overview of multiple evaluations or allow modifications to the evaluation.

Action Parameters

Action Response

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 should be used with caution as the deletion is permanent and may affect overall grade calculations. this operation is available in both ultra and original experiences of blackboard learn. note that this action cannot be undone, and all associated grade data for the column will be permanently removed.

Action Parameters

Action Response

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 representation, numerical score, private notes, student feedback, and exemption status. it’s particularly useful for manual grade columns or when grades have been manually overridden in attempt-based columns. the endpoint provides flexibility in grading practices, enabling detailed feedback and grade management for individual students within a course.

Action Parameters

Action Response

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, granting limited access to user resources on the blackboard platform. this endpoint should be called when an application needs to request permission from a user to access their blackboard data. it’s important to note that this endpoint does not directly provide access to user data; it only initiates the authorization process. the response will typically include a redirect url containing the authorization code, which the client application must handle appropriately.

Action Parameters

Action Response

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 items. it’s useful for understanding the application of rubrics across different components of a course, aiding in consistent assessment practices. the endpoint requires both a course id and a rubric id to pinpoint the exact associations being queried. it does not create, modify, or delete associations; it only provides read access to existing rubric-course element relationships.

Action Parameters

Action Response

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 grading policies. note that some fields are version-specific or limited by course type (classic vs ultra).

Action Parameters

Action Response

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 status of a particular message, such as when a user views a message or wants to mark it as unread for later attention. the endpoint only modifies the read status and does not affect other properties of the message or return the updated message content.

Action Parameters

Action Response

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 be added to the platform or existing content needs to be updated. the endpoint handles the file transfer process, but does not automatically associate the uploaded file with any specific course or content area; additional api calls may be required for such organization. note that file size limits and supported file types may vary depending on the specific blackboard learn instance configuration.

Action Parameters

Action Response

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 identifier. use this when you need to access or display comprehensive information about a particular item in a user’s or course’s calendar. the endpoint is particularly useful for building integrations that sync calendar data or for displaying detailed event information in external applications. note that this endpoint only retrieves existing calendar items and cannot be used to create, modify, or delete calendar entries.

Action Parameters

Action Response

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 should be used when administrators, educators, or students need to review or reference the privacy policy, especially in situations involving data protection compliance or user rights inquiries. the endpoint returns the full text of the privacy policy, but does not provide version history or allow for policy modifications.

Action Parameters

Action Response

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 useful for administrators or instructors who need to adjust course settings after initial creation, such as changing the course name, updating its availability, or modifying enrollment options. the endpoint supports partial updates, meaning only the fields that need to be changed should be included in the request body. note that some settings, like allowing guests or observers, are only modifiable for classic courses, while others apply to both classic and ultra courses. care should be taken when using the ‘closedcomplete’ status, as it can limit further updates, especially for ultra courses.

Action Parameters

Action Response

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 users to view the subordinate entities (such as departments, programs, or courses) under a given node. it’s particularly useful for building user interfaces that display the institutional structure or for programmatically traversing the hierarchy. the endpoint returns only direct children and does not provide information about deeper levels of the hierarchy in a single call.

Action Parameters

Action Response

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 drops a course or a teaching assistant’s role changes. the operation is permanent and cannot be undone through this api, so it should be used with caution. this endpoint does not provide any information about the success of the operation or the current state of the meeting after the deletion.

Action Parameters

Action Response

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, track attendance, or gather data on session participation. the tool is particularly useful for administrators or instructors who need an overview of active learning sessions across the platform. note that the specific details returned for each session may vary depending on the user’s permissions and the session type. this endpoint does not create or modify sessions; it is for retrieval purposes only.

Action Parameters

Action Response

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 should be used when changes need to be made to a course that is already placed within a category in the catalog structure. it’s important to note that this endpoint only updates existing courses and cannot be used to create new courses or move courses between categories. proper authorization is likely required to perform this operation, as it involves modifying the course catalog.

Action Parameters

Action Response

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 or administrators who need to review, analyze, or export assessment questions. the endpoint requires both a course identifier and an assessment identifier to pinpoint the exact set of questions to retrieve. it should be used when detailed information about assessment questions is needed, but it does not provide information about student responses or scores. note that the accessibility of this data may depend on the user’s permissions within the blackboard system.

Action Parameters

Action Response

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 resource. use this when you need to display or process the contents of a particular course resource. the endpoint returns only direct child resources and does not provide details about the parent resource itself or any grandchild resources. it’s particularly helpful for building course content navigation or for analyzing the structure of course materials.

Action Parameters

Action Response

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 meeting-specific materials. the tool returns a url that can be used to download the meeting resources, allowing for easy access to important course-related content. it’s important to note that this endpoint only provides the url for downloading and does not actually transfer the file content. the specific type of meeting resources available may vary depending on the course configuration and meeting settings in blackboard.

Action Parameters

Action Response

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 endpoint with caution as the deletion is irreversible and may impact associated data. this operation is particularly useful for cleaning up obsolete or erroneous data sources, but should not be used on active data sources that are still in use. note that deleting a data source does not automatically remove the data that was previously associated with it.

Action Parameters

Action Response

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 course. use this endpoint when you need to verify a user’s administrative role or permissions within a specific part of the institution’s structure. the endpoint provides information about the user’s admin status but does not modify any permissions. it’s particularly useful for access control, auditing, or displaying user roles in management interfaces.

Action Parameters

Action Response

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 within a course’s gradebook. it should be used when detailed information about a specific grading column is needed, such as its name, points possible, visibility settings, or associated assignments. the endpoint does not modify any data and is suitable for read-only operations. it’s important to note that this endpoint only provides information for a single column and does not return data about student grades or submissions.

Action Parameters

Action Response

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 applications that need to display or process course materials, such as displaying lecture slides, assignment instructions, or supplementary reading materials. the endpoint should be used when there’s a need to access or download attachments related to a specific content item in a course. it will not provide the actual content itself, only the attachments linked to that content. this tool is particularly valuable for building integrations that enhance the learning experience by providing easy access to course resources.

Action Parameters

Action Response

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 initial creation, managing student access, and controlling enrollment options. the endpoint supports partial updates, allowing you to modify only the specified fields without affecting others. use this when you need to change group settings, update availability, or adjust enrollment limits and signup options for an existing group in a course.

Action Parameters

Action Response

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 configuration, visibility to students, and grading settings. the patch operation supports partial updates, meaning you can modify individual properties without affecting others. this is particularly useful for adjusting grade column settings throughout the academic term, such as changing due dates, modifying scoring models, or updating anonymous grading configurations. note that this endpoint does not create new grade columns or delete existing ones; it is specifically for modifying properties of an already existing grade column identified by the courseid and columnid.

Action Parameters

Action Response

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’s useful for reviewing or auditing adaptive release settings without modifying them. the endpoint doesn’t provide information about whether students have met the criteria, only the criteria themselves. use this when you need to understand or verify the access conditions for specific course content.

Action Parameters

Action Response

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 solution. it’s particularly useful for administrators and instructors who need to verify or review the settings of a proctoring service before configuring exams. the endpoint should be used when specific details about a proctoring service are required, such as during exam setup or troubleshooting integration issues. note that this endpoint only provides information about the service itself and does not include data about individual proctored exams or student sessions.

Action Parameters

Action Response

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 items within a course. it’s used to establish grading criteria, set visibility options for students, and connect the rubric to the appropriate gradebook column or question. the association can be configured for grading purposes or as an informational guide, with flexible options for when and how students can view the rubric and its evaluation. this tool is essential for implementing consistent assessment strategies across course content and providing clear expectations to students.

Action Parameters

Action Response

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, enabling them to align course objectives with institutional goals. the endpoint is useful for goal management, curriculum planning, and ensuring educational alignment across courses and programs. it should be used when there’s a need to review, assess, or report on the goals within a specific category of a goal set. note that this endpoint only provides read access to the goals and does not allow for creation, modification, or deletion of goals.

Action Parameters

Action Response

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 attempts. it supports features such as anonymous grading, external tool integration, and custom formulas for grade calculation. the endpoint is particularly useful when setting up a new assignment or assessment that requires a corresponding grade column in the course gradebook. it should be used to establish the grading structure for a course, but not for entering actual grades (which would be done through a separate endpoint). note that some features may have version-specific availability, and certain settings (like includeincalculations) may behave differently between classic and ultra courses.

Action Parameters

Action Response

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 particularly useful for managing access control and maintaining the security of the institutional hierarchy. the operation is permanent and immediate, so it should be used with caution. this endpoint does not delete the user account itself; it only removes the administrative role for the specified node. note that this action may affect the user’s ability to manage courses, users, or other resources associated with the given node and its sub-nodes.

Action Parameters

Action Response

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 departmental categories. it’s particularly useful for applications that need to display or manage the structure of educational content within blackboard. the endpoint should be used when you need to populate category listings, build navigation menus, or gather information about how content is organized in the blackboard system. note that this endpoint only provides category information and does not return the actual content within those categories.

Action Parameters

Action Response

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 managing cross-listed courses, updating user roles, and adjusting instructor display orders. the endpoint should be used when changes to a user’s course membership are required, such as promoting a teaching assistant to an instructor or updating a user’s availability status. it does not provide functionality for adding or removing users from a course.

Action Parameters

Action Response

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 particularly useful for applications that need to display course catalogs, manage course enrollments, or synchronize course data with external systems. the endpoint returns course-related data, which may include course ids, names, descriptions, and other relevant metadata. however, it’s important to note that the exact details returned for each course are not specified in the given schema and may vary based on system configurations or user permissions. this tool should be used when you need to obtain a broad view of courses in the blackboard system, such as for course discovery or administrative purposes. it may not provide in-depth details about individual courses, which might require separate, course-specific api calls.

Action Parameters

Action Response

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 should be used when you need to access group data for course management, reporting, or to facilitate group-based activities and assignments. the endpoint provides a comprehensive view of the group structure within a course but does not modify any group information. note that this endpoint only returns group data and does not include detailed information about individual group members or their activities.

Action Parameters

Action Response

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 study group. the operation is final and will immediately revoke the user’s access to group-specific resources and activities. it should be used cautiously, as removing a user from a group may affect their ability to participate in group-related coursework. this endpoint does not remove the user from the course itself, only from the specified group within the course.

Action Parameters

Action Response

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 about each column, such as column name, points possible, creation date, and last modified date. this tool is essential for understanding the current layout of a course’s gradebook, preparing for grade entry, or auditing the grading structure. it should be used when a comprehensive view of the gradebook organization is needed. note that this endpoint only provides metadata about the columns and does not include actual student grades or submissions.

Action Parameters

Action Response

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 view or analyze the grading schema for a particular course, such as when integrating external grading tools or performing academic audits. the endpoint provides a comprehensive overview of how grades are organized within the course but does not include actual student grades or scores. it’s particularly useful for understanding the weighting and categorization of different assignments and assessments within the course.

Action Parameters

Action Response

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 aspects of file upload handling, such as maximum file size limits, allowed file types, storage configurations, and any other relevant upload-related settings. this tool should be used when there’s a need to review or verify the current upload policies and constraints in place for the blackboard instance. it does not modify any settings; it only returns the existing configuration.

Action Parameters

Action Response

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 pending review, items that have been reviewed, or the overall progress of the review process. it is particularly useful for instructors, course designers, or administrators who need to monitor the quality assurance process of course materials. the tool should be used when there’s a need to check the progress or status of content reviews for a particular course, especially in scenarios where courses undergo regular content audits or quality checks. it does not modify any course content or review status; it only retrieves the current state of reviews.

Action Parameters

Action Response

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 particularly useful for cleaning up old or unused courses, or when restructuring the course catalog. caution should be exercised when using this endpoint, as the deletion is irreversible and will result in the loss of all course-related information. this operation may have significant implications for student records and institutional data, so it should only be used after careful consideration and in compliance with institutional policies.

Action Parameters

Action Response

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 assessment types, including assignments, discussions, and projects. it supports different rubric types (numeric, percentage, range-based) to accommodate diverse grading needs. the created rubric can include detailed descriptions for each performance level and criterion, ensuring clear expectations and consistent grading across evaluators. this tool is essential for setting up comprehensive and transparent assessment frameworks within blackboard courses.

Action Parameters

Action Response

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 useful for displaying announcement details in external applications or for retrieving updated information about a previously known announcement. the endpoint requires both the course id and the announcement id to ensure precise retrieval of the intended announcement. it should be used when specific announcement details are needed, rather than for listing all announcements in a course.

Action Parameters

Action Response

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 particularly useful for managing instructor assignments, adjusting student access, and organizing cross-listed course enrollments. the endpoint should be used when changes to a user’s course enrollment are required, such as changing their role, updating their availability, or moving them between cross-listed courses. it does not provide functionality for initial course enrollment or complete removal of a user from a course.

Action Parameters

Action Response

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 platform. it should be used when you need to obtain an overview of all available data sources or when preparing to work with specific data sets in blackboard. the endpoint does not modify any data and is safe for frequent calls, but be aware that the list of data sources may be extensive for large institutions.

Action Parameters

Action Response

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 useful for creating department, faculty, or program-level nodes within a larger institutional framework. the endpoint requires at least a title for the new node and can optionally include an external id, description, and specific parent id. use this when you need to add a new organizational unit or level to your institution’s hierarchy in blackboard.

Action Parameters

Action Response

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 attendance record for a particular meeting. the endpoint should be used when recording attendance for course meetings, updating a user’s attendance status, or integrating external attendance tracking systems with blackboard. it provides a way to maintain accurate attendance records, which can be crucial for course management and student engagement tracking.

Action Parameters

Action Response

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 content delivery. it’s particularly useful for generating user dashboards, course listings, or when syncing course data with external systems. the endpoint returns course details but does not provide in-depth information about course content or student performance within those courses.

Action Parameters

Action Response

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 unit (node) of an educational institution. it allows developers to access and potentially manage tool-specific data for various components of the blackboard learning environment. this endpoint should be used when detailed information about a particular tool’s implementation or settings within a specific context (e.g., a course or department) is needed. it does not modify any data and is primarily for information retrieval purposes.

Action Parameters

Action Response

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 status. it is particularly useful for administrators, developers, and integration partners who need to understand the system’s capabilities, ensure compatibility, or troubleshoot issues. the endpoint should be used when up-to-date information about the blackboard system is required, such as during initial setup, maintenance, or when developing integrations. it’s important to note that this endpoint likely provides high-level system information and may not include sensitive or user-specific data.

Action Parameters

Action Response

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 progress. it’s particularly useful for administrators, instructors, or guardians who need to monitor a student’s performance and engagement within the blackboard platform. the endpoint returns details about each observer, which may include their roles, permissions, and relationship to the observed user. this tool should be used when there’s a need to review or manage the observers for a given user, such as during student progress reviews or when updating access permissions.

Action Parameters

Action Response

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 to adjust release criteria based on dates, grades, user progress, or other factors supported by blackboard’s adaptive release feature. the endpoint should be used when fine-tuning content visibility rules or correcting existing criteria. it’s important to note that this operation only modifies the specified criterion and does not affect other criteria within the same rule or other rules for the content item. proper understanding of the adaptive release feature and careful consideration of the impact on student access is recommended before making changes.

Action Parameters

Action Response

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 only when a course is no longer needed and all necessary data has been backed up. this action is irreversible, so it’s crucial to verify the courseid before execution. the endpoint is part of the v2 api, indicating it’s a more recent version of the blackboard learn rest api.

Action Parameters

Action Response

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 on the adaptive release feature. it’s particularly useful when you need to review or audit the adaptive release settings for a course, especially the group-based criteria. the endpoint does not modify any data and is intended for read-only operations. it’s important to note that this endpoint only retrieves group information for a single criterion and does not provide a comprehensive view of all adaptive release rules or criteria for the content item.

Action Parameters

Action Response

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 operation is irreversible, so it should be used with caution. this endpoint only deletes the specified message and does not affect other messages in the discussion or the discussion thread itself. it’s important to note that deleting a parent message may have implications for its child messages or the structure of the discussion thread, depending on how blackboard handles such deletions.

Action Parameters

Action Response

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 assessment data based on predefined rubric criteria. it should be used when detailed evaluation information is needed for a specific course, rubric, and its application context (association). the endpoint provides a targeted view of assessment data, focusing solely on the evaluations tied to the specified parameters. it does not modify any data and is intended for read-only access to evaluation information.

Action Parameters

Action Response

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 be configured with various settings controlling its visibility, enrollment method, and description. use this when you need to organize students into groups for project work, facilitate peer reviews, or create focused discussion spaces within a course. it’s particularly useful for larger classes where multiple small groups are needed for effective collaboration and management.

Action Parameters

Action Response

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 on individual student involvement in course activities. it should be used when detailed user-level meeting data is required, such as for attendance tracking, participation analysis, or performance evaluation. the endpoint will not provide aggregate course data or information about users not associated with the specified course. it’s important to note that the exact details returned may depend on the course settings and the user’s role within the course.

Action Parameters

Action Response

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 patch operation enables partial updates, allowing instructors to change only the necessary fields without affecting others. this tool is particularly useful for managing the grading process, providing feedback to students, and handling special grading scenarios such as exemptions or multiple attempts. it should be used when there’s a need to update any information related to a specific gradebook entry, but not for creating new attempts or retrieving attempt information. note that some status values are deprecated, and changing the reconciliationmode requires also providing a new score.

Action Parameters

Action Response

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 is particularly useful for administrators or instructors who need to adjust grading scales or clarify the meaning of certain grade notations. the update is performed by specifying the course id and grade notation id in the path, and providing the new code and/or description in the request body. note that this endpoint only updates existing grade notations and cannot be used to create new ones or delete existing notations.

Action Parameters

Action Response

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 custom gradebook columns. it should be used when detailed grade information for a single student in a specific course is needed, such as for progress monitoring or grade reviews. the endpoint does not modify any data and is read-only. note that this tool only provides grade data and does not include other course or user information beyond what’s directly related to the gradebook.

Action Parameters

Action Response

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 educational institution. it provides insights into the management structure and helps in understanding who has administrative access to various parts of the institutional hierarchy. this tool is particularly useful for system administrators, it staff, or institutional managers who need to review or manage administrative roles within the blackboard system.

Action Parameters

Action Response

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 discussion activities without directly accessing the blackboard user interface. it should be used when detailed information about a particular discussion is needed, such as for reporting, content management, or integration with other educational tools. the endpoint requires both the course id and discussion id to be specified, ensuring precise retrieval of the desired discussion data.

Action Parameters

Action Response

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 system within blackboard learn, enabling applications to synchronize with or display blackboard calendar data. this tool is particularly useful for building applications that need to display or manage academic schedules, deadlines, and events from blackboard. note that the response may include various types of calendar items such as course events, office hours, and gradebook deadlines. the endpoint does not provide functionality for creating, updating, or deleting calendar items; it is read-only.

Action Parameters

Action Response

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 reviewing grading decisions, providing feedback, or analyzing assessment outcomes. the tool should be used when detailed information about how a specific assignment attempt was evaluated against rubric criteria is needed. it does not modify any data and is intended for read-only access to evaluation information.

Action Parameters

Action Response

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 context of a particular course, which can include instructor announcements, student discussions, and system notifications. this tool should be used when there’s a need to gather all communication related to a specific course, such as for auditing purposes or to provide a complete message history to students or instructors. it does not allow for filtering or searching messages; all messages for the specified course are returned.

Action Parameters

Action Response

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. it should be used when an instructor or course administrator wants to adjust the visibility rules for content, specifically by removing a group’s access under certain conditions. this operation is permanent and immediately affects the adaptive release settings for the specified content.

Action Parameters

Action Response

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 removing an outdated meeting entry. the operation is irreversible, so it should be used with caution. this endpoint only performs the deletion and does not return any information about the deleted meeting or provide options for rescheduling. it’s important to note that this action may affect student schedules and course planning, so proper communication with course participants is advised before deleting a meeting.

Action Parameters

Action Response

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 options for setting the message status, enabling features like draft saving and soft deletion. the endpoint is essential for facilitating student engagement and collaborative learning through structured, asynchronous communication within the blackboard platform.

Action Parameters

Action Response

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 other administrative units. it’s particularly useful for understanding the layout and relationships of different entities within the institution’s blackboard setup. the endpoint should be used when needing to map out the institutional structure, populate organization charts, or when integrating systems that require knowledge of the institution’s hierarchy. note that this endpoint only provides structural information and may not include detailed data about each node’s operations or members.

Action Parameters

Action Response

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 when restructuring the course schedule. it’s important to note that this operation may be irreversible and could affect all meetings linked to the specified course. use with caution, as it might impact student access to past or upcoming virtual sessions. the endpoint does not provide options for selective deletion of individual meetings, so it should only be used when intending to remove all meetings from the course.

Action Parameters

Action Response

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 dashboards, or sync course information with other systems. the endpoint returns read-only data and does not modify any course information. while it provides a comprehensive list of courses, it may not include detailed information about course content, assignments, or student data, which might require additional api calls. use this endpoint when you need to obtain an overview of courses in the blackboard learn environment, such as for course catalogs or administrative purposes.

Action Parameters

Action Response

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 removes the specified grade notation from the system, so it should be used with caution. this operation cannot be undone, so it’s important to verify the correct gradenotationid before deletion. the endpoint does not return the deleted data; it typically only confirms the successful deletion or reports an error if the deletion fails.

Action Parameters

Action Response

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 applications that need to synchronize term information or display term details to users. the endpoint should be used when specific term information is required, rather than a list of all terms. note that this endpoint only provides details for a single term; to get information about multiple terms, separate requests must be made for each termid.

Action Parameters

Action Response

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 for applications that need to display or process course information outside of the blackboard learn interface. the endpoint should be used when detailed information about a single course is required, rather than for bulk operations or listing multiple courses. note that the exact fields returned may depend on the user’s permissions and the course’s configuration within blackboard learn.

Action Parameters

Action Response

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 course, progress, or other relevant details. it should be used when you need to access or verify a user’s information or status within a specific course. this endpoint is particularly useful for generating reports, checking user progress, or managing course-specific user data. note that it only provides information for a single user-course combination and does not return data about the user across multiple courses or course-wide user lists.

Action Parameters

Action Response

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 caution. this endpoint is particularly useful for course administrators or instructors who need to manage group structures within their courses. it should not be used to temporarily disable a group; instead, it permanently removes the group and all associated data from the course. note that this action does not affect the individual user accounts of group members, only the group itself within the specified course.

Action Parameters

Action Response

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 detailed information about a particular attempt is needed, such as for reviewing student performance, grading, or addressing disputes. the endpoint provides a snapshot of the attempt, which may include timestamps, scores, and other relevant metadata. it does not modify any data and is intended for read-only access to attempt information.

Action Parameters

Action Response

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 content. it can be used to monitor student engagement, ensure compliance with course requirements, or identify students who may need additional support. the endpoint does not modify any data and is intended for read-only operations. it’s important to note that this endpoint only provides the review status and does not give detailed information about the user’s interaction with the content.

Action Parameters

Action Response

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 to understand or display the categorization of learning objectives for a particular goal set, such as when building course structures or reporting on educational outcomes. the endpoint returns only the categories within the specified goal set and does not provide detailed information about the goals themselves. this tool is particularly useful for administrators and instructors who need to manage and organize educational goals across courses or programs.

Action Parameters

Action Response

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 breakdown of a parent goal into its component parts. it’s particularly useful for educators and administrators who need to track the progress of complex, multi-layered learning objectives or course structures. the endpoint should be used when there’s a need to understand the sub-components of a specific goal or to navigate through the goal hierarchy. it will not provide detailed information about the parent goal itself, only its immediate children.

Action Parameters

Action Response

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 from this endpoint is typically valid for a limited time and should be refreshed periodically. this endpoint supports both client credentials flow for server-to-server interactions and authorization code flow for user-centric operations. it’s important to note that the token should be kept secure and not exposed to end-users or in client-side code.

Action Parameters

Action Response

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 useful for viewing the conversation thread, monitoring student engagement, or gathering information about a specific topic within the course discussion. the endpoint should be used when there’s a need to review or analyze the replies to a particular message, such as for grading participation or facilitating further discussion. it does not provide information about other messages in the discussion or allow for creating or modifying replies; it is strictly for retrieving existing replies to the specified message.

Action Parameters

Action Response

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 build and maintain the hierarchical structure that organizes content and permissions. the endpoint requires a json payload with node details and supports optional parameters for flexibility in node creation and positioning within the hierarchy.

Action Parameters

Action Response

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 one, while selectively choosing which components to transfer. it’s particularly useful for course administrators or instructors preparing for a new semester or creating variations of an existing course. the tool provides extensive customization options, allowing you to include or exclude specific course elements such as content areas, assessments, gradebook settings, and more. however, it does not handle enrollment of students or instructors in the new course - this must be done separately after the copy is complete.

Action Parameters

Action Response

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 when you need to gather information about a particular child course, such as its name, description, or specific attributes related to its parent-child relationship. the endpoint requires both the parent course id and the child course id to uniquely identify the requested child course within the blackboard learn system.

Action Parameters

Action Response

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 specification. it provides essential data for managing and troubleshooting lti integrations within the blackboard learn environment. the returned list of domains can be used to verify the correct configuration of lti tools, ensure security by checking authorized domains, and audit the current integrations. this endpoint is particularly useful for administrators and developers working on lti integrations with blackboard learn.

Action Parameters

Action Response

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 permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful for catalog maintenance, such as removing outdated course categories or reorganizing the catalog structure. it does not return any content upon successful deletion, typically responding with a 204 no content status. be aware that deleting a category may affect related items or sub-categories, depending on the blackboard system’s configuration.

Action Parameters

Action Response

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 been replaced. the operation is irreversible, so caution should be exercised before deletion. this endpoint does not return the deleted rubric data; it only performs the deletion operation. it’s important to note that deleting a rubric may impact any assignments or assessments that were using it, so those should be updated accordingly after deletion.

Action Parameters

Action Response

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

Action Parameters

Action Response

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 without creating a new one or altering read-only metadata. the endpoint supports bbml formatting for rich text content in the topic body. note that this operation only affects the discussion settings and main topic; it does not modify individual replies or nested messages within the discussion thread.

Action Parameters

Action Response

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 suitable for integration with external applications or systems that need to access goal-related data. use this endpoint when you need to obtain an overview of the goal sets available in the blackboard environment. it’s particularly useful for applications that manage or display educational objectives, track student progress, or provide insights into the structure of learning goals within an institution. note that this endpoint returns goal sets, not individual goals. it may not provide detailed information about the specific goals within each set. additionally, as it’s a get request without parameters, it might return all available goal sets, which could be a large dataset for extensive blackboard implementations.

Action Parameters

Action Response

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 bbml, hierarchical content structure, and granular control over content availability and accessibility. use this endpoint when adding new materials, resources, or structural elements to a course. it’s particularly useful for bulk content creation or programmatic course setup. note that while it offers extensive customization, some advanced features may depend on the blackboard learn version in use.

Action Parameters

Action Response

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. since: 3500.7.0

Action Parameters

Action Response

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 relevant activities. it is particularly useful for auditing purposes, allowing educators and administrators to track and review the complete history of a gradebook column. the endpoint should be used when there’s a need to investigate grading discrepancies, verify changes, or maintain a record of grading activities for compliance and transparency. note that this endpoint only returns logs for a single gradebook column; to get a comprehensive view of all gradebook activities, you may need to make multiple calls for different columns.

Action Parameters

Action Response

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 accountability in the grading process. it provides details about the most recent updates, potentially including the user who made the change and the timestamp of the modification. this tool should be used when there’s a need to monitor or audit recent activity in a specific gradebook column, such as verifying when the last grade was entered or identifying who made the most recent changes. it’s particularly valuable for instructors and administrators who need to keep track of grading activities and ensure the accuracy and timeliness of gradebook entries.

Action Parameters

Action Response

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 useful for adjusting group configurations after initial creation, such as changing visibility, updating enrollment limits, or modifying the signup process. the endpoint supports rich text formatting through bbml for descriptions, enabling detailed and well-formatted group information. use this when you need to alter any aspect of an existing group’s setup or presentation to students within a course.

Action Parameters

Action Response

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 detailed grade information for a single student on a specific assignment or gradebook entry is needed. the endpoint provides focused access to gradebook data, which is particularly valuable for generating individual student reports, conducting performance reviews, or integrating with external grade management systems.

Action Parameters

Action Response

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 when restructuring courses, removing outdated sections, or cleaning up course catalogs. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint requires both the parent course id and the child course id to ensure precise deletion of the correct course relationship.

Action Parameters

Action Response

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. use this when you need to add a new meeting or event to a course’s calendar or schedule. the created meeting will be associated with the specified course and visible to course participants. this tool is specifically for creating new meetings and cannot be used to update existing ones or retrieve meeting information.

Action Parameters

Action Response

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 educational institution. it provides valuable data for role management, user access control, and system administration tasks. the endpoint is particularly useful for administrators or developers who need to verify role configurations or integrate role-based access control into their applications. note that this endpoint only retrieves role information and cannot be used to modify or create new roles.

Action Parameters

Action Response

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, associated assignments, and any specific grading policies. it’s particularly useful for instructors or administrators who need to review or manage the structure of their course’s grading periods. the endpoint should be used when detailed information about a single gradebook period is required, rather than a list of all periods. note that this endpoint does not modify any data; it’s for retrieval purposes only.

Action Parameters

Action Response

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 useful for instructors or administrators who need to review or integrate rubric data into other systems or workflows. the endpoint should be used when detailed rubric information is required for a known course and rubric combination, but it will not modify or create new rubrics.

Action Parameters

Action Response

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 associated resources or links. it’s particularly useful for applications that need to display or manage course-related events and schedules. the endpoint requires both the course id and meeting id to uniquely identify the requested meeting. it should be used when detailed information about a single meeting is needed, rather than for listing all meetings in a course.

Action Parameters

Action Response

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 parent/guardian. it should be used when there’s a need to adjust the monitoring permissions or details of an established observer relationship. the endpoint doesn’t create new observer relationships; it only modifies existing ones. note that this operation may have implications on privacy settings and data access within the blackboard environment.

Action Parameters

Action Response

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 used with caution. this endpoint is particularly useful for instructors or administrators who need to manage course organization, especially when restructuring group activities or at the end of a term. it does not provide any information about the deleted group or its members; it simply removes the group from the course.

Action Parameters

Action Response

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 of data within the blackboard ecosystem. use this endpoint when you need to verify data source information, troubleshoot data-related issues, or integrate external systems with blackboard learn. the tool provides a comprehensive view of a single data source but does not modify or create new data sources. it’s particularly useful for administrators and developers working on data management and integration tasks within educational institutions using blackboard.

Action Parameters

Action Response

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 assessments and assignments. it is particularly useful for understanding how grades are organized within a course, which can aid in grade calculations, reporting, and overall course management. the endpoint should be used when there’s a need to view or analyze the grading structure of a particular course, but it will not provide actual grade data for students.

Action Parameters

Action Response

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, changing access settings, or updating term information after initial creation. the endpoint supports partial updates, meaning you only need to include the fields you want to modify. note that some settings, like duration type, may require additional fields to be updated simultaneously for consistency.

Action Parameters

Action Response

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 there’s a need to understand or audit the release criteria for a particular piece of course content. the tool returns details about the rules, which may include date, grade, membership, or review status criteria. it’s particularly useful for managing complex content release strategies or troubleshooting student access issues. note that this endpoint only provides information about existing rules and does not allow for creation or modification of rules.

Action Parameters