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

  3. Moodle Connector Reference

All Connectors

Moodle Connector 0.1.0 Reference

Anypoint Connector for Moodle (Moodle Connector) enables Mule applications to access the Moodle API.

Configurations

Config

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Moodle

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

Moodle
Parameters
Name Type Description Default Value Required

wstoken

String

Web service token for Moodle API authentication.

x

baseUri

String

The base URI for the Moodle instance.

x

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

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

Assignments Get All The Course Assignments

<moodle:assignments-get-all-the-course-assignments>

Returns the assignments for a course, including activity details the caller is permitted to view (Moodle assignment activity).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Assignments Get Assignment Grades

<moodle:assignments-get-assignment-grades>

Returns grader and submission grades for an assignment, consistent with the Moodle gradebook and assignment activity.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Assignments Get Assignment Submissions

<moodle:assignments-get-assignment-submissions>

Returns learner submissions for an assignment (files, text, status, and timestamps), as provided by the Moodle assignment subsystem.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Calendar Create Calendar Events

<moodle:calendar-create-calendar-events>

Creates calendar events in the Moodle calendar for the allowed contexts (such as course, user, or category), as described in Moodle’s calendar documentation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Calendar Delete Calendar Events

<moodle:calendar-delete-calendar-events>

Deletes one or more calendar events by ID from the Moodle calendar.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Calendar Get Calendar Event By Id

<moodle:calendar-get-calendar-eventby-id>

Returns a single calendar event by its Moodle event ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Calendar Get Calendar Events

<moodle:calendar-get-calendar-events>

Returns calendar events matching the request filters (for example, course, time window, or event type).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Calendar Get Calendar Events For Students

<moodle:calendar-get-calendar-events-for-students>

Returns calendar events for the specified student view (events visible to learners in the given courses or groups).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Cohort Add Cohort Members

<moodle:cohort-add-cohort-members>

Adds users to a site or category cohort (Moodle site-wide groups used for bulk enrollment).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Cohort Create Cohort

<moodle:cohort-create-cohorts>

Creates one or more cohorts (named batches of users for enrollment and administration).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Cohort Delete Cohort

<moodle:cohort-delete-cohort>

Deletes a cohort by ID when Moodle allows removal (for example, no blocking enrollment rules).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Cohort Delete Cohort Member

<moodle:cohort-delete-cohort-member>

Removes selected users from a cohort.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Cohort Get Cohort Members

<moodle:cohort-get-cohort-members>

Returns the list of users who belong to a cohort.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Cohort Get Cohorts

<moodle:cohort-get-cohorts>

Returns cohorts that match the supplied search and context filters.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Cohort Update Cohorts

<moodle:cohort-update-cohorts>

Updates cohort metadata (such as name, ID number, visibility, or associated category).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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 or Null

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Course Category Create Categories

<moodle:course-category-create-categories>

Creates course categories under a parent in the Moodle course category tree.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Course Category Delete Categories

<moodle:course-category-delete-categories>

Deletes course categories when Moodle permits (subcategories and linked courses must be handled per Moodle rules).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Course Category Get Categories

<moodle:course-category-get-categories>

Returns course categories and hierarchy for the requested filters (for example, parent, depth, or visibility).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Course Category Update Categories

<moodle:course-category-update-categories>

Updates course category fields (name, parent, sort order, description, and visibility).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Course Create Courses

<moodle:course-create-courses>

Creates new courses with the supplied settings (format, category, visibility, and other course fields).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Course Delete Courses

<moodle:course-delete-courses>

Deletes courses by ID, subject to Moodle capabilities and whether the course may be removed.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Course Get Courses

<moodle:course-get-courses>

Returns full course records for the requested course IDs (summary, format, settings, and custom fields exposed by the web service).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Course Get Courses By Field

<moodle:course-get-courses-by-field>

Looks up courses by a single field value (for example, shortname, idnumber, or category), as supported by Moodle’s core course API.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Course Update Courses

<moodle:course-update-courses>

Updates one or more existing courses (metadata, format options, and other fields allowed by the web service).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Enrollment Enroll Users

