Contact Us 1-800-596-4880
  1. Homepage
  2. Microsoft SharePoint Connector (3.6)

  3. Microsoft SharePoint Connector Reference

All Connectors

SharePoint Connector 3.6 Reference - Mule 4

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Anypoint Connector for SharePoint enables you to connect to a Microsoft SharePoint application.

Configurations

SharePoint Online

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Charset

Enumeration, one of:

  • US_ASCII

  • ISO_8859_1

  • UTF_8

  • UTF_16BE

  • UTF_16LE

  • UTF_16

UTF_8

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

OAuth v2.0 Authorization Code

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.

Parameters
Name Type Description Default Value Required

Site Url

String

URL for the target SharePoint instance.

x

Disable SSL certificate validation

Boolean

Disables the CN (Common Name) check so that the server won’t throw an exception if the HTTPS certificate is not signed by a trusted partner.

false

Host

String

Hostname for the proxy server.

Port

Number

Port number for the proxy server.

Username

String

Username to use for authenticating against the proxy server.

Password

String

Password to use for authenticating against the proxy server.

NTLM Domain

String

Domain to use for authenticating against the proxy server.

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.

Consumer Key

String

OAuth consumerKey registered with the service provider.

x

Consumer Secret

String

OAuth consumerSecret registered with the service provider.

x

Authorization Url

String

Authorization endpoint URL of the service provider.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize

Access Token Url

String

Access token endpoint URL of the service provider.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

Scopes

String

OAuth scopes requested during the dance. If not provided, it will default to those in the annotation.

Resource Owner Id

String

The resource owner ID is in the format <Resource_App_ID>/<Sharepoint_site_domain>@<Tenant_ID>. You can find the Resource_App_ID and Tenant_ID after you create your app. Go to Azure Active Directory > App registrations and select the app. The Resource_App_ID is the Application (client) ID and the Tenant_ID is the Directory (tenant) ID.

Before

String

Name of the flow that is executed immediately before starting the OAuth dance.

After

String

Name of the flow that is executed immediately after an access token is received.

Listener Config

String

Reference to a <http:listener-config /> used to create the listener that receives the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

If the callback endpoint is behind a proxy or accessed through a non direct URL, use this parameter to specify the OAuth provider that the URL should use to access the callback.

Object Store

String

A reference to the object store to use to store each resource owner ID’s data. If a value is not specified, Mule automatically provisions the default object store.
OAuth Client Credentials

Uses client credentials with certificate for authentication.

Name Type Description Default Value Required

Disable SSL certificate validation

Boolean

Disables the CN (Common Name) check so that the server won’t throw an exception if the HTTPS certificate is not signed by a trusted partner. To prevent this, you can disable the CN (Common Name) check. Avoid disabling this for production environments.

false

Site Url

String

URL for the target SharePoint instance.

x

Client ID

String

Client ID to use to call the API.

x

Token URL

String

URL used to get an access token.

x

Scopes

String

Defined scopes for the client ID.

Keystore alias

String

Alias used to get the correct certificate from the keystore.

x

Path to keystore

String

Path to the client’s keystore with the private key and certificate.

x

Keystore password

String

Password used to access the private key from the keystore.

x

Keystore type

Enumeration, one of:

  • JCEKS

  • JKS

  • PKCS12

Keystore type.

x

Key password

String

Password used to protect the private key.

Object Store

Object Store

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

Host

String

Hostname for the proxy server.

Port

Number

Port number for the proxy server.

Username

String

Username to use to authenticate against the proxy server.

Password

String

Password to use to authenticate against the proxy server.

NTLM Domain

String

Domain to use to authenticate against the proxy server.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.
Okta
Parameters
Name Type Description Default Value Required

Okta Username

String

Username to use to log in to the Okta Identity Provider

x

Okta Password

String

Password to use to log in to the Okta Identify Provider

x

Okta Domain

String

Domain name for the Okta Identity Provider

x

Okta API token

String

x

Sharepoint Online embedded link from Okta

String

x

Disable SSL certificate validation

Boolean

Disables the CN (Common Name) check so that the server won’t throw an exception if the HTTPS certificate is not signed by a trusted partner.

Disabling the CN check is not recommended for production environments.

false

Host

String

Hostname for the proxy server.

Port

Number

