Contact Us 1-800-596-4880
  1. Homepage
  2. Blackboard Connector (0.1)

  3. Blackboard Connector Reference

All Connectors

Blackboard Connector 0.1.0 Reference

Anypoint Connector for Blackboard (Blackboard Connector) enables Mule applications to access the Blackboard Learn REST API.

Configurations

Config

Default configuration for the connector.

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Authorization

The connection types to provide to this configuration.

x

Name

String

The identifier of this element used to reference it in other components.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Authorization
Parameters
Name Type Description Default Value Required

baseUri

String

Base URI of the Blackboard Learn REST API.

x

token

String

OAuth 2.0 access token used to authorize API requests.

x

TLS Configuration

TLS

TLS settings for HTTPS connections.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Operations

Course Category Create Category

<blackboard:course-category-create-category>

Creates a course category of the given type in Blackboard Learn.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

categoryType

String

Course category type segment for the REST resource path.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Category Create Category Membership

<blackboard:course-category-create-category-membership>

Adds a course to a course category (creates a category membership).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

categoryType

String

Course category type segment for the REST resource path.

x

categoryId

String

Course category ID.

x

courseId

String

Course ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Category Delete Category

<blackboard:course-category-delete-category>

Deletes a course category.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

categoryType

String

Course category type segment for the REST resource path.

x

categoryId

String

Course category ID.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Category Delete Category Membership

<blackboard:course-category-delete-category-membership>

Removes a course from a course category (deletes the category membership).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

categoryType

String

Course category type segment for the REST resource path.

x

categoryId

String

Course category ID.

x

courseId

String

Course ID.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Category Get Categories

<blackboard:course-category-get-categories>

Returns course categories for the specified category type.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

categoryType

String

Course category type segment for the REST resource path.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Category Get Category By ID

<blackboard:course-category-get-category-by-id>

Returns a single course category by ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

categoryType

String

Course category type segment for the REST resource path.

x

categoryId

String

Course category ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Category Get Category Memberships

<blackboard:course-category-get-category-memberships>

Returns course memberships for a category (courses linked to that category).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

categoryType

String

Course category type segment for the REST resource path.

x

categoryId

String

Course category ID.

x

includePermissions

Boolean

Whether to include permission metadata in the response.

false

expand

String

Related resources to expand in the response.

offset

Number

Zero-based index of the first item to return.

fields

String

Comma-separated list of fields to include in the response.

limit

Number

Maximum number of items to return.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Category Get Child Categories

<blackboard:course-category-get-child-categories>

Returns child categories under a parent category.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

categoryType

String

Course category type segment for the REST resource path.

x

parentId

String

Parent category ID.

x

categoryId

String

Course category ID.

dataSourceId

String

Data source ID.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

createdCompare

String

Comparison operator for the created timestamp filter.

offset

Number

Zero-based index of the first item to return.

frontPage

Boolean

Whether to restrict results to front-page categories.

false

fields

String

Comma-separated list of fields to include in the response.

available

Boolean

Whether the resource is available.

false

title

String

Title filter or value for the request.

sort

String

Sort order for the result set.

limit

Number

Maximum number of items to return.

created

String

Filter by resource creation timestamp.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Category Update Category

<blackboard:course-category-update-category>

Updates an existing course category.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

categoryType

String

Course category type segment for the REST resource path.

x

categoryId

String

Course category ID.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Gradebook Get Column Grade

<blackboard:course-gradebook-get-column-grade>

Returns the grade for one user in a specific gradebook column.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

columnId

String

Gradebook column ID.

x

userId

String

User ID.

x

unsupportedSearchOverChildCourses

Boolean

Whether to search across child courses.

false

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Gradebook Get Column Grades

<blackboard:course-gradebook-get-column-grades>

Returns grades for all users (or a filtered set) in a gradebook column.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

columnId

String

Gradebook column ID.

x

firstRelevantDateCompare

String

Comparison operator for the firstRelevantDate filter.

lastRelevantDate

String

End of the relevant date range filter.

changeIndex

Number

Change index for optimistic concurrency control.

includeUnpostedGrades

Boolean

Whether to include unposted grades in the response.

false

firstRelevantDate

String

Start of the relevant date range filter.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

includeDisabledMemberships

Boolean

Whether to include disabled memberships in the response.

false

offset

Number

Zero-based index of the first item to return.

lastRelevantDateCompare

String

Comparison operator for the lastRelevantDate filter.

fields

String

Comma-separated list of fields to include in the response.

unsupportedSearchOverChildCourses

Boolean

Whether to search across child courses.

false

limit

Number

Maximum number of items to return.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Gradebook Get Grade Column

<blackboard:course-gradebook-get-grade-column>

Returns metadata for a single gradebook column in a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

columnId

String

Gradebook column ID.

x

fields

String

Comma-separated list of fields to include in the response.

expand

String

Related resources to expand in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Gradebook Get Grade Columns

<blackboard:course-gradebook-get-grade-columns>

Returns gradebook columns for a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

displayName

