Microsoft SharePoint is a web application platform for content and document management, intranet portals, collaboration, extranets, websites and enterprise search. The Microsoft SharePoint connector for Anypoint platform enables integration with SharePoint 2013.

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.7.0 or higher

Configs

Okta Connection

<sharepoint-online:okta-connection-config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

oktaDomain

String

x 

username

String

x 

password

String

x 

oktaApiToken

String

x 

sharepointEmbededLink

String

x 

disableCnCheck

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception.

To prevent this it is possible to disable the CN (Common Name) check.

Note: this is not recommended for production environments.

false

 

proxyHost

String

 

proxyPort

Integer

 

proxyUsername

String

 

proxyPassword

String

 

Online Connection

<sharepoint-online:online-connection-config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

The username without the domain.

x 

password

String

Password used to authenticate the user

x 

siteUrl

String

Sharepoint endpoint URL

x 

disableCnCheck

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception.

To prevent this it is possible to disable the CN (Common Name) check.

Note: this is not recommended for production environments.

false

 

proxyHost

String

 

proxyPort

Integer

 

proxyUsername

String

 

proxyPassword

String

 

(Deprecated) Security Token Connection

<sharepoint-online:sectoken-connection-config>

Connection Management

Deprecated the SecurityTokenConnectionStrategy Connection Provider because the BasicConnectionProvider already obtains the security token by itself

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

siteUrl

String

Sharepoint endpoint URL

x 

securityToken

String

(Optional) Security token to access Sharepoint (if left empty a token provider instance should be configured)

 

securityTokenProvider

SecurityTokenProvider

 

disableCnCheck

Boolean

When dealing with HTTPS certificates, if the certificate is not signed by a trusted partner, the server might respond with an Exception.

To prevent this it is possible to disable the CN (Common Name) check.

Note: this is not recommended for production environments.

false

 

proxyHost

String

 

proxyPort

Integer

 

proxyUsername

String

 

proxyPassword

String

 

Processors

List item query

<sharepoint-online:list-item-query>

  Paged Operation

Executes a query against a Sharepoint list and returns list items that match the specified criteria

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

query

String

Query in the format listId?queryString

x 

retrieveReferences

Boolean

Retrieve references

false

 

pagingConfiguration

PagingConfiguration

pagination of results

x 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Map<String,Object>,SharepointOnlineConnector>

An array of Sharepoint List Items

List delete

<sharepoint-online:list-delete>

  DataSense enabled

Deletes a Sharepoint list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

listId

String

(Mandatory) Id of the list to delete

#[payload]

 

List get

<sharepoint-online:list-get>

  DataSense enabled

Retrieves a Sharepoint list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

listId

String

(Mandatory) Id of the list to retrieve

#[payload]

 

Returns

Return Java Type Description

SharepointList

A SharepointList

List get all

<sharepoint-online:list-get-all>

Retrieves all Sharepoint lists

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<SharepointList>

An Array of SharepointList

List update

<sharepoint-online:list-update>

  DataSense enabled

Updates the specified properties of a Sharepoint lists

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

listId

String

(Mandatory) Id of the list to update

x 

list

SharepointList

(Mandatory) List Properties to update

#[payload]

 

List create

<sharepoint-online:list-create>

Creates a new SharepointList

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

list

SharepointList

(Mandatory) Sharepoint List reference to create

#[payload]

 

Returns

Return Java Type Description

SharepointList

A SharepointList

List item create

<sharepoint-online:list-item-create>

  DataSense enabled

Creates a new Item in an existing Sharepoint list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

listId

String

(Mandatory) Id of the list where to create the Item

x 

properties

Map<String,Object>

(Mandatory) Properties of the item to create

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

A SharepointListItem

List item delete

<sharepoint-online:list-item-delete>

  DataSense enabled

Deletes an Item from a Sharepoint list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

listId

String

(Mandatory) Id of the list where to delete the Item

x 

itemId

String

(Mandatory) Id of the item to delete

#[payload]

 

Attach file

<sharepoint-online:attach-file>

  DataSense enabled