Port number for the proxy server.

Username

String

Username to use for authenticating against the proxy server

Password

String

Password to use for authenticating against the proxy server

NTLM Domain

String

Domain to use for authenticating against the proxy server

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.
Online
Parameters
Name Type Description Default Value Required

Online Username

String

Username to log in with. Do not include the domain name.

x

Online Password

String

Password to log in with

x

Site Url

String

URL for the target SharePoint instance

x

Disable SSL certificate validation

Boolean

Disables the CN (Common Name) check so that the server won’t throw an exception if the HTTPS certificate is not signed by a trusted partner.

Disabling the CN check is not recommended for production environments.

false

Host

String

Hostname for the proxy server.

Port

Number

Port number for the proxy server.

Username

String

Username to use for authenticating against the proxy server

Password

String

Password to use for authenticating against the proxy server

NTLM Domain

String

Domain to use for authenticating against the proxy server

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.
(DEPRECATED) Security Token

The Security Token connection provider is deprecated because the Basic Connection provider already obtains the security token.

Parameters
Name Type Description Default Value Required

Security Token

String

x

Security Token Provider

SecurityTokenProvider

(Optional) Provider instance that provides the security token when required.

Site Url

String

URL for the target SharePoint instance

x

Disable SSL certificate validation

Boolean

Disables the CN (Common Name) check so that the server won’t throw an exception if the HTTPS certificate is not signed by a trusted partner.

Disabling the CN check is not recommended for production environments.

false

Host

String

Hostname for the proxy server

Port

Number

Port number for the proxy server

Username

String

Username to use for authenticating against the proxy server

Password

String

Password to use for authenticating against the proxy server

NTLM Domain

String

Domain to use for authenticating against the proxy server

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.

SharePoint On-premises

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Charset

Enumeration, one of:

  • US_ASCII

  • ISO_8859_1

  • UTF_8

  • UTF_16BE

  • UTF_16LE

  • UTF_16

UTF_8

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

Claims
Parameters
Name Type Description Default Value Required

Claims Username

String

Username to log in with. Do not include the domain name.

x

Claims Password

String

Password to log in with

x

Site Url

String

URL for the target SharePoint instance

x

Sts Url

String

Security Token Service URL to use for claims authentication

x

Scope

String

Application Identifier configured for this SharePoint site in the Security Token Service (Relying Party Identifier, Client Identifier, Scope or Realm).

x

Disable SSL certificate validation

Boolean

Disables the CN (Common Name) check so that the server won’t throw an exception if the HTTPS certificate is not signed by a trusted partner.

Disabling the CN check is not recommended for production environments.

false

Host

String

Hostname for the proxy server.

Port

Number

Port number for the proxy server.

Username

String

Username to use for authenticating against the proxy server

Password

String

Password to use for authenticating against the proxy server

NTLM Domain

String

Domain to use for authenticating against the proxy server

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.
Kerberos
Parameters
Name Type Description Default Value Required

Kerberos Username

String

Username to log in with. Do not include the domain name.

x

Kerberos Password

String

Password to log in with

x

Site Url

String

URL for the target SharePoint instance

x

SPN

String

(Optional) Service principal name for the SharePoint Web Service

Realm

String

(Optional) The case-sensitive default realm (Domain Name) that the user belongs to.

KDC

String

(Optional) The KDC (usually the Domain Controller name) to authenticate the user.

Login Properties File Path

String

(Optional) Path to a customized login properties file. The default values work for most cases

Properties File Path

String

(Optional) Path to a customized Kerberos properties file.

Disable SSL certificate validation

Boolean

Disables the CN (Common Name) check so that the server won’t throw an exception if the HTTPS certificate is not signed by a trusted partner.

Disabling the CN check is not recommended for production environments.

false

Host

String

Hostname for the proxy server.

Port

Number

Port number for the proxy server.

Username

String

Username to use for authenticating against the proxy server

Password

String

Password to use for authenticating against the proxy server

NTLM Domain

String

Domain to use for authenticating against the proxy server

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.
NTLM
Parameters
Name Type Description Default Value Required

Domain

String

Domain name to use for NTLM authorization

x

Ntlm Username

String

Username to log in with. Do not include the domain name.

x

Ntlm Password

String

Password NTLM authorization.

x

Site Url