String

Display name of the resource.

name

String

Name of the resource.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

createdCompare

String

Comparison operator for the created timestamp filter.

modifiedCompare

String

Comparison operator for the modified filter.

gradebookCategoryId

  • Array of String

  • String

Gradebook category ID or list of category IDs.

expand

String

Related resources to expand in the response.

modified

String

Filter by last modified timestamp.

offset

Number

Zero-based index of the first item to return.

fields

String

Comma-separated list of fields to include in the response.

contentId

String

Content item ID.

limit

Number

Maximum number of items to return.

created

String

Filter by resource creation timestamp.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Gradebook Get Gradebook Categories

<blackboard:course-gradebook-get-gradebook-categories>

Returns gradebook categories defined for a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

offset

Number

Zero-based index of the first item to return.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

limit

Number

Maximum number of items to return.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Membership Create Course User Membership

<blackboard:course-membership-create-course-user-membership>

Enrolls a user in a course with a course role (creates a course membership).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

userId

String

User ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Membership Delete Course Membership

<blackboard:course-membership-delete-course-membership>

Removes a user’s membership from a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

userId

String

User ID.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Membership Get Course Membership

<blackboard:course-membership-get-course-membership>

Returns a specific user’s membership in a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

userId

String

User ID.

x

fields

String

Comma-separated list of fields to include in the response.

expand

String

Related resources to expand in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Membership Get Course Memberships

<blackboard:course-membership-get-course-memberships>

Returns course memberships for a course (users enrolled in the course).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

lastAccessed

String

Filter by last accessed timestamp.

availability.available

String

Filter by availability status.

role

String

Role filter for the request.

dataSourceId

String

Data source ID.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

createdCompare

String

Comparison operator for the created timestamp filter.

modifiedCompare

String

Comparison operator for the modified filter.

lastAccessedCompare

String

Comparison operator for the lastAccessed filter.

expand

String

Related resources to expand in the response.

modified

String

Filter by last modified timestamp.

offset

Number

Zero-based index of the first item to return.

fields

String

Comma-separated list of fields to include in the response.

sort

String

Sort order for the result set.

limit

Number

Maximum number of items to return.

created

String

Filter by resource creation timestamp.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Membership Get User Memberships

<blackboard:course-membership-get-user-memberships>

Returns course memberships for a user across courses.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

userId

String

User ID.

x

lastAccessed

String

Filter by last accessed timestamp.

availability.available

String

Filter by availability status.

role

String

Role filter for the request.

dataSourceId

String

Data source ID.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

createdCompare

String

Comparison operator for the created timestamp filter.

modifiedCompare

String

Comparison operator for the modified filter.

lastAccessedCompare

String

Comparison operator for the lastAccessed filter.

expand

String

Related resources to expand in the response.

modified

String

Filter by last modified timestamp.

offset

Number

Zero-based index of the first item to return.

fields

String

Comma-separated list of fields to include in the response.

sort

String

Sort order for the result set.

limit

Number

Maximum number of items to return.

created

String

Filter by resource creation timestamp.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Course Membership Update Course User Membership

<blackboard:course-membership-update-course-user-membership>

Updates a user’s course membership (for example, course role or availability).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

userId

String

User ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Courses Add Child Course

<blackboard:courses-add-child-course>

Links a child course to a parent course in a merged course hierarchy.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

childCourseId

String

Child course ID in a course merge hierarchy.

x

ignoreEnrollmentErrors

Boolean

Whether to ignore enrollment errors during the operation.

false

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Courses Create Course

<blackboard:courses-create-course>

Creates a new course in Blackboard Learn.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Courses Delete Course

<blackboard:courses-delete-course>

Deletes a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Courses Get Course

<blackboard:courses-get-course>

Returns details for a single course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Courses Get Course Child

<blackboard:courses-get-course-child>

Returns one child course record for a parent course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

childCourseId

String

Child course ID in a course merge hierarchy.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Courses Get Course Children

<blackboard:courses-get-course-children>

Returns child courses associated with a parent course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

includePermissions

Boolean

Whether to include permission metadata in the response.

false

expand

String

Related resources to expand in the response.

offset

Number

Zero-based index of the first item to return.

fields

String

Comma-separated list of fields to include in the response.

limit

Number

Maximum number of items to return.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Courses Get Courses

<blackboard:courses-get-courses>

Searches or lists courses using query parameters supported by the API.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

offset

Number

Zero-based index of the first item to return.

limit

Number

Maximum number of items to return.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

modified

String

Filter by last modified timestamp.

modifiedCompare

String

Comparison operator for the modified filter.

courseId

String

Course ID.

name

String

Name of the resource.

description

String

Description of the resource.

externalId

String

External identifier for the resource.

created

String

Filter by resource creation timestamp.

createdCompare

String

Comparison operator for the created timestamp filter.

allowGuests

Boolean

Whether guests are allowed.

false

availability.available

String

Filter by availability status.

dataSourceId

String

Data source ID.

termId

String

Academic term ID.

organization

