Blackboard

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 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 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

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

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 integration. it’s particularly useful for administrators and developers who need to manage or troubleshoot lti tool integrations with blackboard. the endpoint should be used when specific information about an lti domain is required, such as verifying its configuration or checking its current status. it will not modify any domain settings; it’s a read-only operation.

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

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 course. it’s useful for applications that need to display or process individual course materials. the endpoint should be used when detailed information about a specific piece of course content is required, rather than for retrieving a list of all content in a course. note that this endpoint only provides information about the content and does not include user-specific data like submission status or grades.

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

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 have access to or are associated with a specific piece of content in a course. the endpoint does not modify any data and is intended for read-only operations. note that it does not provide detailed information about the groups themselves, only their association with the specified content.

Action Parameters

Action Response

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 particularly useful for instructors or administrators who need to adjust group configurations after initial creation, such as changing access permissions, updating descriptive information, or modifying enrollment limits. the endpoint supports rich text formatting through bbml in description fields, enabling the creation of detailed, well-formatted group information. when using this endpoint, be aware that changes may immediately affect student access and group visibility within the course.

Action Parameters

Action Response

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 need to change a user’s status, role, or other attributes within a group, such as updating their group membership type or adjusting their group-specific permissions. this operation is specifically for modifying existing user data and should not be used for adding new users to a group or creating new groups. the endpoint requires the course id, group id, and user id to precisely target the user’s information in the correct context.

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

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 removes the specified node and its association within the hierarchy. caution should be exercised when using this endpoint, as deleting a node may have cascading effects on courses, users, or other entities associated with that node. it’s important to note that this operation cannot be undone, so it should only be used when you are certain that the node and its data are no longer needed.

Action Parameters

Action Response

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 monitoring or tracking the progress of system-level operations, such as batch processes, system updates, or administrative functions. the endpoint provides up-to-date information about the task but does not allow modification of the task itself. it’s particularly useful for integrations that need to synchronize with blackboard’s system tasks or provide status updates to users.

Action Parameters

Action Response

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 replicate a course for a new semester, create a template from an existing course, or backup course content. the operation copies all copyable elements of the source course into the target course specified by the courseid. note that this process may take some time for large courses, and certain elements (such as student data or time-sensitive content) may not be copied. the endpoint does not provide real-time progress updates on the copying process.

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

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

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

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 should be used when you need to fetch the properties or content of a specific resource within a known course. the endpoint requires both the course id and resource id to be specified in the path. it’s important to note that this endpoint only retrieves the resource information and does not modify or delete the resource. access to the resource may be subject to user permissions within the blackboard system.

Action Parameters

Action Response

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 should be used when detailed information about a single task is needed, such as viewing assignment instructions, due dates, or associated materials. the endpoint is particularly useful for building interfaces that display task details to students or instructors, or for integrating task information into external learning tools. note that this endpoint only provides information about the task itself and does not include submission data or grades.

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

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 institution’s structure. it provides a way to navigate and explore the course offerings based on the hierarchical organization of the institution. the endpoint should be used when you need to list or enumerate courses for a specific segment of the institution, as defined by the hierarchy node. it does not provide detailed information about individual courses, only their association with the specified node.

Action Parameters

Action Response

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 association for a course, which can affect how the course is organized and displayed within the institutional hierarchy. this operation is particularly useful for managing course placements in complex institutional structures with multiple hierarchical levels. note that this endpoint only modifies the ‘isprimary’ status and does not create or delete associations.

Action Parameters

Action Response

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 external id or description of a data source, enabling better synchronization with external systems and improved documentation within blackboard. this endpoint should be used when there’s a need to modify data source metadata without changing its core functionality or relationships within the system. it’s particularly useful for maintaining accurate and up-to-date information about data sources used in educational institutions integrated with blackboard.

Action Parameters

Action Response

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 progress metrics. use this when you need to review or analyze a particular learning objective. the tool returns only information about the requested goal and does not provide an overview of all goals or modify any goal data. it’s particularly useful for tracking student progress, curriculum planning, and ensuring alignment with educational standards.

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

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

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 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 activities within that specific group and course. use this endpoint when you need to fetch user-specific information related to their participation in a particular group within a course. it’s particularly useful for generating reports, managing group activities, or personalizing user experiences within the course and group context. note that this endpoint only provides information about the user in relation to the specified group and course; it does not return general user profile data or information about the user’s participation in other courses or groups.

Action Parameters