String

URL for the target SharePoint instance

x

Disable SSL certificate validation

Boolean

Disables the CN (Common Name) check so that the server won’t throw an exception if the HTTPS certificate is not signed by a trusted partner.

Disabling the CN check is not recommended for production environments.

false

Host

String

Hostname for the proxy server.

Port

Number

Port number for the proxy server.

Username

String

Username to use for authenticating against the proxy server

Password

String

Password to use for authenticating against the proxy server

NTLM Domain

String

Domain to use for authenticating against the proxy server

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.
Security Token

The Security Token connection strategy connection provider is deprecated because the Basic Connection provider already obtains the security token.

Parameters
Name Type Description Default Value Required

Security Token

String

x

Security Token Provider

SecurityTokenProvider

(Optional) Provider instance that provides the security token when required.

Site Url

String

URL for the target SharePoint instance

x

Disable SSL certificate validation

Boolean

Disables the CN (Common Name) check so that the server won’t throw an exception if the HTTPS certificate is not signed by a trusted partner.

Disabling the CN check is not recommended for production environments.

false

Host

String

Hostname for the proxy server.

Port

Number

Port number for the proxy server.

Username

String

Username to use for authenticating against the proxy server.

Password

String

Password to use for authenticating against the proxy server.

NTLM Domain

String

Domain to use for authenticating against the proxy server

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.

List of Sources

List of Operations

Sources

SharePoint Connector sources (listeners) use Object Store to save watermarks. You might experience limitations that are specific to the Object Store implementation you are using (Object Store for CloudHub deployments or Object Store for on-premises deployments), so you must configure Object Store to suit your needs.
For more information, see The Different Types of Object Stores Explained.

On New Objects

<sharepoint:created-objects>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Since

String

Required date format is yyyy-MM-ddTHH:mm:ssZ. If left empty, the UTC moment of time is used as a starting point.

Object Type

Enumeration, one of:

  • FOLDER

  • FILE

  • LIST

  • LIST_ITEM

The type of objects to listen for

x

List Id

String

Used when listening for newly created list items or files

Recursive

Boolean

Used when listening for created files or folders

false

Path

String

Base path for the FOLDER and FILE object types

/

Primary Node Only

Boolean

Whether this source should be executed only on the primary node when running in Cluster mode

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Attributes Type

Any

Associated Configurations

On Deleted Objects

<sharepoint:deleted-objects>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Since

String

Required date format is yyyy-MM-ddTHH:mm:ssZ

Primary Node Only

Boolean

Whether this source should be executed only on the primary node when running in Cluster mode

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Deleted Object

Attributes Type

Any

Associated Configurations

On Modified Objects

<sharepoint:modified-objects>

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Since

String

Required date format is yyyy-MM-ddTHH:mm:ssZ. If left empty, the UTC moment of time is used as a starting point

Object Type

Enumeration, one of:

  • FOLDER

  • FILE

  • LIST

  • LIST_ITEM

The type of objects to listen for

x

List Id

String

Used when listening for modified list items or files

Recursive

Boolean

Used when listening for modified files or folders

false

Path

String

/

Primary Node Only

Boolean

Whether this source should be executed only on the primary node when running in Cluster mode

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling

x

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Attributes Type

Any

Associated Configurations

Operations

Attach File

<sharepoint:attach-file>

Attach a file to an item from a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

List Title

String

Title of the list to which the item belongs

x

Item Id

String

The ID of the list item.

x

File Name

String

The name of the file.

x

Content

Binary

The file content represented as a stream. The stream and file name must be specified if localFilePath is empty

#[payload]

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Add

<sharepoint:file-add>

Adds a file.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

File Server Relative Url

String

Where to add the new file.

x

File Content Stream

Binary

The content that this new file should contain.

Overwrite

Boolean

True if this operation should overwrite the destination file if it already exists, false otherwise.

false

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

SharePoint File

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Approve

<sharepoint:file-approve>

Approves the file submitted for content approval with the specified comment. Only documents in lists that are enabled for content approval can be approved.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

The path of the file to be approved

x

Comment

String

Additional comment for this approve operation

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Check In

<sharepoint:file-check-in>

Executes a check in operation on a file in SharePoint that has been previously checked out.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

The path of the file to be checked in

x

Check In Type