Attach a File to an item from a Sharepoint list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

listId

String

(Mandatory) Id of the list the item belongs to

x 

attachmentInfo

AttachmentInformation

(Mandatory) the attachment information.Contains the itemId of the list item, the file name and the file content represented as a stream. The stream and file name must be given if localFilePath is empty

#[payload]

 

localFilePath

String

the path to the file. Mandatory if the attachmentInfo is not filled with the relevant file information.

 

Returns

Return Java Type Description

SharePointAttachResult

List item update

<sharepoint-online:list-item-update>

  DataSense enabled

Updates an Item from a Sharepoint list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

listId

String

(Mandatory) Id of the list where to update the Item

x 

itemId

String

(Mandatory) Id of the item to update

x 

updatedProperties

Map<String,Object>

(Mandatory) Item properties to update

#[payload]

 

Folder create

<sharepoint-online:folder-create>

Creates a folder in a Document list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

url

String

(Mandatory) Server relative URL of the folder to create, e.g. /Shared Documents/new folder, creates a folder in the 'Shared Documents' list

#[payload]

 

welcomePage

String

(Optional) Welcome page property of the folder, e.g. index.html

 

Returns

Return Java Type Description

SharepointFolder

A SharepointFolder

Folder delete

<sharepoint-online:folder-delete>

Deletes a folder from a Document list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

url

String

(Mandatory) Server relative URL of the folder to delete, e.g. /Shared Documents/new folder, deletes 'new folder' from 'Shared Documents' list

#[payload]

 

Folder query

<sharepoint-online:folder-query>

Retrieves all folders that matches the specified criteria

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

query

String

(Mandayory) OData query in the format listDocumentName?queryString, e.g Shared Documents?$select=Name&$filter Name e.g. 'folderName'

x 

startingFolderPath

String

(Optional) The starting path of the folder from where to begin the query, relative to the document library selected as part of the query below, e.g. /myfolder/level2 search for folders inside /document library/myfolder/level2. [Note: you must specify the document library as part of the query below]

/

 

recursive

Boolean

Specifies whether to search recursively in inner folders

false

 

Returns

Return Java Type Description

List<Map<String,Object>>

An Array of SharepointFolders

File add

<sharepoint-online:file-add>

Adds a file to a Document list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Path and file name of the destination, e.g. /Shared Documents/#[flowVars.originalFilename] creates a file in 'Shared Documents' library

x 

fileContentStream

InputStream

(Optional) The byte stream to be uploaded, e.g. #[payload] or #[file reference] . [Note: One of File Content Stream or Local File Path has to be specified]

#[payload]

 

localFilePath

String

(Optional) Physical file path of a file to upload, e.g. /local/path/to/file.ext. [Note: One of File Content Stream or Local File Path has to be specified]

 

overwrite

Boolean

Specifies whether to overwrite the uploaded file if another with the same name already exists

false

 

Returns

Return Java Type Description

SharepointFile

A SharepointFile

File delete

<sharepoint-online:file-delete>

Deletes a file from a Document list

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to delete, e.g. /Shared Documents/filename.ext deletes 'filename.ext' from 'Shared Documents' library

#[payload]

 

File get metadata

<sharepoint-online:file-get-metadata>

Retrieves the metadata of a file

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to retrieve, e.g. /Shared Documents/filename.ext retrieves 'filename.ext' from 'Shared Documents' library

#[payload]

 

Returns

Return Java Type Description

SharepointFile

A SharepointFile

File update metadata

<sharepoint-online:file-update-metadata>

Updates the metadata of a file

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to retrieve, e.g. /Shared Documents/filename.ext retrieves 'filename.ext' from 'Shared Documents' library

x 

updatedProperties

Map<String,Object>

(Mandatory) File properties to update

#[payload]

 

File get content

<sharepoint-online:file-get-content>

Retrieves the content of a file

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to get the content, e.g. /Shared Documents/filename.ext gets the content of 'filename.ext' from 'Shared Documents' library

#[payload]

 

Returns

Return Java Type Description

byte[]

A ByteArray containing the file content