Action Response

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 for understanding how grading criteria are applied to specific coursework, enabling instructors and administrators to review and manage assessment structures. the tool should be used when detailed information about rubric implementation for a specific assignment is needed, such as during course setup, grading processes, or when analyzing assessment methodologies. it does not modify any data and is solely for retrieval purposes.

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

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 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

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 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 applications that need to display or manage group information within the context of a course. the endpoint should be used when detailed group information is required, such as for group management interfaces or when populating group-specific views in an application integrated with blackboard. it does not modify any group data and is intended for read-only operations. note that this endpoint focuses on a single group and does not provide a list of all groups in a course or allow for group creation or modification.

Action Parameters

Action Response

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 need to access or display information about a particular user, such as for user management tasks, profile displays, or data synchronization between systems. the endpoint returns only the publicly available information about the user and does not provide access to sensitive or private data. it’s important to note that while this is a public api endpoint, the actual data returned may still be subject to user privacy settings and system-wide access controls.

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

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 grades, assignments, and other relevant gradebook entries. it should be used when detailed grade information for a single student in a specific course is required, such as for progress monitoring or generating individual reports. the endpoint does not provide aggregate data for multiple students or courses and cannot be used to modify gradebook entries.

Action Parameters

Action Response

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 used when instructors or authorized users need to access or review the structured feedback and scoring for a particular group’s work. the tool is particularly useful for courses that incorporate collaborative assignments and utilize rubrics for standardized evaluation. it provides a comprehensive view of how a group’s work was assessed across various rubric criteria, enabling thorough analysis of group performance and facilitating transparent grading practices. note that this endpoint specifically deals with group attempts, so it may not be suitable for individual student assessments or non-rubric based evaluations.

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

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

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, adaptive release for controlled content visibility, and integration with originality reporting tools. use this endpoint when you need to programmatically create assignments with specific requirements or to batch create multiple assignments. the endpoint provides extensive customization options but requires careful consideration of parameters to ensure the assignment is set up correctly for student access and evaluation.

Action Parameters

Action Response

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 administrators to track user activity, troubleshoot access issues, or enforce security policies. the tool should be used when there’s a need to audit active user sessions or investigate potential unauthorized access. it does not provide historical session data or allow for direct session manipulation.

Action Parameters

Action Response

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 structuring the academic year into distinct grading intervals, such as semesters, quarters, or specific assessment periods. the created grading period can be used to associate gradable items (columns) with specific timeframes, facilitating organized grade tracking and reporting. this endpoint should be used when setting up a new course structure or adjusting existing grading timelines. it’s important to note that while the endpoint offers flexibility in date handling, careful consideration should be given to the datemode parameter and its implications on start and end dates.

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

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 integrating external systems with blackboard learn to automate the process of adding supplementary materials, documents, or resources to course content. the endpoint requires specifying both the course and the content item to which the attachment will be added, ensuring precise placement of materials within the course structure. note that this operation likely has size limitations for attachments and may be subject to storage quotas set by the institution’s blackboard learn administrator.

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

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

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

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 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. it is particularly useful for scenarios where a user, such as a parent or guardian, needs to access data about students they are responsible for. the endpoint returns details about the observees, which may include their identifiers, names, and potentially other relevant information depending on the system’s configuration and privacy settings. it should be used when there’s a need to gather information about the relationship between a user and their observees in an educational context.

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

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

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

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 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 administrators to understand how curriculum elements are mapped to educational objectives. it should be used when there’s a need to review or analyze the alignment of course content with specific learning outcomes. the endpoint provides a comprehensive view of how a goal is integrated into the curriculum but does not modify any alignment data.

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

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 modify existing user-based criteria for adaptive release rules, such as changing performance thresholds or adjusting access conditions for a specific student. this tool is specifically for updating existing criteria and should not be used for creating new rules or criteria. note that this endpoint focuses solely on user-specific criteria and does not handle group-based or date-based release conditions.

Action Parameters

Action Response

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 outcomes. this endpoint is particularly useful for administrators, instructors, or integrated systems that need to assess or manage educational targets across courses or programs. the endpoint returns all available goals without requiring specific parameters, making it suitable for general goal overviews or as a first step in more detailed goal analysis. however, it may not provide granular filtering options in this version, so additional processing might be needed for specific use cases. while the endpoint is labeled as ‘public’, users should verify access rights as some implementations may still require authentication or have usage limitations to protect sensitive educational data.

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 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 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 session-related data. it is particularly useful for tracking user activity, analyzing engagement patterns, or implementing custom analytics for educational institutions. the endpoint should be used when there’s a need to monitor or report on individual user activity within the blackboard environment. it does not provide real-time session management capabilities, such as terminating active sessions.

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

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 endpoint when you need to modify existing tool settings, such as enabling/disabling a tool, locking its configuration, or adjusting its applicability for different user roles. this is particularly useful for managing tool access across various levels of an institution’s structure, ensuring appropriate permissions and visibility for different user categories.