<moodle:enrollment-enroll-users>

Enrolls users in courses with the specified roles (manual enrollment and compatible enrollment plugins).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Enrollment Get Enrolled Users

<moodle:enrollment-get-enrolled-users>

Lists users enrolled in a course, including their assigned roles and group membership.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Enrollment Get Users Courses

<moodle:enrollment-get-users-courses>

Returns the courses a user is enrolled in (role and status depend on the web service response).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Enrollment Unenrol User

<moodle:enrollment-unenrol-user>

Unenrolls a user from a course for a specific enrollment instance (manual or plugin instance ID in the request).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Enrollment Unenroll Users

<moodle:enrollment-unenroll-users>

Unenrolls multiple users from courses in a single call, following Moodle enrollment rules for each instance.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Grade Report Get Course Grades

<moodle:grade-report-get-course-grades>

Returns course-level totals and user grades from the gradebook for the requested course and users.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Grade Report Get Grade Items

<moodle:grade-report-get-grade-items>

Returns grade items (activities and categories) for a course gradebook, including weights and settings exposed by the API.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Assign Groupings

<moodle:groups-assign-groupings>

Links groups to a grouping so activities can be restricted to that grouping in a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Create Group

<moodle:groups-create-group>

Creates a new group within a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Create Groupings

<moodle:groups-create-groupings>

Creates groupings (containers used to restrict activities to sets of groups) in a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Delete Group

<moodle:groups-delete-group>

Deletes a group from a course when no Moodle rules block removal.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Delete Groupings

<moodle:groups-delete-groupings>

Deletes a grouping from a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Get Course Groups

<moodle:groups-get-course-groups>

Returns all groups defined for a course.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Get Group

<moodle:groups-get-group>

Returns details for a single course group by ID.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Get Group Members

<moodle:groups-get-group-members>

Returns the members of a course group.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Get Groupings

<moodle:groups-get-groupings>

Returns groupings for a course, including which groups belong to each grouping when included in the response.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Unassign Groupings

<moodle:groups-unassign-groupings>

Removes groups from a grouping without deleting the groups themselves.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Groups Update Groupings

<moodle:groups-update-groupings>

Updates grouping name, ID number, or other fields supported by the Moodle groups API.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Token Access Token

<moodle:token-access-token>

Returns a web service token for the given user, service, and credentials by calling the Moodle login/token.php endpoint relative to the site base URL (see Moodle web services documentation).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

username

String

Moodle username.

x

password

String

Password for the account.

x

service

String

Moodle web service short name.

x

correlationId

String

An optional correlation ID for the request.

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

User Create Users

<moodle:user-create-users>

Creates new user accounts with the supplied profile fields (subject to Moodle authentication and user-creation policies).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

User Delete Users

<moodle:user-delete-users>

Deletes users by ID when the web service user is allowed to remove those accounts.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

User Get Users

<moodle:user-get-users>

Searches for users by criteria (for example, email, username, or custom profile fields) and returns matching user records.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

User Get Users By Id

<moodle:user-get-users-by-id>

Returns full user records for the specified Moodle user IDs.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

Array of Any

Attributes Type

Any

For Configurations

Throws

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

User Update Users

<moodle:user-update-users>

Updates profile and preference fields on existing user accounts allowed by the web service.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

correlationId

String

An optional correlation ID for the request.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

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

x

Target Variable

String

The 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

  • MOODLE:BAD_REQUEST

  • MOODLE:CLIENT_ERROR

  • MOODLE:CONNECTIVITY

  • MOODLE:FORBIDDEN

  • MOODLE:INTERNAL_SERVER_ERROR

  • MOODLE:NOT_FOUND

  • MOODLE:SECURITY

  • MOODLE:SERVER_ERROR

  • MOODLE:TIMEOUT

  • MOODLE:UNAUTHORIZED

Types

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of store.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of store.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

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. If specified, the alias must be in the trust store.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

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

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

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

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

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

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it 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

Error source type.

Target

String

Target error type.

x
Back to top
View on GitHub