Enumeration, one of:

  • MINOR_CHECK_IN

  • MAJOR_CHECK_IN

  • OVERWRITE_CHECK_IN

Type of check in to execute

x

Comment

String

Additional comment for this check in

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Check Out

<sharepoint:file-check-out>

Executes a checkout request on file in SharePoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

The path of the file to be checked out

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Copy To

<sharepoint:file-copy-to>

Copies a file from fileServerRelativeUrl to newFileServerRelativeUrl.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

The path of the file to be copied

x

New File Server Relative Url

String

x

Overwrite

Boolean

True if this operation should overwrite the destination file if it already exists, false otherwise.

false

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Delete

<sharepoint:file-delete>

Deletes a file.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

The path of the file to be deleted

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Deny

<sharepoint:file-deny>

Denies approval for a file that was submitted for content approval. Only documents in lists that are enabled for content approval can be denied.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

The path of the file to be denied

x

Comment

String

Additional comment for this deny operation

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Get Content

<sharepoint:file-get-content>

Retrieves content of a file in SharePoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

File Server Relative Url

String

Target file that contains the content to retrieve from SharePoint.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Binary

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Move

<sharepoint:file-move>

Executes an HTTP POST against the Sharepoint API to move a file. The fileServerRelativeUrl parameter must point to an existing file in SharePoint. The newFileServerRelativeUrl parameter must be the path for where to move the file. If the provided path is to a directory, an error will be thrown since it should be a new file path. The new file can have the same name as the old file or it can have a new name.

To use this operation as a rename operation, specify the same path in both parameters and use a different file name in the newFileServerRelativeUrl parameter.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

Path to the source file

x

New File Server Relative Url

String

Path to the destination file

x

Flag

Number

  • 8 - Completes the move operation even if supporting files are separated from the file.

  • 0 - No move operation specified.

  • 1 - Overwrites a file with the same name if it exists.

1

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Publish

<sharepoint:file-publish>

Submits the file for content approval with the specified comment.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

The path of the file to be published

x

Comment

String

Additional comment for this publish operation

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Query

<sharepoint:file-query>

Executes a request on SharePoint to find the files that match the specified query.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Query

String

The query to execute.

x

Starting Folder Path

String

The starting folder for the query.

/

Recursive

Boolean

True if the query should be executed on sub-folders, false otherwise.

false

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Recycle

<sharepoint:file-recycle>

Moves the file to the Recycle Bin and returns the identifier of the new Recycle Bin item.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

File Server Relative Url

String

The path of the file to be recycled.

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Undo Check Out

<sharepoint:file-undo-check-out>

If a file is checked out, this operation can revert the checkout state.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

The path of the file to revert

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Unpublish

<sharepoint:file-unpublish>

Removes the file from content approval or unpublishes a major version.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

Path of the file to unpublish

x

Comment

String

Additional comment for this unpublish operation

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

File Update Metadata

<sharepoint:file-update-metadata>

Update metadata for a target item in SharePoint.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

File Server Relative Url

String

Target item in SharePoint to update its metadata

x

Update Properties

Object

New metadata

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

Folder Create

<sharepoint:folder-create>

Creates a folder in a Document list

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Url

String

Server relative URL of the folder to create. For example, /Shared Documents/new folder creates a folder in the Shared Documents list.

x

Welcome Page

String

Welcome page property of the folder, for example, index.html

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

SharePoint Folder

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

Folder Delete

<sharepoint:folder-delete>

Deletes a folder from a Document list

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Url

String

Server relative URL of the folder to delete. For example, /Shared Documents/new folder, deletes new folder from the Shared Documents list.

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

Folder Query

<sharepoint:folder-query>

Retrieves all folders that match the specified criteria.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Query

String

OData query in the format listDocumentName?queryString, for example, Shared Documents?$select=Name&$folderName

x

Starting Folder Path

String

The starting path of the folder from where to begin the query, relative to the document library selected as part of the query. For example, /myfolder/level2 searches for folders inside /document library/myfolder/level2. NOTE: You must specify the document library as part of the query.

/

Recursive

Boolean

Specifies whether to search recursively in inner folders

false

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

Get Metadata

<sharepoint:get-metadata>

Gets the metadata of a determined file.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

File Server Relative Url

String