Action Parameters

Action Response

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, and temporal coverage. it’s used when course instructors or administrators need to adjust grading period details after initial creation, such as extending deadlines or reorganizing the gradebook structure. the endpoint provides flexibility in updating individual fields without requiring all parameters to be specified. it’s particularly useful for managing the chronological structure of a course and associating gradable items with specific time frames.

Action Parameters

Action Response

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 assessment criteria and grading structure. it should be used when there’s a need to review or analyze the rubric setup for a specific gradable item in a course. the tool is particularly useful for instructors, course designers, or administrators who need to ensure that the appropriate rubrics are linked to the correct gradebook columns. note that this endpoint only provides information about existing associations and does not allow for creating, modifying, or deleting these associations.

Action Parameters

Action Response

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 students into smaller units for collaborative work, discussions, or specific course activities. the function supports creating both regular groups and group sets, with options for self-enrollment or instructor-managed membership. use this when setting up course structures that require student groupings, whether for project teams, study groups, or other collaborative activities within a course.

Action Parameters

Action Response

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’). this endpoint should be used when you need to fetch the complete list of grade notations configured for a particular course, which can be useful for understanding the grading scheme or for integrating with other systems. it does not modify any data and is typically used for reporting or display purposes. note that this endpoint only provides the notation definitions and does not return actual grades assigned to students.

Action Parameters

Action Response

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 disassociate a course from a particular hierarchical node, which can be useful for reorganizing content, archiving old courses, or correcting misplaced courses. the operation is permanent and should be used with caution, as it may affect the visibility and accessibility of the course within the institutional structure. this endpoint does not delete the course itself from the system; it only removes the association between the course and the specified hierarchical node.

Action Parameters

Action Response

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 assignment or assessment attempt. it can be used to review submitted work, download attachments, or verify file contents for grading purposes. the endpoint requires precise identification of the course, attempt, and file, ensuring accurate and secure access to the requested gradebook data.

Action Parameters

Action Response

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 or instructors need to view the proctoring options available for configuring secure assessments in the ultra course view. the endpoint provides information about the integrated third-party proctoring solutions but does not include details about individual exam configurations or student data. note that the actual implementation of proctoring services may require additional setup and configuration within the blackboard learn environment.

Action Parameters

Action Response

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 can select for their profiles, supporting inclusive identity representation. the endpoint should be used when administrators need to edit pronoun details or change approval statuses. note that this operation only updates the specified fields and does not affect other pronoun attributes not included in the request.

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 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 provides educators and students with up-to-date information on upcoming or past meetings for a particular course. the endpoint should be used when you need to display or manage the meeting schedule for a course. it will not provide information about meetings across multiple courses or institution-wide events. the response likely includes meeting titles, dates, times, durations, and possibly attendance information, though the exact details are not specified in the schema.

Action Parameters

Action Response

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 communication, or analyzing participation patterns. it should be used when you need to know who has access to or has interacted with a specific message in a course. the endpoint does not provide the content of the message or detailed information about the participants beyond their identification within the system.

Action Parameters

Action Response

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, description, availability, and access restrictions. it’s particularly useful for structuring course offerings, organizing resources, or creating custom catalogs within blackboard. the created category can be set to appear on the front page and can be restricted to specific institutional roles, providing flexible control over content organization and access.

Action Parameters

Action Response

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 integrations between blackboard and external systems, such as student information systems (sis) or other educational tools. the created data source can be used for various purposes, including batch operations, data synchronization, or as a reference point for imported content. this endpoint should be used when initially setting up a new integration or when a new external system needs to be recognized within blackboard. it’s important to note that the externalid must be unique across all data sources in the blackboard instance, and once created, it cannot be changed.

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 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 criterion, allowing administrators or instructors to monitor and manage access to course content. it’s particularly useful for tracking student progress, assessing the effectiveness of adaptive release strategies, and ensuring that content is being accessed as intended. the endpoint does not modify any data or grant access; it only provides information about which users currently meet the specified criterion.

Action Parameters

Action Response

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 to a student’s attempt. it permanently removes the file from the system, so it should be used with caution. this operation cannot be undone, and the file cannot be recovered once deleted. the endpoint does not provide any information about the deleted file or confirm its previous existence.