Boolean

Whether to apply organization scope to the request.

false

sort

String

Sort order for the result set.

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Courses Remove Child Course

<blackboard:courses-remove-child-course>

Removes the child relationship between a child course and its parent course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

childCourseId

String

Child course ID in a course merge hierarchy.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Courses Update Course

<blackboard:courses-update-course>

Updates properties of an existing course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Roles Get Course Role

<blackboard:roles-get-course-role>

Returns a single course role definition by ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

roleId

String

Role ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Roles Get Course Roles

<blackboard:roles-get-course-roles>

Returns course roles available in the system.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

offset

Number

Zero-based index of the first item to return.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

limit

Number

Maximum number of items to return.

sort

String

Sort order for the result set.

custom

Boolean

Whether the resource is user-defined or custom.

false

roleId

String

Role ID.

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Roles Get Institution Role

<blackboard:roles-get-institution-role>

Returns a single institution role definition by ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

roleId

String

Role ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Roles Get Institution Roles

<blackboard:roles-get-institution-roles>

Returns institution roles defined in the system.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

offset

Number

Zero-based index of the first item to return.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

limit

Number

Maximum number of items to return.

sort

String

Sort order for the result set.

custom

Boolean

Whether the resource is user-defined or custom.

false

roleId

String

Role ID.

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Terms Create Term

<blackboard:terms-create-term>

Creates an academic term.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Terms Delete Term

<blackboard:terms-delete-term>

Deletes a term.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

termId

String

Academic term ID.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Terms Get Term

<blackboard:terms-get-term>

Returns details for a single term.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

termId

String

Academic term ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Terms Get Terms

<blackboard:terms-get-terms>

Returns terms, optionally filtered by query parameters.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

offset

Number

Zero-based index of the first item to return.

limit

Number

Maximum number of items to return.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

externalId

String

External identifier for the resource.

dataSourceId

String

Data source ID.

availability.available

String

Filter by availability status.

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Terms Update Term

<blackboard:terms-update-term>

Updates an existing term.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

termId

String

Academic term ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Token Access Token

<blackboard:token-access-token>

Requests an access token from the Blackboard Learn authorization server using the configured credentials.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Users Create User

<blackboard:users-create-user>

Creates a user in Blackboard Learn.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Users Delete User

<blackboard:users-delete-user>

Deletes a user.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

userId

String

User ID.

x

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Users Get User

<blackboard:users-get-user>

Returns details for a single user.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

userId

String

User ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Users Get Users

<blackboard:users-get-users>

Searches or lists users using query parameters supported by the API.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

offset

Number

Zero-based index of the first item to return.

limit

Number

Maximum number of items to return.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

userName

String

Username filter or value.

externalId

String

External identifier for the resource.

created

String

Filter by resource creation timestamp.

createdCompare

String

Comparison operator for the created timestamp filter.

modified

String

Filter by last modified timestamp.

modifiedCompare

String

Comparison operator for the modified filter.

lastLogin

String

Filter by last login timestamp.

lastLoginCompare

String

Comparison operator for the lastLogin filter.

dataSourceId

String

Data source ID.

institutionRoleIds

Array of String

Institution role IDs to filter by.

name.family

String

Filter by family name.

studentId

String

Student user ID.

contact.email

String

Filter by contact email address.

availability.available

String

Filter by availability status.

sort

String

Sort order for the result set.

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Users Update User

<blackboard:users-update-user>

Updates an existing user.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

userId

String

User ID.

x

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

body

Any

Request body for create or update operations.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Users Upcoming Events

<blackboard:usersupcoming-events>

Returns upcoming events for the authenticated user (for example, calendar or course activity within the requested range).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

courseId

String

Course ID.

type

String

Event or entity type filter.

since

String

Lower bound (inclusive) for the time range filter.

until

String

Upper bound (inclusive) for the time range filter.

offset

Number

Zero-based index of the first item to return.

includePermissions

Boolean

Whether to include permission metadata in the response.

false

limit

Number

Maximum number of items to return.

sort

String

Sort order for the result set.

fields

String

Comma-separated list of fields to include in the response.

correlationId

String

Optional client-supplied identifier for correlating requests.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • BLACKBOARD:BAD_REQUEST

  • BLACKBOARD:CLIENT_ERROR

  • BLACKBOARD:CONFLICT

  • BLACKBOARD:CONNECTIVITY

  • BLACKBOARD:FORBIDDEN

  • BLACKBOARD:INTERNAL_SERVER_ERROR

  • BLACKBOARD:NOT_FOUND

  • BLACKBOARD:SECURITY

  • BLACKBOARD:SERVER_ERROR

  • BLACKBOARD:TIMEOUT

  • BLACKBOARD:UNAUTHORIZED

Types

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Trust store configuration for TLS.

Key Store

Key Store

Key store configuration for TLS.

Revocation Check

Certificate revocation checking configuration.

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verifies the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Mule error type that triggers this mapping.

Target

String

Name of the error type to map to.

x
Back to top
View on GitHub