The path of the item that is retrieved for its metadata.

x

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

SharePoint File

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

List Create

<sharepoint:list-create>

Creates a new SharePointList.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

List

SharePoint List

SharePoint List reference to create

Target Variable

String

The name of a variable that stores the operation’s output

x

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

SharePoint List

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

List Delete

<sharepoint:list-delete>

Deletes a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

List Id

String

ID of the list to delete

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

List Get

<sharepoint:list-get>

Retrieves a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

List Id

String

ID of the list to retrieve

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

SharePoint List

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

List Get All

<sharepoint:list-get-all>

Retrieves all SharePoint lists.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of SharePoint List

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

List Item Create

<sharepoint:list-item-create>

Creates a new Item in an existing SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

List Id

String

ID of the list in which to create the item

x

Properties

Object

Properties of the item to create

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

List Item Delete

<sharepoint:list-item-delete>

Deletes an Item from a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

List Id

String

ID of the list in which to delete the Item

x

Item Id

String

ID of the item to delete

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

List Item Query

<sharepoint:list-item-query>

Executes a query against a SharePoint list and returns list items that match the specified criteria. This operation returns the list of all items because the operation supports pagination.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Query

String

Query in the format listId?queryString

x

Retrieve References

Boolean

Retrieves full objects for reference fields. NOTE: Large lists with a lot of reference fields can take a long time to retrieve.

false

Streaming Strategy

Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

Associated Configurations

Throws

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:CONNECTIVITY

List Item Update

<sharepoint:list-item-update>

Updates an Item from a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

List Id

String

ID of the list in which to update the item

x

Item Id

String

ID of the item to update

x

Updated Properties

Object

Item properties to update

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

List Update

<sharepoint:list-update>

Updates the specified properties of a SharePoint list.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

List Id

String

ID of the list to update

x

List

SharePoint List

List properties to update

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

Resolve Collection

<sharepoint:resolve-collection>

Executes an HTTP GET against the SharePoint API.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Url

String

The absolute or relative URL to get

x

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

Resolve Object

<sharepoint:resolve-object>

Executes an HTTP GET against the SharePoint API. (Executes a POST if the body is blob).

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Url

String

The absolute or relative URL to get

x

Request Type

Enumeration, one of:

  • Get

  • Create

  • Merge

  • Delete

The request type to be sent.

Get

Request Body

Any

Body of the request to send. The operation sends null if the request body is empty.

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of this expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

Associated Configurations

Throws

  • SHAREPOINT:INVALID_PARAMETERS

  • SHAREPOINT:RETRY_EXHAUSTED

  • SHAREPOINT:UNKNOWN

  • SHAREPOINT:NOT_FOUND

  • SHAREPOINT:CONNECTIVITY

Unauthorize

<sharepoint:unauthorize>

Deletes all the access token information of a given resource owner ID so that it is impossible to execute any operation for that user without doing the authorization dance again.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner of which access should be invalidated

Associated Configurations

Types

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 to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

blocking

Boolean

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

true

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.

true

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

A time unit that qualifies the maxIdleTime attribute

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a process-failed message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use.

SHA-256

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property can be set only if useSecureHash is false.

Object Store

Object Store

The object store where the redelivery counter for each message is stored.

Deleted Object

Field Type Description Default Value Required

Author Email

String

Author Name

String

Deleted By Name

String

Deleted Date

String

Deleted Date Local Formatted

String

Dir Name

String

Id

String

Item State

Number

Item Type

Number

Size

String

Title

String

SharePoint File

Field Type Description Default Value Required

Author

Object

Check In Comment

String

Check Out Type

String

Checked Out By User

Object

Content Tag

String

Customized Page Status

String

E Tag

String

Exists

Boolean

Length

Number

Level

Number

Linking Url

String

List Item All Fields

Object

Locked By User

Object

Major Version

Number

Metadata

Object

Minor Version

Number

Modified By

Object

Name

String

Server Relative Url

String

Time Created

String

Time Last Modified

String

Title

String

U I Version

Number

U I Version Label

String

Unique Id

String

Versions

Object

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Max Buffer Size fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

SharePoint Folder

Field Type Description Default Value Required

Exists

Boolean

Files

Object

Folders

Object

Item Count

Number

List Item All Fields

Object

Metadata

Object