Action Parameters

Action Response

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 the end of an academic term or when a course is no longer needed. once a course is deleted, it cannot be recovered through the api. this operation is irreversible and should only be performed by users with appropriate permissions, such as system administrators or course managers.

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

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

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 particular lti tool placement identified by its unique placementid. use this endpoint when you need to inspect or verify the setup of an lti tool within blackboard courses or content areas. the returned data may include information such as the tool’s name, description, launch url, and custom parameters. this endpoint is particularly useful for troubleshooting lti integrations or gathering information for reporting purposes.

Action Parameters

Action Response

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 ------------|----------- course.attendance.create | create course/organization course meeting attendance course.attendance.modify | update course/organization meeting attendance since: 3500.7.0

Action Parameters

Action Response

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 instructors or systems integrating with blackboard to review submissions, facilitate grading processes, or archive student work. the endpoint should be used when there’s a need to access the actual file content of student submissions, rather than just metadata about the attempt. note that this endpoint only provides access to files and does not include other attempt details such as scores or feedback.

Action Parameters

Action Response

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 (blackboard markup language), enabling the creation of visually appealing and structured announcements. use this endpoint when you need to edit or refine an announcement’s content, change its visibility, or update its publication status. it’s particularly useful for correcting errors, adding new information, or adjusting the timing of announcement visibility to students.

Action Parameters

Action Response

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 implementing non-standard grading schemes or providing additional context to traditional letter or number grades. the created grade notation can then be used when assigning grades to students, offering more nuanced feedback on their performance. this tool should be used when setting up or modifying the grading structure for a course, especially in cases where standard grading notations are insufficient to capture the full range of student performance or special grading circumstances.

Action Parameters

Action Response

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 attempt on an assignment, quiz, or other assessable items. the endpoint should be called after the initial file upload process, using the generated uploadid to link the file to the specific attempt. it’s particularly useful for instructors or system integrators who need to programmatically attach files to student submissions, or for building custom submission interfaces that interact with blackboard’s backend. this endpoint does not handle the actual file transfer; it assumes the file has already been uploaded to blackboard’s system and is now being associated with a specific attempt.

Action Parameters

Action Response

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

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 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 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 assignments. this endpoint should be used when you need to obtain an overview of the group structure within a course, such as when preparing for group assignments or managing course organization. it provides a list of group sets, but does not include detailed information about individual groups within each set. this endpoint is particularly useful for instructors or administrators who need to manage or review the group organization of a course.

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

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 specified gradebook column. it is particularly useful for tracking student progress, analyzing performance trends, and gathering data for assessment purposes. the endpoint should be used when detailed information about individual student attempts is needed, such as for grading, providing feedback, or generating reports. it does not modify any data and is intended for read-only access to attempt information.

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

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 operation is irreversible and will delete all associated data for the specified term, including course associations and enrollment information. it’s crucial to use this endpoint with caution, as it may have far-reaching consequences on the institution’s academic records and student data. before deletion, ensure that all necessary data has been backed up or migrated if required.

Action Parameters

Action Response

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 understanding the access levels and capabilities assigned to different user types in the blackboard learning environment. use this endpoint when you need to review or verify the configuration of a course role, such as instructor, teaching assistant, or student. the returned data can be used for role management, troubleshooting access issues, or ensuring proper permissions are set for different user categories. note that this endpoint only provides read access to role information and cannot be used to modify role settings.

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

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 methods, score calculations, student visibility, and anonymous grading. use this endpoint when setting up a new assignment, exam, or other gradable item in a course. it’s particularly useful for configuring complex grading scenarios or when integrating external grading systems with blackboard.

Action Parameters

Action Response

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 the content, and this action cannot be undone. the endpoint requires precise identification of the course, content item, and attachment using their respective ids. it’s important to note that this operation only removes the attachment and does not affect the content item itself or other attachments.

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

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 other course-specific attributes. it is particularly useful for applications that need to display or process course information outside of the blackboard interface. this tool should be used when detailed course information is required for a known course id, but it will not provide a list of all courses or modify any course data.

Action Parameters

Action Response

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 within a given parent resource. it’s particularly useful for applications that need to display or manage the content structure of blackboard courses or materials. the endpoint returns only direct children of the specified resource, not the entire subtree, making it suitable for building tree-like navigation or content exploration features. note that this endpoint does not provide the actual content of the resources, only their metadata and structural information.

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 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 administrators who need to understand or analyze the structure of course objectives and their relationships to broader educational goals. the endpoint should be used when reviewing course design, preparing for accreditation processes, or assessing curriculum coherence. it does not modify any alignments; it only provides a read-only view of the existing structure. the response likely includes a list of goals, associated objectives, and potentially metadata about these alignments.