File check out

<sharepoint-online:file-check-out>

Checks out a file from a document library

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to check out, e.g. /Shared Documents/filename.ext checks out 'filename.ext' in 'Shared Documents' library

#[payload]

 

File undo check out

<sharepoint-online:file-undo-check-out>

Reverts an existing checkout for a file

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to undo the check out, e.g. /Shared Documents/filename.ext undoes the check out of 'filename.ext' in 'Shared Documents' library

#[payload]

 

File check in

<sharepoint-online:file-check-in>

Checks the file in to a document library based on the check-in type

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to check in, e.g. /Shared Documents/filename.ext checks in 'filename.ext' in 'Shared Documents' library

#[payload]

 

checkInType

CheckInType

Check In type for te file: MinorCheckIn, MajorCheckIn or OverwriteCheckIn

x 

comment

String

A comment for the check-in

 

File publish

<sharepoint-online:file-publish>

Submits the file for content approval

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to publish, e.g. /Shared Documents/filename.ext publishes 'filename.ext' in 'Shared Documents' library

#[payload]

 

comment

String

The comment for the published file

 

File unpublish

<sharepoint-online:file-unpublish>

Removes a file from content approval or unpublish a major version

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to unpublish, e.g. /Shared Documents/filename.ext unpublishes 'filename.ext' in 'Shared Documents' library

#[payload]

 

comment

String

The comment for the published file

 

File approve

<sharepoint-online:file-approve>

Approves a file submitted for content approval

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to approve, e.g. /Shared Documents/filename.ext approves 'filename.ext' in 'Shared Documents' library

#[payload]

 

comment

String

The comment for the approval

 

File deny

<sharepoint-online:file-deny>

Denies approval for a file that was submitted for content approval

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to deny, e.g. /Shared Documents/filename.ext denies 'filename.ext' in 'Shared Documents' library

#[payload]

 

comment

String

The comment for the denial

 

File copy to

<sharepoint-online:file-copy-to>

Copies the file to the destination URL

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to copy, e.g. /Shared Documents/filename.ext

#[payload]

 

newFileServerRelativeUrl

String

(Mandatory) Destination Sharepoint Server relative URL of the file to unpublish, e.g. /Shared Documents/new filename.ext copies to 'new filename.ext' in 'Shared Documents' library

x 

overwrite

Boolean

Specifies whether to overwrite a file with the same name in the same location

false

 

File recycle

<sharepoint-online:file-recycle>

Copies the file to the destination URL

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileServerRelativeUrl

String

(Mandatory) Sharepoint Server relative URL of the file to recycle, e.g. /Shared Documents/filename.ext recycle 'filename.ext' in 'Shared Documents' library

#[payload]

 

Returns

Return Java Type Description

String

The GUID of the recycled file

File query

<sharepoint-online:file-query>

Retrieves all file from a folder that matches the specified criteria

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

query

String

(Mandayory) OData query in the format listDocumentName?queryString, e.g Shared Documents?$select=Name&$filter Name eq 'filename'

x 

startingFolderPath

String

(Optional) The starting path of the folder from where to begin the query, relative to the document library selected as part of the query below, e.g. /myfolder/level2 search for files inside /document library/myfolder/level2. [Note: you must specify the document library as part of the query below]

/

 

recursive

Boolean

Specifies whether to search recursively in inner folders

false

 

Returns

Return Java Type Description

List<Map<String,Object>>

An Array of SharepointFile

Resolve object

<sharepoint-online:resolve-object>

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

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

url

String

(Mandatory) The absolute or relative url to get.

x 

resolveRequestType

ResolveRequestType

The request type to be sent.

Get

 

body

Object

Body of the request to send. 'null' if empty request body.

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

A Map with the results of the request. Returns 'null' when request returns no content.

Resolve collection

<sharepoint-online:resolve-collection>

Executes an HTTP GET against the Sharepoint API.

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

url

String

(Mandatory) The absolute or relative url to get.

x 

Returns

Return Java Type Description

List<Map<String,Object>>

A List of Map with the results of the request.