Name

String

Parent Folder

Object

Properties

Object

Server Relative Url

String

Time Created

String

Time Last Modified

String

Unique Id

String

Welcome Page

String

SharePoint List

Field Type Description Default Value Required

Allow Content Types

Boolean

Base Template

Enumeration, one of:

  • GENERIC_LIST

  • DOCUMENT_LIBRARY

  • SURVEY

  • LINKS

  • ANNOUNCEMENTS

  • CONTACTS

  • EVENTS

  • TASKS

  • DISCUSSION_BOARD

  • PICTURE_LIBRARY

  • DATASOURCES

  • WEB_TEMPLATE_CATALOG

  • USER_INFORMATION

  • WEB_PART_CATALOG

  • LIST_TEMPLATE_CATALOG

  • XML_FORM

  • MASTER_PAGE_CATALOG

  • NO_CODE_WORKFLOWS

  • WORKFLOW_PROCESS

  • WEB_PAGE_LIBRARY

  • CUSTOM_GRID

  • SOLUTION_CATALOG

  • NO_CODE_PUBLIC

  • THEME_CATALOG

  • DESIGN_CATALOG

  • APP_DATA_CATALOG

  • DATA_CONNECTION_LIBRARY

  • WORKFLOW_HISTORY

  • GANTT_TASKS

  • HELP_LIBRARY

  • ACCESS_REQUEST

  • TASKS_WITH_TIMELINE_AND_HIERARCHY

  • MAINTENANCE_LOGS

  • MEETINGS

  • AGENDA

  • MEETING_USER

  • DECISION

  • MEETING_OBJECTIVE

  • TEXT_BOX

  • THINGS_TO_BRING

  • HOME_PAGE_LIBRARY

  • POSTS

  • COMMENTS

  • CATEGORIES

  • FACILITY

  • WHEREABOUTS

  • CALL_TRACK

  • CIRCULATION

  • TIMECARD

  • HOLIDAYS

  • IME_DIC

  • EXTERNAL_LIST

  • MY_SITE_DOCUMENT_LIBRARY

  • ISSUE_TRACKING

  • ADMIN_TASKS

  • HEALTH_RULES

  • HEALTH_REPORTS

  • DEVELOPER_SITE_DRAFT_APPS

Base Type

Number

Content Types

Object

Content Types Enabled

Boolean

Crawl Non Default Views

Boolean

Creatables Info

Object

Created

String

Default Content Approval Workflow Id

String

Default Display Form Url

String

Default Edit Form Url

String

Default New Form Url

String

Default View

Object

Description

String

Description Resource

Object

Direction

Enumeration, one of:

  • NONE

  • LTR

  • RTL

Document Template Url

String

Draft Version Visibility

Enumeration, one of:

  • READER

  • AUTHOR

  • APPROVER

Enable Attachments

Boolean

Enable Folder Creation

Boolean

Enable Minor Versions

Boolean

Enable Moderation

Boolean

Enable Versioning

Boolean

Entity Type Name

String

Event Receivers

Object

Fields

Object

First Unique Ancestor Securable Object

Object

Force Checkout

Boolean

Forms

Object

Has External Data Source

Boolean

Hidden

Boolean

Id

String

Image Url

String

Information Rights Management Settings

Object

Irm Enabled

Boolean

Irm Expire

Boolean

Irm Reject

Boolean

Is Application List

Boolean

Is Catalog

Boolean

Is Private

Boolean

Item Count

Number

Items

Object

Last Item Deleted Date

String

Last Item Modified Date

String

List Item Entity Type Full Name

String

Major Version Limit

Number

Major With Minor Versions Limit

Number

Metadata

Object

Multiple Data List

Boolean

No Crawl

Boolean

On Quick Launch

Boolean

Parent Web

Object

Parent Web Url

String

Parser Disabled

Boolean

Role Assignments

Object

Root Folder

Object

Server Template Can Create Folders

Boolean

Template Feature Id

String

Title

String

Title Resource

Object

User Custom Actions

Object

Validation Formula

String

Validation Message

String

Views

Object

Workflow Associations

Object

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

100

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

100

Max Buffer Size

Number

The maximum amount of memory to use. If more memory is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than what is specified is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

See Also

MuleSoft Help Center

Back to top
View on GitHub