Action Parameters

Action Response

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 created in error. it’s important to note that this action is irreversible and will permanently delete all associated grade data for all students in the course. use this endpoint with caution, as it may have significant implications for course grading and student records. this operation cannot be undone, so it’s recommended to have a backup of the data before proceeding with the deletion.

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 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 course content, such as during course setup or when adjusting access throughout the semester. the endpoint only updates visibility settings and does not modify other properties of the toc item. note that this operation may affect course accessibility and should be used carefully to ensure compliance with institutional policies.

Action Parameters

Action Response

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 from the system, such as canceling an event or correcting erroneously created entries. it’s important to note that this operation is irreversible, and once an item is deleted, it cannot be recovered through the api. users should exercise caution when invoking this endpoint to avoid unintentional loss of calendar data. the endpoint requires precise identification of the calendar item through its type and unique id, ensuring accurate removal of the intended event.

Action Parameters

Action Response

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 should be used when there’s a need to understand or display the content structure of a blackboard course, such as for content navigation or course mapping purposes. the endpoint focuses solely on category information and does not return the actual content within these categories. it’s particularly useful for applications that need to mirror or interact with blackboard’s course organization.

Action Parameters

Action Response

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 particularly useful for synchronizing user data with external systems, managing user accounts, or allowing users to update their own information. the endpoint supports granular updates, meaning you can modify specific fields without affecting others. be cautious when updating sensitive information like passwords or system roles, as these changes can significantly impact the user’s access and experience within the blackboard system.

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

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, enrollment methods, and localization. it should be used when setting up new courses or organizations within blackboard, either manually or as part of an automated provisioning process. the endpoint provides flexibility in course setup, supporting both ultra and classic course views, various availability and enrollment options, and integration with external systems through data source and external id fields. however, it’s important to note that some settings are specific to either ultra or classic courses, and certain parameters may have interdependencies or require specific permissions to modify.

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

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 provides a comprehensive overview of the role structure, which is essential for user management, access control, and permission assignment across the platform. the endpoint should be used when setting up new user accounts, auditing existing roles, or integrating role-based access control in external applications. note that this endpoint only retrieves role information and does not allow for creating, modifying, or deleting roles.

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

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 particularly useful for generating individual student reports, verifying grade entries, or integrating with external grading systems. the endpoint returns the grade value and potentially additional metadata such as submission date or feedback. it should be used when precise, individual grade information is needed, rather than for bulk grade retrieval across multiple students or columns.

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

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 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. it’s particularly useful for instructors or administrators who need to manage or review group activities within a course. the endpoint should be used when specific group information is required, such as for displaying group details, verifying group settings, or preparing reports on group-based activities. it does not modify any data and is intended for read-only operations.

Action Parameters

Action Response

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 contributions for a particular grading item. it is particularly useful for instructors or administrators who need to analyze group performance or review the history of group submissions for a specific assignment or grading criteria. the endpoint supports both ultra and original course views, making it versatile across different blackboard learn interfaces. use this when you need to gather comprehensive data about group work and collaborative assignments within a course’s gradebook structure.

Action Parameters

Action Response

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, facilitating management of student collaborations and assignments. it should be used when there’s a need to view or analyze the structure of groups within a course, such as for attendance tracking, assignment distribution, or organizing collaborative activities. this endpoint is particularly useful for applications that need to synchronize group data with external systems or generate reports on course organization.

Action Parameters

Action Response

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 data sharing preferences, and service permissions. the endpoint is particularly useful when changes need to be made to an existing lti tool configuration, such as updating the primary domain, modifying data sharing settings, or adjusting service permissions. it provides fine-grained control over how the lti tool interacts with blackboard learn and what data it can access. this endpoint should be used carefully, as changes to these settings can significantly impact the functionality and security of the lti integration.

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 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. it should be used when detailed information about a single question is needed, such as for review, editing, or analysis purposes. the endpoint does not modify the question; it only provides read access to the existing data. note that the response will not include student answers or performance data related to the question.

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

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

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 operation is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful when modifying assessments after they’ve been created, such as removing outdated or incorrect questions. it should not be used to temporarily hide questions; instead, consider using other blackboard features for that purpose. note that deleting a question may affect the overall structure and scoring of the assessment, so it’s important to review and adjust the assessment settings after using this endpoint.

Action Parameters