org.mule.modules

mule-module-sharepoint

config

Namespace	http://www.mulesoft.org/schema/mule/sharepoint
Schema Location	http://www.mulesoft.org/schema/mule/sharepoint/current/mule-sharepoint.xsd (View Schema)
Schema Version	1.7.2
Minimum Mule Version	3.3.0

Module Overview

SharePoint is a web application platform for content and document management, intranet portals, collaboration, extranets, websites, and enterprise search. Mule SharePoint connector enables integrating with SharePoint.

Summary

Configuration
<sharepoint:config> Configure an instance of this module

Message Processors
<sharepoint:alert-delete-alerts> Deletes the specified alerts within a Web site.
<sharepoint:alert-get-alerts> Returns information about the alerts within a Web site.
<sharepoint:auth-login> Used in a forms-based authentication system to either set an authentication cookie or, if there is a problem with the logon, return an error code.
<sharepoint:auth-mode> Returns the authentication mode for the current SharePoint site.
<sharepoint:copy-copy-into-items> Copies a document represented by a Byte array to one or more locations on a server.
<sharepoint:copy-copy-into-items-local> Copies a document from one location on a server running Microsoft SharePoint Foundation to another location on the same server.
<sharepoint:copy-get-item> Generates a Byte array representation of a document that can be passed to the CopyIntoItems method to copy the document to a different server.
<sharepoint:dws-can-create-dws-url> Determines whether the user has sufficient rights to create a Document Workspace site with the proposed URL on the server.
<sharepoint:dws-create-dws> Creates a Document Workspace site and optionally adds users to the new SharePoint site.
<sharepoint:dws-create-folder> Creates a subfolder in the document library of the current Document Workspace site.
<sharepoint:dws-delete-dws> Deletes the current Document Workspace site and its contents.
<sharepoint:dws-delete-folder> Deletes a subfolder from a document library of the current Document Workspace site.
<sharepoint:dws-find-dws-doc> Returns the absolute URL of a document listed in the documents parameter of a previous call to the CreateDws method.
<sharepoint:dws-get-dws-data> Returns information about a Document Workspace site and the lists it contains.
<sharepoint:dws-get-dws-meta-data> Returns information about a Document Workspace site and the lists it contains.
<sharepoint:dws-remove-dws-user> Removes the specified user from the list of users for the current Document Workspace site.
<sharepoint:dws-rename-dws> Changes the title of the current Document Workspace site.
<sharepoint:dws-update-dws-data> Performs a batch update of items and data for the Document Workspace site.
<sharepoint:email-change-contacts-membership-in-distribution-group> Requests the addition and removal of contacts from the specified e-mail distribution group.
<sharepoint:email-change-users-membership-in-distribution-group> Requests the addition and removal of users from the specified e-mail distribution group.
<sharepoint:email-create-contact> Requests the creation of a new contact from the specified name and data.
<sharepoint:email-create-distribution-group> Requests the creation of a new e-mail distribution list from the specified data.
<sharepoint:email-delete-contact> Requests the deletion of a contact from the Active Directory container.
<sharepoint:email-delete-distribution-group> Requests the deletion of an e-mail distribution group.
<sharepoint:email-get-job-status> Requests an update on the status of a previous request that had PendingApproval status when it was last checked.
<sharepoint:email-modify-contact> Requests a change in information about a contact.
<sharepoint:email-modify-distribution-group> Requests a change in the stored information about an e-mail distribution group.
<sharepoint:email-rename-distribution-group> Request a change in the alias for an e-mail distribution group.
<sharepoint:form-get-form> Returns the schema of a form for a specified list based on the name of the list and the URL of the form.
<sharepoint:form-get-form-collection> Returns the URLs and types of the forms for a list.
<sharepoint:get-file-as-stream> Returns the stream content of the file.
<sharepoint:group-add-group> Adds a group to the current site collection.
<sharepoint:group-add-group-to-role> Adds the specified group to the specified role definition.
<sharepoint:group-add-role> Adds a role definition to the current site collection.
<sharepoint:group-add-role-def> Adds a role definition to the current site collection.
<sharepoint:group-add-user-collection-to-group> Adds the collection of users to the specified group.
<sharepoint:group-add-user-collection-to-role> Adds the collection of users to the specified role definition.
<sharepoint:group-add-user-to-group> Adds the user to the specified group.
<sharepoint:group-add-user-to-role> Adds the user to the specified role definition.
<sharepoint:group-get-all-user-collection-from-web> Returns information about the collection of users for the current Web site.
<sharepoint:group-get-current-user-info> Gets the current user info API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getcurrentuserinfo(v=office.14).aspx
<sharepoint:group-get-group-collection> Returns information about the specified groups in the current site collection.
<sharepoint:group-get-group-collection-from-role> Returns information about the collection of groups assigned to the specified role definition.
<sharepoint:group-get-group-collection-from-site> Removes the specified users from the current site collection.
<sharepoint:group-get-group-collection-from-user> Returns information about the collection of groups of which the specified user is a member.
<sharepoint:group-get-group-collection-from-web> Returns information about the collection of groups for the current Web site.
<sharepoint:group-get-group-info> Returns information about the specified group.
<sharepoint:group-get-role-collection> Returns information about the specified collection of role definitions for the current Web site.
<sharepoint:group-get-role-collection-from-group> Returns information about the collection of role definitions of which the specified group is a member.
<sharepoint:group-get-role-collection-from-user> Retrieves information about the collection of role definitions in which the specified user is a member.
<sharepoint:group-get-role-collection-from-web> Returns information about the collection of groups for the current Web site.
<sharepoint:group-get-role-info> Returns information about the specified role definition.
<sharepoint:group-get-roles-and-permissions-for-current-user> Retrieves permissions and role definitions for the current user.
<sharepoint:group-get-roles-and-permissions-for-site> Retrieves permissions and role definitions for the specified Web site.
<sharepoint:group-get-user-collection> Returns information about a collection of users based on the specified user names.
<sharepoint:group-get-user-collection-from-group> Returns information about the collection of users in the specified group.
<sharepoint:group-get-user-collection-from-role> Returns information about the collection of users assigned to the specified role definition.
<sharepoint:group-get-user-collection-from-site> Returns information about the collection of users for the current site collection.
<sharepoint:group-get-user-collection-from-web> Returns information about the collection of users for the current Web site.
<sharepoint:group-get-user-info> Returns information about the specified user.
<sharepoint:group-get-user-login-from-email> Returns a user name based on the specified e-mail address.
<sharepoint:group-remove-group> Removes the specified group from the current site collection.
<sharepoint:group-remove-group-from-role> Removes the specified group from the specified role definition.
<sharepoint:group-remove-role> Removes the specified role definition from the current Web site.
<sharepoint:group-remove-user-collection-from-group> Removes the users with the specified user names from the group.
<sharepoint:group-remove-user-collection-from-role> Removes the users with the specified user names from the specified role definition.
<sharepoint:group-remove-user-collection-from-site> Removes the specified users from the current site collection.
<sharepoint:group-remove-user-from-group> Removes the specified user from the specified group.
<sharepoint:group-remove-user-from-role> Removes the specified user from the specified role definition.
<sharepoint:group-remove-user-from-site> Removes the specified user from the current site collection.
<sharepoint:group-remove-user-from-web> Removes the specified user from the current Web site.
<sharepoint:group-update-group-info> Updates information for the specified group.
<sharepoint:group-update-role-def-info> Updates information for the specified role definition.
<sharepoint:group-update-role-info> Updates information for the specified role definition.
<sharepoint:group-update-user-info> Updates information for the specified user.
<sharepoint:imaging-check-subweb-and-list> Checks the specified URL and attempts to resolve it.
<sharepoint:imaging-create-new-folder> Creates a new folder with the name "New folder" in the specified list and folder.
<sharepoint:imaging-delete> Removes the specified files and folders (items) from the specified list on the current Web site.
<sharepoint:imaging-download> Downloads the specified files (items) in a list on the current Web site.
<sharepoint:imaging-get-items-by-ids> Returns the items with the specified IDs.
<sharepoint:imaging-get-items-xml-data> Returns the metadata of all items in the specified list on the current Web site.
<sharepoint:imaging-get-list-items> Returns the last modified date and other information about the items in a specified folder in a list on the current Web site.
<sharepoint:imaging-list-picture-library> Lists all picture libraries on the current Web site.
<sharepoint:imaging-rename> Renames the specified files (items) in a list on the current Web site.
<sharepoint:imaging-upload> Uploads a file to a list on the current Web site.
<sharepoint:list-add-attachment> Adds an attachment to the specified list item in the specified list.
<sharepoint:list-add-discussion-board-item> Adds an item to the specified discussion board on the current Web site.
<sharepoint:list-add-list> Creates a list in the current site based on the specified name, description, and list template ID.
<sharepoint:list-add-list-from-feature> Creates a list in the current site based on the specified name, description, Feature ID, and list template ID.
<sharepoint:list-add-wiki-page> Adds wiki page
<sharepoint:list-check-out-file> Allows documents in a SharePoint document library to be checked out remotely.
<sharepoint:list-create-content-type> Creates a list content type on the list.
<sharepoint:list-delete-attachment> Removes the attachment from the specified list item.
<sharepoint:list-delete-content-type> Removes the specified list content type from the designated list.
<sharepoint:list-delete-content-type-xml-document> Removes the specified list content type xml document.
<sharepoint:list-delete-list> Deletes the specified list.
<sharepoint:list-get-attachment-collection> Returns a list of the URLs for attachments to the specified item.
<sharepoint:list-get-list> Returns a schema for the specified list.
<sharepoint:list-get-list-and-view> Returns the list and view schemas for the specified list
<sharepoint:list-get-list-collection> Returns the names and GUIDs for all lists in the site.
<sharepoint:list-get-list-content-type> Returns the content type definition schema for the specified list content type.
<sharepoint:list-get-list-content-types> Returns a collection of content type definition schemas for all list content types on the given list.
<sharepoint:list-get-list-content-types-and-properties> Returns a collection of content types and properties for the given list
<sharepoint:list-get-list-item-changes> Returns changes made to the list since the specified date and time.
<sharepoint:list-get-list-item-changes-since-token> Returns changes made to the list since the date and time specified in the token.
<sharepoint:list-get-list-item-changes-with-knowledge> Returns all of the list items that meet specified criteria and that have changed since the date-time specified in the knowledge parameter for the specified list.
<sharepoint:list-get-list-items> Returns information about items in the list based on the specified query.
<sharepoint:list-get-version-collection> Returns version information for the specified field in a SharePoint list.
<sharepoint:list-list-check-in-file> Allows documents to be checked in to a SharePoint document library remotely
<sharepoint:list-undo-check-out> Undoes the check-out of a given document in a SharePoint document library.
<sharepoint:list-update-content-type> Updates the specified list content type.
<sharepoint:list-update-content-type-xml-document> Adds or overwrites the specified XMLDocument element in the specified list content type.
<sharepoint:list-update-content-types-xml-document> Adds or overwrites the specified XMLDocument element for all content types on the specified list.
<sharepoint:list-update-list> Updates a list based on the specified field definitions and list properties.
<sharepoint:list-update-list-items> Adds, deletes, or updates the specified items in a list on the current site.
<sharepoint:list-update-list-items-with-knowledge> Makes inserts, updates, and deletions to specified list items and provides the server with current knowledge metadata.
<sharepoint:meeting-add-meeting> Associates a meeting with the Meeting Workspace site on the specified server running Windows SharePoint Services.
<sharepoint:meeting-add-meeting-from-i-cal> Associates a meeting represented in Internet Calendar (iCal) format with the Meeting Workspace site on the specified server running Windows SharePoint Services.
<sharepoint:meeting-create-workspace> Creates a new Meeting Workspace subsite on the specified server running Windows SharePoint Services.
<sharepoint:meeting-delete-workspace> Deletes the Meeting Workspace site from the specified server running Windows SharePoint Services.
<sharepoint:meeting-get-meeting-workspaces> Lists the Meeting Workspace sites located in the root directory of the specified server running Windows SharePoint Services at the specified site location.
<sharepoint:meeting-get-meetings-information> Lists the languages and templates supported by the specified server running Windows SharePoint Services.
<sharepoint:meeting-remove-meeting> Removes the association between a meeting and a Meeting Workspace site.
<sharepoint:meeting-restore-meeting> Restores and relinks a meeting that was previously removed from a meeting instance.
<sharepoint:meeting-set-attendee-response> Sets the attendee response for a meeting.
<sharepoint:meeting-set-workspace-title> Sets the title of the Meeting Workspace site on the specified server running Windows SharePoint Services.
<sharepoint:meeting-update-meeting> Updates the meeting information on a Meeting Workspace site.
<sharepoint:meeting-update-meeting-from-i-cal> Updates meeting information stored in Internet Calendar (iCal) format.
<sharepoint:people-is-claims-mode> Indicates if it is Claims mode API link: http://msdn.microsoft.com/en-us/library/websvcpeople.people.isclaimsmode(v=office.14).aspx
<sharepoint:people-resolve-principals> Resolves an e-mail address or other form of user identification (ID) into a PrincipalInfo object.
<sharepoint:people-search-principals> Returns an array of PrincipalInfo objects from the SPUserCollection for the Web site.
<sharepoint:permission-add-permission> Modifies site-level permissions for the site group that exists on the site, or adds or modifies permissions to the specified list for the user, site group, or cross-site group that exists on the site.
<sharepoint:permission-add-permission-collection> Modifies site-level permissions for the specified collection of existing site groups, or adds or modifies permissions to the list for the specified collection of existing users, site groups, and cross-site groups.
<sharepoint:permission-get-permission-collection> Returns the collection of permissions for a site or list.
<sharepoint:permission-remove-permission> Removes the specified permission from the list.
<sharepoint:permission-remove-permission-collection> Removes permissions from the list for the specified members.
<sharepoint:permission-update-permission> Modifies site-level permissions for the specified site group, or modifies permissions to the list for the specified user, site group, or cross-site group.
<sharepoint:query> Returns an XML string containing the search results set for the specified query.
<sharepoint:sitedata-enumerate-folder> Returns information about the files and folders within a folder on a SharePoint site.
<sharepoint:sitedata-get-attachments> Returns the URLs for all attachments to a specified item in a SharePoint list.
<sharepoint:sitedata-get-changes> Returns the changes that occurred on a site collection content from one moment in time to another.
<sharepoint:sitedata-get-content> A string representing information about the web application.
<sharepoint:sitedata-get-list> Returns metadata from the specified SharePoint list.
<sharepoint:sitedata-get-list-collection> Returns information about all the lists in the current SharePoint site.
<sharepoint:sitedata-get-list-items> Performs a query against the specified SharePoint list.
<sharepoint:sitedata-get-site> Returns site metadata, information about the subsites in the current site collection, and information about the cross-site groups on the site and about the users who are members of each group.
<sharepoint:sitedata-get-site-and-web> Returns the absolute URL of a subsite and the absolute URL of its top-level parent site based on the specified site URL.
<sharepoint:sitedata-get-site-url> Returns the GUID and URL of the site collection to which the specified URL belongs.
<sharepoint:sitedata-get-url-segments> A string representing the identifiers of a site, list or list item depending on the specified URL.
<sharepoint:sitedata-get-web> Returns site and list metadata, as well as information about the users and site groups for the current SharePoint site.
<sharepoint:sites-create-web> Create Web API link: http://msdn.microsoft.com/en-us/library/ee658286(v=office.14).aspx
<sharepoint:sites-delete-web> Delete web API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.deleteweb(v=office.14).aspx
<sharepoint:sites-export-solution> Export Solution API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.exportsolution(v=office.14).aspx
<sharepoint:sites-export-web> Exports a Web site.
<sharepoint:sites-get-site> Get Site API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getsite(v=office.14).aspx
<sharepoint:sites-get-site-templates> Returns information about the collection of site definitions and sites templates in the Web application.
<sharepoint:sites-get-updated-form-digest> Get Updated From Digest API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getupdatedformdigest(v=office.14).aspx
<sharepoint:sites-get-updated-form-digest-information> Get Updated Form Digest Information API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getupdatedformdigest(v=office.14).aspx
<sharepoint:sites-import-web> Import web API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.importweb(v=office.14).aspx
<sharepoint:versions-delete-all-versions> Deletes all versions of the specified file.
<sharepoint:versions-delete-version> Deletes the specified file version.
<sharepoint:versions-delete-view> Deletes the specified view of the specified list.
<sharepoint:versions-get-versions> Returns information about the versions of the specified file.
<sharepoint:versions-restore-version> Restores the specified file version.
<sharepoint:views-add-view> Creates a view for the specified list.
<sharepoint:views-get-view> Returns the schema of the specified view for the specified list.
<sharepoint:views-get-view-collection> Returns the display names, internal names, and URLs for the collection of views of the specified list.
<sharepoint:views-get-view-html> Returns the full schema of the specified view for the specified list, including the HTML sections.
<sharepoint:views-update-view> Modifies the specified view of the specified list.
<sharepoint:views-update-view-html> Updates the specified view with the supplied properties and values, including the display properties of Introduction to Collaborative Application Markup Language (CAML) and HTML.
<sharepoint:views-update-view-html2> Updates the specified view with the supplied properties and values, including the display properties of Introduction to Collaborative Application Markup Language (CAML) and HTML.
<sharepoint:webpart-add-web-part> Adds a new Web Part to a Web Part Page.
<sharepoint:webpart-add-web-part-to-zone> Add Web Part To Zone API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.addwebparttozone(v=office.14).aspx
<sharepoint:webpart-associate-workflow-markup> Creates a new SPWorkflowAssociation object list applied in the /WorkflowConfig/Association/@ListID attribute in the associated configuration file.
<sharepoint:webpart-convert-web-part-format> Convert Web Part Format API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.convertwebpartformat(v=office.14).aspx
<sharepoint:webpart-delete-web-part> Deletes a dynamic Web Part from a Web Part Page.
<sharepoint:webpart-execute-proxy-updates> Execute Proxy Updates API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.executeproxyupdates(v=office.14).aspx
<sharepoint:webpart-fetch-legal-workflow-actions> Returns a string version of the actions file, as defined by the Actions File Schema API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.fetchlegalworkflowactions(v=office.14).aspx
<sharepoint:webpart-get-assembly-meta-data> Get Assembly Metadata API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getassemblymetadata(v=office.14).aspx
<sharepoint:webpart-get-binding-resource-data> Get Binding Resource Data API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getbindingresourcedata(v=office.14).aspx
<sharepoint:webpart-get-custom-control-list> Get Custom Control List API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getcustomcontrollist(v=office.14).aspx
<sharepoint:webpart-get-data-from-data-source-control> Get Data From Data Source Control API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getdatafromdatasourcecontrol(v=office.14).aspx
<sharepoint:webpart-get-expanded-list-view-xml> Get Expanded List View Xml API link: http://msdn.microsoft.com/en-us/library/ee658354(v=office.14).aspx
<sharepoint:webpart-get-form-capability-from-data-source-control> Get Form Capability From Data Source Control API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getformcapabilityfromdatasourcecontrol(v=office.14).aspx
<sharepoint:webpart-get-safe-assembly-info> Get Safe Assembly Info API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getsafeassemblyinfo(v=office.14).aspx
<sharepoint:webpart-get-web-part> Returns the XML data for a dynamic Web Part.
<sharepoint:webpart-get-web-part2> Returns the XML data for a dynamic Web Part.
<sharepoint:webpart-get-web-part-cross-page-compatibility> Returns connection information for all parts on the target page and compatibility information of the source Web Part with all the parts on a target page, which is used to determine whether Web Parts on two different pages are compatible with each other.
<sharepoint:webpart-get-web-part-page> Get Web Part Page API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartpage(v=office.14).aspx
<sharepoint:webpart-get-web-part-page-connection-info> Returns connection information for all parts on the same page as well as compatibility results for the provider part with other parts on the same page.
<sharepoint:webpart-get-web-part-page-document> Returns the Web Part Page, complete with the Web Parts and the properties included within each Web Part zone.
<sharepoint:webpart-get-web-part-properties> Returns an XML string of all Web Parts associated with a Web Part Page.
<sharepoint:webpart-get-web-part-properties2> Returns an XML string of all Web Parts associated with a Web Part Page.
<sharepoint:webpart-get-xml-data-from-data-source> Returns XML data from the data source provider.
<sharepoint:webpart-remove-workflow-association> Removes all SPWorkflowAssociation objects on the list defined by the /WorkflowConfig/Association/@ListID value in the configuration file.
<sharepoint:webpart-render-web-part-for-edit> Returns an XML fragment that includes the Web Part property information and the rendering HTML.
<sharepoint:webpart-save-web-part> Saves changes to an existing dynamic Web Part.
<sharepoint:webpart-save-web-part2> Saves changes to an existing dynamic Web Part, including a change to the Web Part type.
<sharepoint:webpart-validate-workflow-markup-and-create-support-objects> Creates a workflow task list, if one is not specified, or if the specified task list does not exist in the context Web site; also updates content types on the task list.
<sharepoint:webs-create-content-type> Creates a new site content type, with the specified columns and properties, on the site.
<sharepoint:webs-customize-css> Applies style sheet customization to a particular file.
<sharepoint:webs-delete-content-type> Deletes the specified site content type from the site.
<sharepoint:webs-get-activated-features> Returns a list of Features that are activated in the Web site and in its parent site collection.
<sharepoint:webs-get-all-sub-web-collection> Returns the titles and URLs of all sites within the current site collection.
<sharepoint:webs-get-columns> Returns a collection of the column definitions for the columns available on the site.
<sharepoint:webs-get-content-type> Returns the content type definition for the specified site content type.
<sharepoint:webs-get-content-types> Returns a collection of content type definitions for all site content types on the specified site.
<sharepoint:webs-get-customized-page-status> Gets the customization (also known as "ghosted") status of the file with the specified URL.
<sharepoint:webs-get-list-templates> Returns the collection of list template definitions for the current site.
<sharepoint:webs-get-object-id-from-url> Get Object Id From Url API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getobjectidfromurl(v=office.14).aspx
<sharepoint:webs-get-web> Returns properties of a site (for example, name, description, and theme).
<sharepoint:webs-get-web-collection> Returns the titles and URLs of all sites directly beneath the current site.
<sharepoint:webs-remove-content-type-xml-document> Removes the specified XmlDocument Element (ContentType) element from the specified site content type.
<sharepoint:webs-revert-all-file-content-streams> Reverts the content streams of all files within the Web site.
<sharepoint:webs-revert-css> Reverts style sheet customization of a file to the default style sheet.
<sharepoint:webs-revert-file-content-stream> Reverts the content stream of the file with the specified URL.
<sharepoint:webs-update-columns> Creates, updates, or deletes one or more columns on the specified site.
<sharepoint:webs-update-content-type> Updates the specified site content type.
<sharepoint:webs-update-content-type-xml-document> Adds or overwrites the specified XmlDocument Element (ContentType) element in the site content type.
<sharepoint:webs-web-url-from-page-url> Returns the URL of the parent site for the specified page URL.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:sharepoint="http://www.mulesoft.org/schema/mule/sharepoint"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/sharepoint
               http://www.mulesoft.org/schema/mule/sharepoint/current/mule-sharepoint.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <sharepoint:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
username		Username	String	/	UTF-8
password		Password	String	/	UTF-8
serverUrl		Server url	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <sharepoint:config>
         <reconnect count="5" frequency="1000"/>
    </sharepoint:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<sharepoint:alert-delete-alerts>

Deletes the specified alerts within a Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcalerts.alerts.deletealerts(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
iDs	#[payload]	Optional. A string array that contains the GUIDs of alerts to delete.	AlertArrayOfString	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
ArrayOfDeleteFailure	A DeleteFailure array that contains the alert ID and error status of unsuccessful deletions.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:alert-get-alerts>

Returns information about the alerts within a Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcalerts.alerts.getalerts(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
AlertInfo	An AlertInfo structure whose fields contain information about each alert, as well as the URL of the page for managing alerts on the site, the name of the server, the type of site definition used to create the site (for example, STS), the URL of the site, the GUID identifying the site, the title of the site, the display name of the current user, and the URL of the page used for choosing a list or document library when creating an alert through the My Alerts on this Site page.

Return Type

Description

AlertInfo

An AlertInfo structure whose fields contain information about each alert, as well as the URL of the page for managing alerts on the site, the name of the server, the type of site definition used to create the site (for example, STS), the URL of the site, the GUID identifying the site, the title of the site, the display name of the current user, and the URL of the page used for choosing a list or document library when creating an alert through the My Alerts on this Site page.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:auth-login>

Used in a forms-based authentication system to either set an authentication cookie or, if there is a problem with the logon, return an error code.

API link: http://msdn.microsoft.com/en-us/library/websvcauthentication.authentication.login(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
user	The user's logon name for the SharePoint site.	String	/	UTF-8
pass	The user's password.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
LoginResult	A LoginResult structure that contains either an error code in its ErrorCode field or the name of an authentication cookie in its CookieName property.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:auth-mode>

Returns the authentication mode for the current SharePoint site.

API link: http://msdn.microsoft.com/en-us/library/websvcauthentication.authentication.mode(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
AuthenticationMode	An @{link AuthenticationMode} that identifies the user authentication system that is being used by the current SharePoint site.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:copy-copy-into-items>

Copies a document represented by a Byte array to one or more locations on a server.

API link: http://msdn.microsoft.com/en-us/library/websvccopy.copy.copyintoitems(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
sourceUrl	A String that contains the absolute source URL of the document to be copied.	String	/	UTF-8
destinationUrls	An array of Strings that contain one or more absolute URLs specifying the destination location or locations of the copied document.	DestinationUrlCollection	/
fields	An array of FieldInformation objects that define and optionally assign values to one or more fields associated with the copied document.	FieldInformationCollection	/
stream	An array of Bytes that contain the document to copy using base-64 encoding.	ByteArrayOutputStream	/
copyIntoItemsResult	A UInt32 that returns 0 to indicate that the operation has completed.	Holder<Long>	/
results	An array of CopyResult objects, passed as an out parameter.	Holder<CopyResultCollection>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:copy-copy-into-items-local>

Copies a document from one location on a server running Microsoft SharePoint Foundation to another location on the same server.

API link: http://msdn.microsoft.com/en-us/library/websvccopy.copy.copyintoitemslocal(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
sourceUrl	A String that contains the absolute source URL of the document to be copied.	String	/	UTF-8
destinationUrls	An array of Strings that contain one or more absolute URLs specifying the destination location or locations of the copied document.	DestinationUrlCollection	/
copyIntoItemsLocalResult	A UInt32 that returns 0 to indicate that the operation has completed.	Holder<Long>	/
results	An array of CopyResult objects, passed as an out parameter.	Holder<CopyResultCollection>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:copy-get-item>

Generates a Byte array representation of a document that can be passed to the CopyIntoItems method to copy the document to a different server.

API link: http://msdn.microsoft.com/en-us/library/websvccopy.copy.getitem(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
url	A String that contains the absolute source (on the server to which the SOAP request is sent) of the document that is to be retrieved.	String	/	UTF-8
getItemResult	A UInt32 that returns 0 to indicate that the operation has completed.	Holder<Long>	/
fields	An array of FieldInformation objects, passed as an out parameter, that represent the fields and the corresponding field values that can be copied from the retrieved document.	Holder<FieldInformationCollection>	/
stream	An array of Bytes, passed as an out parameter, that is a base-64 representation of the retrieved document's binary data.	Holder<byte[]>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-can-create-dws-url>

Determines whether the user has sufficient rights to create a Document Workspace site with the proposed URL on the server.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.cancreatedwsurl(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
url	#[payload]	Optional. The proposed URL for the new Document Workspace site.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that returns the URL in the format proposed URL when successful.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-create-dws>

Creates a Document Workspace site and optionally adds users to the new SharePoint site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.createdws(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
documentUrl	The optional URL of the new Document Workspace site. If an empty string is passed, the URL of the new SharePoint site is based on the title, with illegal characters removed or replaced with underscores and with (n) appended if needed to make the URL unique.	String	/	UTF-8
users	An optional list of users to add to the new SharePoint site, in the following format: `<UserInfo><item Email="{email address of user`" Name="{display name of user}"/> }	String	/	UTF-8
title	The title of the new Document Workspace site.	String	/	UTF-8
documents	An optional list of documents for Microsoft Windows SharePoint Services to retain for subsequent calls to the FindDwsDoc method. Used by Microsoft Office Outlook when adding shared attachments to a new Document Workspace site. This list is returned in the following format: `<Documents><item ID="{document ID`" Name="{document name}"/> }	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The string that the CreateDws method returns results in the following format when successful. `<Results> <Url>{url of the Document Workspace site` {url of the document library in the Document Workspace site} {title of the Document Workspace site ... }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-create-folder>

Creates a subfolder in the document library of the current Document Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.createfolder(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
url	#[payload]	Optional. The proposed site-based URL of the folder to create; for example, "Shared Documents/folder_name".	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that returns an empty tag when successful.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-delete-dws>

Deletes the current Document Workspace site and its contents.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.deletedws(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that returns an empty tag when successful.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-delete-folder>

Deletes a subfolder from a document library of the current Document Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.deletefolder(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
url	#[payload]	Optional. The site-based URL of the folder to delete; for example, "Shared Documents/folder_name."	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that returns an empty tag when successful.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-find-dws-doc>

Returns the absolute URL of a document listed in the documents parameter of a previous call to the CreateDws method.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.finddwsdoc(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
id	#[payload]	Optional. The globally unique identifier (GUID) used to identify the document. This GUID is stored as a part of the _SharedFileIndex custom property for the document.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that returns the absolute URL of the document in the format document url when successful.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-get-dws-data>

Returns information about a Document Workspace site and the lists it contains.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.getdwsdata(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
document	The site-based URL of a document in a document library in the Document Workspace site; for example, "Shared Documents/document_name.doc." This argument provides context for the Documents list returned by the GetDwsData method.	String	/	UTF-8
lastUpdate	The LastUpdate value returned in the results of a previous call to the GetDwsData or GetDwsMetadata method, or an empty string. If a list in the Document Workspace site has not changed since lastUpdate, the GetDwsData method returns "no changes" in place of list data for performance reasons.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that is an XML document fragment that contains the following information: Title LastUpdate User Members Assignees Lists (Tasks, Documents, Links)

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-get-dws-meta-data>

Returns information about a Document Workspace site and the lists it contains.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.getdwsmetadata(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
document	The site-based URL of a document in a document library in the Document Workspace site; for example, "Shared Documents/document_name.doc." This argument provides context for the document information returned by the GetDwsMetaData method.	String	/	UTF-8
id	An optional document globally unique identifier (GUID). The id argument is used by Microsoft Office Outlook to retrieve the full document URL when a user opens a shared attachment.	String	/	UTF-8
minimal	Determines whether the output includes information about the schemas, lists, documents, links, and tasks lists of a Document Workspace site.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that is an XML document fragment that contains the following information: SubscribeUrl MtgInstance (meeting instance, if applicable) SettingsUrl (site settings URL) PermsUrl (edit permissions url) UserInfoUrl (user information url) Roles [Schema items] (if Minimal is FALSE) [ListInfo items] (if Minimal is FALSE) Permissions HasUniquePerm (true/false) WorkspaceType ("DWS", "MWS", "SPS", "") IsADMode (true/false) DocUrl Minimal (true/false) Results (data returned by the GetDwsData method)

Return Type

Description

String

A string that is an XML document fragment that contains the following information:

SubscribeUrl
MtgInstance (meeting instance, if applicable)
SettingsUrl (site settings URL)
PermsUrl (edit permissions url)
UserInfoUrl (user information url)
Roles
[Schema items] (if Minimal is FALSE)
[ListInfo items] (if Minimal is FALSE)
Permissions
HasUniquePerm (true/false)
WorkspaceType ("DWS", "MWS", "SPS", "")
IsADMode (true/false)
DocUrl
Minimal (true/false)
Results (data returned by the GetDwsData method)

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-remove-dws-user>

Removes the specified user from the list of users for the current Document Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.removedwsuser(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
id	#[payload]	Optional. The ID of the user to remove from the list of users.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that returns an empty tag when successful.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-rename-dws>

Changes the title of the current Document Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.renamedws(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
title	#[payload]	Optional. The new title for the Document Workspace site.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that returns an empty tag when successful.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:dws-update-dws-data>

Performs a batch update of items and data for the Document Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcdws.dws.updatedwsdata(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
updates	The list of item updates, in Collaborative Application Markup Language (CAML) batch update format. For example, use the following batch update to save a new task in the task list of the Document Workspace site. `<?xml version="1.0" encoding="UTF-8"?> <ows:Batch OnError="Continue" xmlns:ows="http://tempuri.org/"> <SetVar Name="DatesInGregorian">TRUE</SetVar> <SetVar Name="TimesInUTC">TRUE</SetVar> <Method ID="New"> <SetList Scope="Request">{EA448C91-16D4-411E-AC42-7BA092641E60` Save New Test 1 Not Started (2) Normal 2003-02-11T16:00:00Z <div>This is the description.</div> }	String	/	UTF-8
meetingInstance	Optional instance of a recurring meeting. The meetingInstance parameter applies to the entire batch update and specifies the meeting instance to which the UpdateDwsData method adds new list items.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that returns an empty tag when successful.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:email-change-contacts-membership-in-distribution-group>

Requests the addition and removal of contacts from the specified e-mail distribution group.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.changecontactsmembershipindistributiongroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
alias	The name of the distribution group.	String	/	UTF-8
addListForContacts	The aliases of the contacts that are added to the group.	MailArrayOfString	/
deleteListForContacts	The aliases of the contacts that are removed from the group.	MailArrayOfString	/
deleteAllCurrentMembers	A value indicating whether all members are removed from the group before the contacts in AddListForContacts are added.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RequestStatus	A `RequestStatus` value that reports the outcome of the operation.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:email-change-users-membership-in-distribution-group>

Requests the addition and removal of users from the specified e-mail distribution group.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.changeusersmembershipindistributiongroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
alias	The name of the distribution group.	String	/	UTF-8
addNt4NameList	The users that are added to the group.	MailArrayOfString	/
deleteNt4NameList	The users that are removed from the group.	MailArrayOfString	/
deleteAllCurrentMembers	A value indicating whether all members are removed from the group before the users in AddNt4NameList are added.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RequestStatus	A `RequestStatus` value that reports the outcome of the operation.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:email-create-contact>

Requests the creation of a new contact from the specified name and data.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.createcontact(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
alias	The e-mail alias for the contact.	String	/	UTF-8
firstName	The first name of the contact.	String	/	UTF-8
lastName	The last name of the contact.	String	/	UTF-8
forwardingEmail	The e-mail address of the contact.	String	/	UTF-8
flags	A value indicating whether unauthenticated e-mail that is addressed to the contact is deleted by Microsoft Exchange or sent to the contact.	ContactFlags	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RequestStatus	A `RequestStatus` value that reports the outcome of the operation.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:email-create-distribution-group>

Requests the creation of a new e-mail distribution list from the specified data.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.createdistributiongroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
alias	The e-mail alias of the group.	String	/	UTF-8
groupname	The user-friendly name of the group.	String	/	UTF-8
description	A description of the group.	String	/	UTF-8
contactCN	The manager of the group, who is added as a member.	String	/	UTF-8
info	An object containing information about the person who wants to create the group and his or her reasons.	RequestInfo	/
flags	A value indicating whether unauthenticated e-mail that is addressed to the group is deleted by Microsoft Exchange or sent to the group.	DistributionGroupFlags	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RequestResponse	A `RequestResponse` value that provides information about the request.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:email-delete-contact>

Requests the deletion of a contact from the Active Directory container.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.deletecontact(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
alias	#[payload]	Optional. The e-mail alias of the contact that is deleted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RequestStatus	A `RequestStatus` value that reports the outcome of the operation.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:email-delete-distribution-group>

Requests the deletion of an e-mail distribution group.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.deletedistributiongroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
alias	The e-mail alias of the distribution list that	String	/	UTF-8
info	An object containing information about the person who wants to delete the group and his or her reasons.	RequestInfo	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RequestResponse	A `RequestResponse` value that provides information about the request.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:email-get-job-status>

Requests an update on the status of a previous request that had PendingApproval status when it was last checked.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.getjobstatus(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
jobId	The ID returned in the RequestResponse object by the original request.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RequestResponse	A `RequestResponse` value that provides information about the request.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:email-modify-contact>

Requests a change in information about a contact.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.modifycontact(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
oldAlias	The current e-mail alias of the contact.	String	/	UTF-8
newAlias	The e-mail alias that the contact is to have hereafter. It can be the same as OldAlias.	String	/	UTF-8
firstName	The first name of the contact.	String	/	UTF-8
lastName	The last name of the contact.	String	/	UTF-8
forwardingEmail	The e-mail address of the contact.	String	/	UTF-8
flags	A value indicating whether unauthenticated e-mail that is addressed to the contact is deleted by Microsoft Exchange or sent to the contact.	ContactFlags	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RequestStatus	A `RequestStatus` value that reports the outcome of the operation.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:email-modify-distribution-group>

Requests a change in the stored information about an e-mail distribution group.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.modifydistributiongroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
alias	The e-mail alias of the group.	String	/	UTF-8
groupname	The user-friendly name of the group. (This can be the same as the existing value or changed.)	String	/	UTF-8
description	A description of the group. (This can be the same as the existing value or changed.)	String	/	UTF-8
contactCN	The manager of the group. (This can be the same as the existing value or changed.)	String	/	UTF-8
info	An object containing information about the person who wants to change the information about the group and his or her reasons.	RequestInfo	/
flags	A value indicating whether unauthenticated e-mail that is addressed to the group is deleted by Microsoft Exchange or sent to the group. (This can be the same as the existing value or changed.)	DistributionGroupFlags	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RequestResponse	A `RequestResponse` value that provides information about the request.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:email-rename-distribution-group>

Request a change in the alias for an e-mail distribution group.

API link: http://msdn.microsoft.com/en-us/library/websvcsharepointemailws.sharepointemailws.renamedistributiongroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
oldAlias	The current e-mail alias of the group.	String	/	UTF-8
newAlias	The e-mail alias that the group is to have hereafter.	String	/	UTF-8
info	An object containing information about the person who wants to change the alias of the group and his or her reasons.	RequestInfo	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RequestResponse	A `RequestResponse` value that provides information about the request.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:form-get-form>

Returns the schema of a form for a specified list based on the name of the list and the URL of the form.

API link: http://msdn.microsoft.com/en-us/library/websvcforms.forms.getform(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
listName	String that contains the internal name of the list.	String	/	UTF-8
formUrl	String that contains the site-relative URL of the form to retrieve (for example, Lists/List_Name/NewForm.aspx).	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetFormResponse.GetFormResult	An XML fragment in the following form that contains the URL, type, and Web Part zone ID for the form

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:form-get-form-collection>

Returns the URLs and types of the forms for a list.

API link: http://msdn.microsoft.com/en-us/library/websvcforms.forms.getformcollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
listName	#[payload]	Optional. String that contains the internal name of the list.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetFormCollectionResponse.GetFormCollectionResult	An XML fragment in the following form that contains the URL and type for the form

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:get-file-as-stream>

Returns the stream content of the file.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
url	#[payload]	Optional. The absolute url of the file. Example: http://mydomain.subdomain.com/listName/itemName.itemExtension	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
InputStream	the stream content of the file

<sharepoint:group-add-group>

Adds a group to the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addgroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	A string that contains the name of the new group.	String	/	UTF-8
ownerIdentifier	A string that contains the user name (DOMAIN\User_Alias) of the owner for the group.	String	/	UTF-8
ownerType	A string that specifies the type of owner, which can be either user or group.	String	/	UTF-8
defaultUserLoginName	A string that contains the user name (DOMAIN\User_Alias) of the default user for the group.	String	/	UTF-8
description	A string that contains a description of the group.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-add-group-to-role>

Adds the specified group to the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addgrouptorole(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
roleName	A string that contains the name of the role definition.	String	/	UTF-8
groupName	A string that contains the name of the group.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-add-role>

Adds a role definition to the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addrole(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
roleName	A string that contains the name of the role definition.	String	/	UTF-8
description	A string that contains the description for the role definition.	String	/	UTF-8
permissionMask	A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and specifies permissions for the new role definition.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-add-role-def>

Adds a role definition to the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addroledef(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
roleName	A string that contains the name of the role definition.	String	/	UTF-8
description	A string that contains the description for the role definition.	String	/	UTF-8
permissionMask	A 64-bit unsigned integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and specifies permissions for the new role definition	BigInteger	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-add-user-collection-to-group>

Adds the collection of users to the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addusercollectiontogroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	The name of the group to add users to.	String	/	UTF-8
usersInfoXml	Object that contains information about the users in the following form `<Users> <User LoginName="Domain\User1_Alias" Email="User1_E-mail" Name="User1_Display_Name" Notes="Notes"/> <User LoginName="Domain\User2_Alias" Email="User2_E-mail" Name="User2_Display_Name" Notes="Notes"/> </Users>`	AddUserCollectionToGroup.UsersInfoXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-add-user-collection-to-role>

Adds the collection of users to the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addusercollectiontorole(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
roleName	A string that contains the name of the role definition to add users to.	String	/	UTF-8
usersInfoXml	A System.Xml.XmlNode object that contains information about the users to add in the following form: `<Users> <User LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Name="User1_Display_Name" Notes="Notes"/> <User LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Name="User2_Display_Name" Notes="Notes"/> </Users>`	AddUserCollectionToRole.UsersInfoXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-add-user-to-group>

Adds the user to the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addusertogroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	A string that contains the name of the group.	String	/	UTF-8
userName	A string that contains the display name of the user.	String	/	UTF-8
userLoginName	A string that contains the user name (DOMAIN\User_Alias) of the user.	String	/	UTF-8
userEmail	A string that contains the e-mail address of the user.	String	/	UTF-8
userNotes	A string that contains notes for the user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-add-user-to-role>

Adds the user to the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.addusertorole(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
roleName	A string that contains the name of the role definition.	String	/	UTF-8
userName	A string that contains the display name of the user.	String	/	UTF-8
userLoginName	A string that contains the user name (DOMAIN\User_Alias) of the user	String	/	UTF-8
userEmail	A string that contains the e-mail address of the user.	String	/	UTF-8
userNotes	A string that contains notes for the user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-all-user-collection-from-web>

Returns information about the collection of users for the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getallusercollectionfromweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetAllUserCollectionFromWebResponse.GetAllUserCollectionFromWebResult

An XML fragment in the following form

<GetAllUserCollectionFromWeb xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="9" Sid="S-1-5-21-2127521184-1604012920-1887927527-207153" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
    <User ID="10" Sid="S-1-5-21-2127521184-1604012920-1887927527-4270" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
  </Users>
</GetAllUserCollectionFromWeb>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-current-user-info>

Gets the current user info

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getcurrentuserinfo(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetCurrentUserInfoResponse.GetCurrentUserInfoResult	The current user info

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-group-collection>

Returns information about the specified groups in the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getgroupcollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
groupNamesXml	#[payload]	Optional. Object that specifies one or more group names in the following form: `<Groups> <Group GroupName="Group1"/> <Group GroupName="Group2"/> </Groups>`	GetGroupCollection.GroupNamesXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetGroupCollectionResponse.GetGroupCollectionResult

An XML fragment in the following form

<GetGroupCollection xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
<Groups>
<Group ID="3" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser="False" />
<Group ID="15" Name="Group2" Description="Description" OwnerID="12" OwnerIsUser="True" />
</Groups>
</GetGroupCollection>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-group-collection-from-role>

Returns information about the collection of groups assigned to the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getgroupcollectionfromrole(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
roleName	#[payload]	Optional. A string that contains the name of the role definition.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetGroupCollectionFromRoleResponse.GetGroupCollectionFromRoleResult

An XML fragment in the following form

<GetGroupCollectionFromRole xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Groups>
    <Group ID="3" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser="False" />
    <Group ID="15" Name="Group2" Description="Description" OwnerID="12" OwnerIsUser="True" />
    <Group ID="16" Name="Group3" Description="Description" OwnerID="7" OwnerIsUser="False" />
  </Groups>
</GetGroupCollectionFromRole>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-group-collection-from-site>

Removes the specified users from the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeusercollectionfromsite(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetGroupCollectionFromSiteResponse.GetGroupCollectionFromSiteResult	object that contains the user names (DOMAIN\User_Alias) of the users in the following form `<Users> <User LoginName="Domain\User1_Alias"/> <User LoginName="Domain\User2_Alias"/> </Users>`

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-group-collection-from-user>

Returns information about the collection of groups of which the specified user is a member.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getgroupcollectionfromuser(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
userLoginName	#[payload]	Optional. A string that contains the user name (DOMAIN\User_Alias) of the user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetGroupCollectionFromUserResponse.GetGroupCollectionFromUserResult

An XML fragment in the following form

<GetGroupCollectionFromUser xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Groups>
    <Group ID="3" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser="False" />
    <Group ID="15" Name="Group2" Description="Description" OwnerID="12" OwnerIsUser="True" />
    <Group ID="16" Name="Group3" Description="Description" OwnerID="7" OwnerIsUser="False" />
  </Groups>
</GetGroupCollectionFromUser>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-group-collection-from-web>

Returns information about the collection of groups for the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getgroupcollectionfromweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetGroupCollectionFromWebResponse.GetGroupCollectionFromWebResult

An XML fragment in the following form

<GetGroupCollectionFromWeb xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Groups>
    <Group ID="3" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser="False" />
    <Group ID="15" Name="Group2" Description="Description" OwnerID="12" OwnerIsUser="True" />
    <Group ID="16" Name="Group3" Description="Description" OwnerID="7" OwnerIsUser="False" />
  </Groups>
</GetGroupCollectionFromWeb>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-group-info>

Returns information about the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getgroupinfo(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
groupName	#[payload]	Optional. A string that contains the name of the group.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetGroupInfoResponse.GetGroupInfoResult	An XML fragment in the following form `<GetGroupInfo xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/"> <Group ID="3" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser="False" /> </GetGroupInfo>`

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-role-collection>

Returns information about the specified collection of role definitions for the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolecollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
roleNamesXml	#[payload]	Optional. Object that specifies one or more role definition names in the following form `<Roles> <Role RoleName="Site_Group1"/> <Role RoleName="Site_Group2"/> </Roles>`	GetRoleCollection.RoleNamesXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetRoleCollectionResponse.GetRoleCollectionResult

An XML fragment in the following form that can be assigned to a System.Xml.XmlNode object.

<GetRoleCollection xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Roles>
    <Role ID="1073741830" Name="Site_Group1" Description="Description" Type="0" />
    <Role ID="1073741831" Name="Site_Group2" Description="Description" Type="0" />
  </Roles>
</GetRoleCollection>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-role-collection-from-group>

Returns information about the collection of role definitions of which the specified group is a member.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolecollectionfromgroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
groupName	#[payload]	Optional. A string that contains the name of the group.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetRoleCollectionFromGroupResponse.GetRoleCollectionFromGroupResult

An XML fragment in the following form

<GetRoleCollectionFromGroup xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Roles>
    <Role ID="1073741830" Name="Site_Group1" Description="Description" Type="0" />
    <Role ID="1073741833" Name="Site_Group2" Description="Description" Type="0" />
 </Roles>
</GetRoleCollectionFromGroup>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-role-collection-from-user>

Retrieves information about the collection of role definitions in which the specified user is a member.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolecollectionfromuser(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
userLoginName	#[payload]	Optional. A string that contains the user name (DOMAIN\User_Alias) of the user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetRoleCollectionFromUserResponse.GetRoleCollectionFromUserResult	Returns an XML fragment that provides information about the specified collection of role definitions.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-role-collection-from-web>

Returns information about the collection of groups for the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolecollectionfromweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetRoleCollectionFromWebResponse.GetRoleCollectionFromWebResult

An XML fragment in the following form

<GetRoleCollectionFromWeb xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Roles>
    <Role ID="1073741825" Name="Guest" Description="Can view specific lists or document libraries when given permissions." Type="1" />
    <Role ID="1073741826" Name="Reader" Description="Has read-only access to the Web site." Type="2" />
    <Role ID="1073741827" Name="Contributor" Description="Can add content to existing document libraries and lists." Type="3" />
    <Role ID="1073741828" Name="Web Designer" Description="Can create lists and document libraries and customize pages in the Web site." Type="4" />
    <Role ID="1073741829" Name="Administrator" Description="Has full  control of the Web site." Type="5" />
    <Role ID="3" Name="Group6" Description="Description" OwnerID="1" OwnerIsUser="False" />
    <Role ID="15" Name="Group7" Description="Description" OwnerID="12" OwnerIsUser="True" />
    <Role ID="16" Name="Group8" Description="Description" OwnerID="7" OwnerIsUser="False" />
  </Roles>
</GetRoleCollectionFromWeb>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-role-info>

Returns information about the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getroleinfo(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
roleName	#[payload]	Optional. A string that contains the name of the role definition.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetRoleInfoResponse.GetRoleInfoResult	An XML fragment in the following form `<GetRoleInfo xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/"> <Role ID="1073741830" Name="Role_Definition" Description="Description" Type="0" /> </GetRoleInfo>`

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-roles-and-permissions-for-current-user>

Retrieves permissions and role definitions for the current user. API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolesandpermissionsforcurrentuser(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetRolesAndPermissionsForCurrentUserResponse.GetRolesAndPermissionsForCurrentUserResult	Returns an XML fragment that provides permissions and role definition information for the current user.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-roles-and-permissions-for-site>

Retrieves permissions and role definitions for the specified Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getrolesandpermissionsforsite(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetRolesAndPermissionsForSiteResponse.GetRolesAndPermissionsForSiteResult	Returns an XML fragment that provides permissions and role definition information for the specified Web site.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-user-collection>

Returns information about a collection of users based on the specified user names.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getusercollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
userLoginNamesXml	#[payload]	Optional. Object that contains information about the users in the following form `<Users> <User LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Name="User1_Display_Name" Notes="Notes"/> <User LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Name="User2_Display_Name" Notes="Notes"/> </Users>`	GetUserCollection.UserLoginNamesXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetUserCollectionResponse.GetUserCollectionResult

An XML fragment in the following form

<GetUserCollection xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
    <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
  </Users>
</GetUserCollection>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-user-collection-from-group>

Returns information about the collection of users in the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getusercollectionfromgroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
groupName	#[payload]	Optional. A string that contains the name of the cross-site group.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetUserCollectionFromGroupResponse.GetUserCollectionFromGroupResult

An XML fragment in the following form

<GetUserCollectionFromGroup xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
    <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
  </Users>
</GetUserCollectionFromGroup>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-user-collection-from-role>

Returns information about the collection of users assigned to the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getusercollectionfromrole(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
roleName	#[payload]	Optional. A string that contains the name of the role definition.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetUserCollectionFromRoleResponse.GetUserCollectionFromRoleResult

An XML fragment in the following form

<GetUserCollectionFromRole xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
   <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
  </Users>
</GetUserCollectionFromRole>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-user-collection-from-site>

Returns information about the collection of users for the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getusercollectionfromsite(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetUserCollectionFromSiteResponse.GetUserCollectionFromSiteResult

An XML fragment in the following form

 <GetUserCollectionFromSite xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
    <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
   </Users>
</GetUserCollectionFromSite>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-user-collection-from-web>

Returns information about the collection of users for the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getusercollectionfromweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetUserCollectionFromWebResponse.GetUserCollectionFromWebResult

An XML fragment in the following form

<GetUserCollectionFromWeb xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <Users>
    <User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
    <User ID="5" Sid="S-1-5-21-2127521184-1604012920-1887927527-354403" Name="User2_Display_Name" LoginName="DOMAIN\User2_Alias" Email="User2_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
  </Users>
</GetUserCollectionFromWeb>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-user-info>

Returns information about the specified user.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getuserinfo(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
userLoginName	#[payload]	Optional. A string that contains the user name (DOMAIN\User_Alias) of the user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetUserInfoResponse.GetUserInfoResult

An XML fragment in the following form

<GetUserInfo xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
<User ID="4" Sid="S-1-5-21-2127521184-1604012920-1887927527-34577" Name="User1_Display_Name" LoginName="DOMAIN\User1_Alias" Email="User1_E-mail" Notes="Notes" IsSiteAdmin="False" IsDomainGroup="False" />
</GetUserInfo>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-get-user-login-from-email>

Returns a user name based on the specified e-mail address.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.getuserloginfromemail(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
emailXml	#[payload]	Optional. Object that specifies the e-mail address of the user.	GetUserLoginFromEmail.EmailXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetUserLoginFromEmailResponse.GetUserLoginFromEmailResult

An XML fragment in the following form that specifies the user name (DOMAIN\User_Alias) and other information in the following form

<GetUserLoginFromEmail xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/">
  <User Login="DOMAIN\User1_Alias" Email="User1_Email" DisplayName="User1_Display" SiteUser="0"></User>
  <User Login="DOMAIN\User2_Alias" Email="User2_Email" DisplayName="User2_Display" SiteUser="1"></User>
</GetUserLoginFromEmail>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-remove-group>

Removes the specified group from the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removegroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
groupName	#[payload]	Optional. A string that contains the name of the group.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-remove-group-from-role>

Removes the specified group from the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removegroupfromrole(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
roleName	A string that contains the name of the role definition.	String	/	UTF-8
groupName	A string that contains the name of the group.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-remove-role>

Removes the specified role definition from the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removerole(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
roleName	#[payload]	Optional. A string that contains the name of the role definition.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-remove-user-collection-from-group>

Removes the users with the specified user names from the group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeusercollectionfromgroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	A string that contains the name of the group.	String	/	UTF-8
userLoginNamesXml	Object that contains the user names (DOMAIN\User_Alias) of the users in the following form	RemoveUserCollectionFromGroup.UserLoginNamesXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-remove-user-collection-from-role>

Removes the users with the specified user names from the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeusercollectionfromrole(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
roleName	A string that contains the name of the role definition.	String	/	UTF-8
userLoginNamesXml	Object that contains the user names (DOMAIN\User_Alias) of the users in the following form `<Users> <User LoginName="Domain\User1_Alias"/> <User LoginName="Domain\User2_Alias"/> </Users>`	RemoveUserCollectionFromRole.UserLoginNamesXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-remove-user-collection-from-site>

Removes the specified users from the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeusercollectionfromsite(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
userLoginNamesXml	#[payload]	Optional. A System.Xml.XmlNode object that contains the user names (DOMAIN\User_Alias) of the users in the following form: `<Users> <User LoginName="Domain\User1_Alias"> <User LoginName="Domain\User2_Alias"> </Users>`	RemoveUserCollectionFromSite.UserLoginNamesXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-remove-user-from-group>

Removes the specified user from the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeuserfromgroup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	A string that contains the name of the group.	String	/	UTF-8
userLoginName	A string that contains the user name (DOMAIN\User_Alias) of the user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-remove-user-from-role>

Removes the specified user from the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeuserfromrole(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
roleName	A string that contains the name of the role definition.	String	/	UTF-8
userLoginName	A string that contains the user name (DOMAIN\User_Alias) of the user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-remove-user-from-site>

Removes the specified user from the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeuserfromsite(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
userLoginName	#[payload]	Optional. A string that contains the user name (DOMAIN\User_Alias) of the user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-remove-user-from-web>

Removes the specified user from the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.removeuserfromweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
userLoginName	#[payload]	Optional. String that contains the user name (DOMAIN\User_Alias) of the user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-update-group-info>

Updates information for the specified group.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.updategroupinfo(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
oldGroupName	A string that contains the old name of the group.	String	/	UTF-8
groupName	A string that contains the new name of the group.	String	/	UTF-8
ownerIdentifier	A string that contains the user name (DOMAIN\User_Alias) for the owner of the group.	String	/	UTF-8
ownerType	A string that specifies the type of owner, which can be either user or group.	String	/	UTF-8
description	A string that contains the description for the group.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-update-role-def-info>

Updates information for the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.updateroledefinfo(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
oldRoleName	A string that contains the old name of the role definition.	String	/	UTF-8
roleName	A string that contains the name of the role definition.	String	/	UTF-8
description	A string that contains the description for the role definition.	String	/	UTF-8
permissionMask	A 64-bit unsigned integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and specifies permissions for the new role definition.	BigInteger	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-update-role-info>

Updates information for the specified role definition.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.updateroleinfo(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
oldRoleName	A string that contains the old name of the role definition.	String	/	UTF-8
roleName	A string that contains the new name of the role definition.	String	/	UTF-8
description	A string that contains a description of the role definition.	String	/	UTF-8
permissionMask	A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and specifies new permissions for the site group	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:group-update-user-info>

Updates information for the specified user.

API link: http://msdn.microsoft.com/en-us/library/websvcusergroup.usergroup.updateuserinfo(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
userLoginName	A string that specifies the user name (DOMAIN\User_Alias) of the user whose information is updated.	String	/	UTF-8
userName	A string that contains the display name of the user.	String	/	UTF-8
userEmail	A string that contains the e-mail address of the user.	String	/	UTF-8
userNotes	A string that contains notes for the user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:imaging-check-subweb-and-list>

Checks the specified URL and attempts to resolve it.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.checksubwebandlist(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
strUrl	#[payload]	Optional. The URL to analyze.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
CheckSubwebAndListResponse.CheckSubwebAndListResult	A Microsoft.SharePoint.SoapServer.SoapXml object that contains the resolved URL. For example, if the strUrl parameter is http://MyServer/t1/forms/allitems.aspx

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:imaging-create-new-folder>

Creates a new folder with the name "New folder" in the specified list and folder. If a folder named "New folder" already exists in the specified folder, the CreateNewFolder method tries to create "New folder(1)", "New folder(2)", and so on.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.createnewfolder(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	The name of the list within the current site	String	/	UTF-8
strParentFolder	The relative path from the root of the list to the parent folder	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
CreateNewFolderResponse.CreateNewFolderResult	A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:imaging-delete>

Removes the specified files and folders (items) from the specified list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.delete(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	The name of the list in the current site.	String	/	UTF-8
strFolder	The relative path from the root of the list to the target folder.	String	/	UTF-8
itemFileNames	An array of the name of files and folders (items) to be deleted from the list.	ImagingArrayOfString	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
DeleteResponse.DeleteResult	A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. . . .

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:imaging-download>

Downloads the specified files (items) in a list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.download(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	The name of the list within the current Web site.	String	/	UTF-8
strFolder	The relative path from the root of the list to the target folder.	String	/	UTF-8
itemFileNames	An array of the names of files (items) to download.	ImagingArrayOfString	/
fileType	The version of the files to download. Valid values: 0 for original, 1 for thumbnail, 2 for Web image.	Long	/
fFetchOriginalIfNotAvailable	If this parameter is set to true and the requested version is not available for any reason, the original version is fetched.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

DownloadResponse.DownloadResult A System.Xml.XmlDocument object that contains the following. <Files xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"> <File name="itemFileNames[0]" found="false"/> <File name="itemFileNames[1]" lastmodified="…"> Base64 encoded bytes of the file content </File> <File name="itemFileNames[2]" lastmodified="…" originalDownloaded="true"> Base64 encoded bytes of the file content </File> . . . </Files>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:imaging-get-items-by-ids>

Returns the items with the specified IDs.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.getitemsbyids(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	The name of the list on the current Web site.	String	/	UTF-8
ids	The IDs of the items to return.	ArrayOfUnsignedInt	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetItemsByIdsResponse.GetItemsByIdsResult A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. <Library name="strListName " xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"> <z:row xmlns:z="#RowsetSchema" ows_ID="1" ows_Created="2002-05-02 19:41:36" ows_Author="1;#User_Alias" ows_Modified="2002-05-02 19:41:36" ows_Editor="1;#User_Alias" ows__ModerationStatus="0" ows_FileRef="1;#t1/55VGXIE6.jpg" ows_Last_x0020_Modified="1;#2002-05-02 19:41:36" ows_Created_x0020_Date="1;#2002-05-02 19:41:36" ows_File_x0020_Size="1;#30917" ows_FSObjType="1;#0" ows_CheckoutExpires="1;#" ows_CheckedOutUserId="1;#" ows_FileLeafRef="1;#55VGXIE6.jpg" ows_VirusStatus="1;#30917" ows_CheckedOutTitle="1;#" ows_Modified_x0020_By="DOMAIN\User_Alias" ows_owshiddenversion="0" ows_File_x0020_Type="jpg" ows_LinkFilenameNoMenu="55VGXIE6.jpg" ows_LinkFilename="55VGXIE6.jpg" ows_DocIcon="jpg" ows_ServerUrl="/t1/55VGXIE6.jpg" ows_EncodedAbsUrl="http://Server_Name/t1/55VGXIE6.jpg" ows_BaseName="55VGXIE6" ows_FileSizeDisplay="30917" ows_LinkSharing= "<a href="http://Server_Name/_layouts/1033/ShrOpt.aspx? obj=,document,{5DE3F393-52CF-4644-BA74-FF868C120A05"> ["Has Unique Perms" column value]" ows_ImageWidth="736" ows_ImageHeight="467" ows_ThumbnailUrl="http://Server_Name/t1/_t/55VGXIE6_jpg.jpg" ows_WebImgUrl="http://Server_Name/t1/_w/55VGXIE6_jpg.jpg" ows_NameOrTitle="jpg" ows_SelectedFlag="0" ows_ImageSize="736" ows_RequiredField="t1/55VGXIE6.jpg" /> . . . }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:imaging-get-items-xml-data>

Returns the metadata of all items in the specified list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.getitemsxmldata(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	The name of the list within the current Web site.	String	/	UTF-8
strFolder	The relative path from the root of the list to the target folder.	String	/	UTF-8
itemFileNames	An array of the names of the files (items) for which you need the data.	ImagingArrayOfString	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetItemsXMLDataResponse.GetItemsXMLDataResult	A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. `<results xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"> <result item="filename1" lastmodified="true"/> <result item="filename2" found="false"/> . . . </results>`

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:imaging-get-list-items>

Returns the last modified date and other information about the items in a specified folder in a list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.getlistitems(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	The name of the list within the current Web site.	String	/	UTF-8
strFolder	The relative path from the root of the list to the target folder.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetListItemsResponse.GetListItemsResult A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. <Library name="strListName " xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"> <z:row xmlns:z="#RowsetSchema" ows_ID="1" ows_Created="2002-05-02 19:41:36" ows_Author="1;#User_Alias" ows_Modified="2002-05-02 19:41:36" ows_Editor="1;#User_Alias" ows__ModerationStatus="0" ows_FileRef="1;#t1/55VGXIE6.jpg" ows_Last_x0020_Modified="1;#2002-05-02 19:41:36" ows_Created_x0020_Date="1;#2002-05-02 19:41:36" ows_File_x0020_Size="1;#30917" ows_FSObjType="1;#0" ows_CheckoutExpires="1;#" ows_CheckedOutUserId="1;#" ows_FileLeafRef="1;#55VGXIE6.jpg" ows_VirusStatus="1;#30917" ows_CheckedOutTitle="1;#" ows_Modified_x0020_By="Domain\User_Name" ows_owshiddenversion="0" ows_File_x0020_Type="jpg" ows_LinkFilenameNoMenu="55VGXIE6.jpg" ows_LinkFilename="55VGXIE6.jpg" ows_DocIcon="jpg" ows_ServerUrl="/t1/55VGXIE6.jpg" ows_EncodedAbsUrl="http://Server_Name/t1/55VGXIE6.jpg" ows_BaseName="55VGXIE6" ows_FileSizeDisplay="30917" ows_LinkSharing="<a href= "http://Server_Name/_layouts/1033/ShrOpt.aspx? obj=,document,{5DE3F393-52CF-4644-BA74-FF868C120A05"> ["Has Unique Perms" column value]" ows_ImageWidth="736" ows_ImageHeight="467" ows_ThumbnailUrl="http:/ Server_Name/t1/_t/55VGXIE6_jpg.jpg" ows_WebImgUrl="http://Server_Name/t1/_w/55VGXIE6_jpg.jpg" ows_NameOrTitle="jpg" ows_SelectedFlag="0" ows_ImageSize="736" ows_RequiredField="t1/55VGXIE6.jpg" /> . . . }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:imaging-list-picture-library>

Lists all picture libraries on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.listpicturelibrary(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
ListPictureLibraryResponse.ListPictureLibraryResult	A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. . . .

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:imaging-rename>

Renames the specified files (items) in a list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.rename(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	The name of the list within the current Web site.	String	/	UTF-8
strFolder	The relative path from the root of the list to the target folder.	String	/	UTF-8
request	The files to rename and the new base name. For example, to rename "tree.jpg" to "forest.jpg"	Rename.Request	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RenameResponse.RenameResult	A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following. `<results xmlns="http://schemas.microsoft.com/sharepoint/soap/ois/"> <result name="oldFileName0" renamed="true" newbasename="newBaseName0"/> <result name="oldFileName1ThatDoesNotExist" renamed="false"/> . . . </results>`

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:imaging-upload>

Uploads a file to a list on the current Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcimaging.imaging.upload(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	The name of the list on the current Web site.	String	/	UTF-8
strFolder	The relative path from the root of the list to the target folder.	String	/	UTF-8
bytes	The binary content in the file to upload.	ByteArrayOutputStream	/
fileName	The file name to use as item name in the list.	String	/	UTF-8
fOverWriteIfExist	A Boolean value that indicates whether to overwrite a file with the same name. A FileExists exception is thrown if the item exists and fOverWriteIfExist is not true.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
UploadResponse.UploadResult	A Microsoft.SharePoint.SoapServer.SoapXml object that returns the last modified date of the item if the operation succeeds.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-add-attachment>

Adds an attachment to the specified list item in the specified list.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing attachment information: listName: string that contains either the title or the GUID for the list. listItemId: string that contains the ID of the item to which attachments are added. This value does not correspond to the index of the item within the collection of list items. fileName: string that contains the name of the file to add as an attachment. attachment: byte array that contains the file to attach by using base-64 encoding.	AddAttachment	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that contains the URL for the attachment, which can subsequently be used to reference the attachment.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-add-discussion-board-item>

Adds an item to the specified discussion board on the current Web site.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing discussion board information: listName: string that contains either the title or the GUID for the list. message: The base64Binary content of the item to add.	AddDiscussionBoardItem	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-add-list>

Creates a list in the current site based on the specified name, description, and list template ID.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list information: listName: string that contains the title of the list. description: string that contains a description for the list. templateId: A 32-bit integer that specifies the list template to use. The following table shows possible values for the ID: Announcements: 104 Contacts: 105 Custom List: 100 Custom List in DataSheet view: 120 DataSources: 110 Discussion Board: 108 Document Library: 101 Events: 106 Form Library: 115 Issues: 1100 Links: 103 Picture Library: 109 Survey: 102 Tasks: 107	AddList	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
AddListResponse.AddListResult	The result list

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-add-list-from-feature>

Creates a list in the current site based on the specified name, description, Feature ID, and list template ID.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list information: listName: string that contains the title of the list. description: string that contains a description for the list. featureId: A System.Guid specifying the Feature ID. templateId: A 32-bit integer that specifies the list template to use. The following table shows possible values for the ID: Announcements: 104 Contacts: 105 Custom List: 100 Custom List in DataSheet view: 120 DataSources: 110 Discussion Board: 108 Document Library: 101 Events: 106 Form Library: 115 Issues: 1100 Links: 103 Picture Library: 109 Survey: 102 Tasks: 107	AddListFromFeature	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
AddListFromFeatureResponse.AddListFromFeatureResult	The result list

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-add-wiki-page>

Adds wiki page

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing wiki page information: listName, ListRelPageUrl and wikiContent	AddWikiPage	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
AddWikiPageResponse.AddWikiPageResult	The result list

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-check-out-file>

Allows documents in a SharePoint document library to be checked out remotely.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing check-out file information: pageUrl: A string that contains the full path to the document to be checked out. checkoutToLocal: A string containing "true" or "false" that designates whether the file is to be flagged as checked out for offline editing. lastModified: A string in RFC 1123 date format representing the date and time of the last modification to the file; for example, "20 Jun 1982 12:00:00 GMT".	CheckOutFile	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
boolean	true-false

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-create-content-type>

Creates a list content type on the list.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing content type information: listName: string containing the name of the list on which to create the content type. displayName: string that represents the display name of the list content type. parentType: string that contains the content type ID of the site content type on which to base the list content type. fields: A string representing the collection of columns to include on the new site content type. Format the column collection as a FieldRefs element, where each FieldRef child element represents a reference to an existing column to include on the content type. contentTypeProperties: A string representing the properties to specify for the content type. Format the properties as a ContentType element, and include the element attributes for the properties you want to specify. addToView: string containing "true" or "false" that designates whether to add the content type to the list view.	CreateContentType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	String

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-delete-attachment>

Removes the attachment from the specified list item.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing delete attachment information: listName: string that contains either the title or GUID for the list. listItemId: string that contains the ID of the item to delete. This value does not correspond to the index of the item within the collection of list items. url: string that contains the absolute URL for the attachment, as follows: http://Server_Name/Site_Name/Lists/List_Name/Attachments/Item_ID/FileName.	DeleteAttachment	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-delete-content-type>

Removes the specified list content type from the designated list.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing delete content type information: listName: string that contains the name of the list from which to delete the content type. contentTypeId: string containing the content type ID of the list content type to delete.	DeleteContentType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
DeleteContentTypeResponse.DeleteContentTypeResult	DeleteContentTypeResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-delete-content-type-xml-document>

Removes the specified list content type xml document.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing delete content type xml document information: listName, contentTypeId and documentUri	DeleteContentTypeXmlDocument	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
DeleteContentTypeXmlDocumentResponse.DeleteContentTypeXmlDocumentResult	The result list

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-delete-list>

Deletes the specified list.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing delete list information: listName: string that contains either the title or the GUID for the list.	DeleteList	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-attachment-collection>

Returns a list of the URLs for attachments to the specified item.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing attachment collection request: listName: string that contains either the title or the GUID for the list. listItemId: string that contains the ID for the list item. This value does not correspond to the index of the item within the collection of list items.	GetAttachmentCollection	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetAttachmentCollectionResponse.GetAttachmentCollectionResult	GetAttachmentCollectionResponse.GetAttachmentCollectionResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-list>

Returns a schema for the specified list.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list request: listName: string that contains either the title or the GUID for the list. When querying the UserInfo table, the string contains "UserInfo".	GetList	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
List<Object>	List

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-list-and-view>

Returns the list and view schemas for the specified list

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list and view request: listName: string that contains either the title or the GUID for the list. When querying the UserInfo table, the string contains "UserInfo". viewName: string that contains the GUID for the view. If no value is specified, returns the default view schema for the list.	GetListAndView	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetListAndViewResponse.GetListAndViewResult	GetListAndViewResponse.GetListAndViewResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-list-collection>

Returns the names and GUIDs for all lists in the site.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetListCollectionResponse.GetListCollectionResult	GetListCollectionResponse.GetListCollectionResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-list-content-type>

Returns the content type definition schema for the specified list content type.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list content type request: listName: string representing the name of the list that contains the list content type. contentTypeId: string containing the content type ID of the list content type.	GetListContentType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetListContentTypeResponse.GetListContentTypeResult	GetListContentTypeResponse.GetListContentTypeResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-list-content-types>

Returns a collection of content type definition schemas for all list content types on the given list.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list content types request: listName: string that represents the name of the list on which the content types are located. contentTypeId: string that represents the content type ID of the content type.	GetListContentTypes	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetListContentTypesResponse.GetListContentTypesResult	GetListContentTypesResponse.GetListContentTypesResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-list-content-types-and-properties>

Returns a collection of content types and properties for the given list

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list content type and properties request	GetListContentTypesAndProperties	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetListContentTypesAndPropertiesResponse.GetListContentTypesAndPropertiesResult	GetListContentTypesAndPropertiesResponse.GetListContentTypesAndPropertiesResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-list-item-changes>

Returns changes made to the list since the specified date and time.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing item changes request listName: string that contains either the title or GUID for the list. When querying the UserInfo table, the string contains "UserInfo". viewFields: ViewFields element that specifies which fields to return in the query and in what order. since: string that contains the date and time in Coordinated Universal Time (UTC) ISO8601 format from which to start retrieving changes in the list. The value of this parameter is typically retrieved from a prior SOAP response. If this value is null, the query returns all items in the list. contains: Contains element that defines custom filtering for the query.	GetListItemChanges	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetListItemChangesResponse.GetListItemChangesResult	GetListItemChangesResponse.GetListItemChangesResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-list-item-changes-since-token>

Returns changes made to the list since the date and time specified in the token.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list item changes request listName: string that contains either the title or the GUID for the list. When querying the UserInfo table, the string contains UserInfo. Using the GUID results in better performance. viewName: string that contains the GUID for the view, which determines the view to use for the default view attributes represented by the query, viewFields, and rowLimit parameters. If this argument is not supplied, the default view is assumed. If it is supplied, the value of the query, viewFields, or rowLimit parameter overrides the equivalent setting within the view. For example, if the view specified by the viewFields parameter has a row limit of 100 rows but the rowLimit parameter contains 1000, then 1,000 rows are returned in the response. query: Query element containing the query that determines which records are returned and in what order. viewFields: specifies which fields to return in the query and in what order. If supplied, the value of this parameter overrides the view fields within the view specified by the viewName parameter or the view fields in the default view for the list. If this value is null, the query returns all fields for each item returned. rowLimit: string that specifies the number of items, or rows, to display on a page before paging begins. If supplied, the value of this parameter overrides the row limit set in the view specified by the viewName parameter or the row limit set in the default view for the list. queryOptions: options for the specific query. The doc is available here changeToken: string that contains the change token for the request. For description about its format please check Overview: Change Tokens, Object Types, and Change Types contains: element that defines custom filtering for the query.	GetListItemChangesSinceToken	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetListItemChangesSinceTokenResponse.GetListItemChangesSinceTokenResult	GetListItemChangesSinceTokenResponse.GetListItemChangesSinceTokenResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-list-item-changes-with-knowledge>

Returns all of the list items that meet specified criteria and that have changed since the date-time specified in the knowledge parameter for the specified list.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list item changes with knowledge request listName: The GUID or the list title of the list from which to retrieve list items. If the specified list is the user information list, the string is set to "UserInfo" or "User Information list". viewName: The GUID of the view of the list from which to return list items. If not specified, the default list view is used. viewFields, rowLimit, and queryOptions parameters, if specified, must override corresponding attributes of the view used. Note that clients should not use this parameter. If specified, the server must ignore this parameter if the viewFields parameter is also specified; otherwise, the server must only validate that this parameter is both a valid GUID and that the parameter refers to a view of the list. query: Query to determine which records from the list are to be returned and the order in which they will be returned. viewFields: Specifies which fields of the list item should be returned. If not specified, whether by excluding the parameter or by including a null value, the fields defined for the viewName parameter view are used. If the Properties attribute of the ViewFields structure is set to true and the MetaInfo field is referenced in a FieldRef parameter, then properties related to the list must be returned with the prefix "ows_MetaInfo_". rowLimit: Specifies the maximum number of rows of data to return in the response. If not specified, whether by passing an empty element or by excluding the element, the default row limit for the view specified by the viewName parameter is used. Otherwise, this must be a 32-bit unsigned integer. The server must not return more list items than specified by this parameter. queryOptions: Specifies options that are available to modify the query. syncScope: Specifies the scope of the synchronization. If null, the default sync scope is used with an empty identifier. knowledge: Specifies the Microsoft Sync Framework knowledge data structure in XML format. If not provided by the client, all items in the list are returned, subject to the default row limit of the view or the overriding rowLimit parameter. If specified, the response will include changes made to list items after the knowledge was retrieved, subject to the row limit restrictions. contains: Restricts the results returned by giving a specific value to be searched for in the specified list item field. The server returns only those list items satisfying this criteria.	GetListItemChangesWithKnowledge	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetListItemChangesWithKnowledgeResponse.GetListItemChangesWithKnowledgeResult	GetListItemChangesWithKnowledgeResponse.GetListItemChangesWithKnowledgeResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-list-items>

Returns information about items in the list based on the specified query.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list item changes with knowledge request listName: tring that contains either the display name or the GUID for the list. It is recommended that you use the GUID, which must be surrounded by curly braces ({}). When querying the UserInfo table, the string contains "UserInfo". viewName: string that contains the GUID for the view surrounded by curly braces ({}), which determines the view to use for the default view attributes represented by the query, viewFields, and rowLimit parameters. If this parameter contains an empty string, the default view is used. If the view GUID is supplied, the value of the query, viewFields, or rowLimit parameter overrides the equivalent setting within the view. For example, if the view specified by the viewFields parameter has a row limit of 100 rows but the rowLimit parameter contains 1000, then 1,000 rows are returned in the response. query: element containing the query that determines which records are returned and in what order. If supplied, the value of this parameter overrides either the query within the view specified by the viewName parameter or the query within the default view for the list. viewFields: element that specifies which fields to return in the query and in what order. If supplied, the value of this parameter overrides the view fields within the view specified by the viewName parameter or the view fields in the default view for the list. rowLimit: specifies the number of items, or rows, to display on a page before paging begins. If supplied, the value of this parameter overrides the row limit set in the view specified by the viewName parameter or the row limit set in the default view for the list. queryOptions: options for the specific query. The doc is available here webId: string containing the GUID of the parent Web site for the list surrounded by curly braces ({}). Setting this parameter to null means the Web site specified by the Url property of the service will be used, and if the Url property of the service is not specified, the root Web site will be used.	GetListItems	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetListItemsResponse.GetListItemsResult	GetListItemsResponse.GetListItemsResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-get-version-collection>

Returns version information for the specified field in a SharePoint list.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing version collection request listId: string that contains the ID of the list. listItemId: string that contains the ID of the item. fieldName: string that contains the name of the field.	GetVersionCollection	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetVersionCollectionResponse.GetVersionCollectionResult	GetVersionCollectionResponse.GetVersionCollectionResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-list-check-in-file>

Allows documents to be checked in to a SharePoint document library remotely

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing check-in file information: pageUrl: string that contains the full path to the document to check in. comment: string containing optional check-in comments. checkInType: A string representation of the values 0, 1 or 2, where 0 = MinorCheckIn, 1 = MajorCheckIn, and 2 = OverwriteCheckIn.	CheckInFile	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
boolean	true-false

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-undo-check-out>

Undoes the check-out of a given document in a SharePoint document library.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing undo checkout request pageUrl: string that contains the full path to the document.	UndoCheckOut	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
boolean	boolean

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-update-content-type>

Updates the specified list content type.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing update content type request listName: represents the name of the list on which the list content type resides. contentTypeId: represents the content type ID of the list content type to be updated. contentTypeProperties: represents the properties to update on the list content type. Format the properties as a ContentType element, and include the element attributes for the properties you want to update. newFields: represents the collection of columns to add to the list content type. Format the column collection as a FieldRefs element, where each FieldRef child element references a column to add to the list content type. updateFields: represents the collection of columns to update on the list content type. Format the column collection as a FieldRefs element, where each FieldRef references a column to update on the content type. In each FieldRef child element, include the element attributes for the column properties you want to update. deleteFields: string that represents the collection of columns to delete from the list content type. Format the column collection as a FieldRefs element, where each FieldRef references a column to delete from the content type. In each FieldRef child element, include the ID attributes for the column you want to delete. addToView: represents whether or not to add the content type columns to the list view. Specify true to add the columns to the list view, false to keep the columns hidden.	UpdateContentType	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
UpdateContentTypeResponse.UpdateContentTypeResult	UpdateContentTypeResponse.UpdateContentTypeResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-update-content-type-xml-document>

Adds or overwrites the specified XMLDocument element in the specified list content type.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing update content type xml document request listName: string that represents the name of the list. contentTypeId: string that represents the content type ID of the content type to which to add or update the XMLDocument element. newDocument: string representing the XML document to replace the existing XML document.	UpdateContentTypeXmlDocument	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult	UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-update-content-types-xml-document>

Adds or overwrites the specified XMLDocument element for all content types on the specified list.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing update content types xml document request listName: string that represents the name of the list. newDocument: string representing the XML document to replace the existing XML document.	UpdateContentTypesXmlDocument	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
UpdateContentTypesXmlDocumentResponse.UpdateContentTypesXmlDocumentResult	UpdateContentTypesXmlDocumentResponse.UpdateContentTypesXmlDocumentResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-update-list>

Updates a list based on the specified field definitions and list properties.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list request listName: string that contains the GUID for the list. contentTypeId: to check the values allowed please refer to documentation. newFields: contains Field elements inside method blocks so that the add operations can be tracked individually. To add a new field to a list view through the UpdateList method, use the AddToView attribute of the Method element to specify the GUID of the view. updateFields: contains Field elements inside method blocks so that the update operations can be tracked individually. deleteFields: contains Field elements specifying the names of the fields to delete inside method blocks so that the delete operations can be tracked individually. listVersion: contains the version of the list that is being updated so that conflict detection can be performed.	UpdateList	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
UpdateListResponse.UpdateListResult	UpdateListResponse.UpdateListResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-update-list-items>

Adds, deletes, or updates the specified items in a list on the current site.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list items request listName: string that contains the name of the list. It is recommended that you use the list GUID surrounded by curly braces (i.e., "{GUID}"), but you can also use the list display name. updates: item to be affected. For further information please check documentation.	UpdateListItems	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
UpdateListItemsResponse.UpdateListItemsResult	UpdateListItemsResponse.UpdateListItemsResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:list-update-list-items-with-knowledge>

Makes inserts, updates, and deletions to specified list items and provides the server with current knowledge metadata.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
request	#[payload]	Optional. Object containing list item with knowledge request listName: GUID or the list title of the list from which to retrieve list items. If the specified list is the user information list, the string is set to "UserInfo" or "User Information list". updates: Specifies the operations to perform on a list item.. For further information please check documentation. syncScope: Specifies the scope of the synchronization. If null, the default sync scope is used with an empty identifier. knowledge: Specifies the Microsoft Sync Framework knowledge data structure in XML format. If not provided by the client, all items in the list are returned, subject to the default row limit of the view or the overriding rowLimit parameter. If specified, the response will include changes made to list items after the knowledge was retrieved, subject to the row limit restrictions.	UpdateListItemsWithKnowledge	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
UpdateListItemsWithKnowledgeResponse.UpdateListItemsWithKnowledgeResult	UpdateListItemsWithKnowledgeResponse.UpdateListItemsWithKnowledgeResult

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-add-meeting>

Associates a meeting with the Meeting Workspace site on the specified server running Windows SharePoint Services.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.addmeeting(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
organizerEmail	The e-mail address, specified as email_address@domain.ext, for the meeting organizer.	String	/	UTF-8
uid	A persistent GUID for the calendar component.	String	/	UTF-8
sequence	An integer used to determine the ordering of updates in case they arrive out of sequence. Updates with a lower-than-current sequence are discarded. If the sequence is the same as the current sequence, the latest update will be applied.	long	/
utcDateStamp	The date and time that the instance of the iCalendar object was created.	XMLGregorianCalendar	/
title	The title (subject) of the meeting.	String	/	UTF-8
location	The location of the meeting.	String	/	UTF-8
utcDateStart	The start date and time for the meeting, expressed in UTC.	XMLGregorianCalendar	/
utcDateEnd	The end date and time for the meeting, expressed in Coordinated Universal Time (UTC).	XMLGregorianCalendar	/
nonGregorian	True if the calendar is set to a format other than Gregorian; otherwise, false. Setting this parameter to true puts the following message in the summary data of the meeting workspace: "This meeting was created using a calendar and scheduling program that only supports series updates to the Meeting Workspace. Changes you make to individual occurrences of meetings in that program will not appear in the workspace."	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

AddMeetingResponse.AddMeetingResult A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <AddMeetingResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/meetings/"> <AddMeetingResult> <AddMeeting Url="http://server_name/Test?InstanceID=1" HostTitle="Team Web Site" UniquePermissions="true" MeetingCount="1" AnonymousAccess="false" AllowAuthenticatedUsers="false" /> <AttendeeUpdateStatus Code="12" Detail="Some users could not automatically be granted permissions to the workspace." ManageUserPage="http://spserver1/Test/_layouts/1033/user.aspx" /> </AddMeetingResult> </AddMeetingResponse> </soap:Body></soap:Envelope>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-add-meeting-from-i-cal>

Associates a meeting represented in Internet Calendar (iCal) format with the Meeting Workspace site on the specified server running Windows SharePoint Services.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.addmeetingfromical(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
organizerEmail	The e-mail address, specified as email_address@domain.ext, for the meeting organizer.	String	/	UTF-8
icalText	The iCal representation of the meeting that will be associated with the Meeting Workspace site.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

AddMeetingFromICalResponse.AddMeetingFromICalResult A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <AddMeetingFromICalResponse xmlns= "http://schemas.microsoft.com/sharepoint/soap/meetings/"> <AddMeetingFromICalResult> <AddMeetingFromICal Url= "http://server_name/Test Meeting(2)?InstanceID=1" HostTitle="Team Web Site" UniquePermissions="true" MeetingCount="1" AnonymousAccess="false" AllowAuthenticatedUsers="false" /> </AddMeetingFromICalResult> </AddMeetingFromICalResponse> </soap:Body></soap:Envelope>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-create-workspace>

Creates a new Meeting Workspace subsite on the specified server running Windows SharePoint Services.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.createworkspace(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
title	The title for the Meeting Workspace site that will be created.	String	/	UTF-8
templateName	The name of the template to use when the site is created. See Windows SharePoint Services template naming guidelines for specifying a configuration within a template.	String	/	UTF-8
lcid	The LCID (locale identifier) to use when the site is created.	long	/
timeZoneInformation	The time zone information to use when the site is created.	TimeZoneInf	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

CreateWorkspaceResponse.CreateWorkspaceResult A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <CreateWorkspaceResponse xmlns= "http://schemas.microsoft.com/sharepoint/soap/meetings/"> <CreateWorkspaceResult> <CreateWorkspace Url="http://server_name/test/myworkspace" /> </CreateWorkspaceResult> </CreateWorkspaceResponse> </soap:Body> </soap:Envelope>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-delete-workspace>

Deletes the Meeting Workspace site from the specified server running Windows SharePoint Services.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.deleteworkspace(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-get-meeting-workspaces>

Lists the Meeting Workspace sites located in the root directory of the specified server running Windows SharePoint Services at the specified site location.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.getmeetingworkspaces(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
recurring	#[payload]	Optional. True if the meeting is recurring; otherwise, false.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetMeetingWorkspacesResponse.GetMeetingWorkspacesResult A Microsoft.SharePoint.SoapServer.SoapXml object that contains the Meeting Workspace sites in the root directory of the specified server. For example: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body> <GetMeetingWorkspacesResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/meetings/"> <GetMeetingWorkspacesResult> <MeetingWorkspaces> <Workspace Url="http://server_name/ManagersOnly" Title="ManagersOnly" /> <Workspace Url="http://server_name/ManagersOnly(1)" Title="ManagersOnly" /> <Workspace Url="http://server_name/Testing" Title="Testing" /> <Workspace Url="http://server_name/Marketing" Title="Marketing" /> <Workspace Url="http://server_name/Untitled" Title="Untitled" /> <Workspace Url="http://server_name/Untitled(1)" Title="Untitled" /> <MeetingWorkspaces /> </GetMeetingWorkspacesResult> </GetMeetingWorkspacesResponse> </soap:Body> </soap:Envelope>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-get-meetings-information>

Lists the languages and templates supported by the specified server running Windows SharePoint Services. It also specifies whether the caller has the ManageSubweb right on the Meeting Workspace site and shows other workspace settings, such as Anonymous Access, Unique Permissions, the meeting count, and AllAuthenticatedUsers.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.getmeetingsinformation(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
requestFlags	Can be one or more of the following flags OR-ed together: canCreateMeetings (returns true or false to indicate whether the caller has ManageSubweb rights on the site being posted to) templateLanguages (returns the list of languages for which templates are available) templateList (returns the list of available Meeting Workspace templates available for the specified LCID) workspacestatus (returns information about the workspace) For example, setting this parameter to 1 turns on the first bit, which returns whether you have the permission to create a meeting. Setting the parameter to 2 turns on the second bit, which returns the list of available template languages. Setting it to 3 turns on both the first and second bit and returns both sets of information.	long	/
lcid	The LCID (locale identifier) to which you want to limit the results.	long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetMeetingsInformationResponse.GetMeetingsInformationResult A Microsoft.SharePoint.SoapServer.SoapXml that contains the following: <MeetingsInformation> <AllowCreate>True</AllowCreate> <ListTemplateLanguages><LCID>1033</LCID></ListTemplateLanguages> <ListTemplates> <Template Name="MPS#0" Title="Basic Meeting Workspace" Id="2" Description="All the basics to plan, organize and track your meeting. This Meeting Workspace contains the following lists: Objectives, Attendees and Agenda." ImageUrl="http://sturton2g/_layouts/1033/images/ basic.gif" /> <Template Name="MPS#1" Title="Blank Meeting Workspace" Id="2" Description="A blank Meeting Workspace for you to customize based on your requirements." ImageUrl="http://sturton2g/_layouts/1033/images/ blank.gif" /> <Template Name="MPS#2" Title="Decision Meeting Workspace" Id="2" Description="A Meeting Workspace in which to review relevant documents and record decisions. This Meetings Workspace contains the following lists: Objectives, Attendees, Agenda, Document Libraries, Tasks and Decisions." ImageUrl="http://sturton2g/_layouts/1033/ images/decision.gif" /> <Template Name="MPS#3" Title="Social Meeting Workspace" Id="2" Description="A planning tool for social occasions, featuring a discussion board and a picture library to post pictures of the event. This Meeting Workspace contains the following lists and webparts: Attendees, Directions, Weather, Image/Logo, Things To Bring, Discussions and a Picture Library." ImageUrl="http://sturton2g/_layouts/1033/ images/social.gif" /> <Template Name="MPS#4" Title="Multipage Meeting Workspace" Id="2" Description="All the basics to plan, organize and track your meeting with multiple pages. This Meeting Workspace contains the following lists: Objectives, Attendees and Agenda in addition to two blank pages for you customize based on your requirements." ImageUrl="http://sturton2g/_layouts/1033/images/ training.gif" /> </ListTemplates> <WorkspaceStatus UniquePermissions="true" MeetingCount="0" AnonymousAccess="false" AllowAuthenticatedUsers="false" /> </MeetingsInformation>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-remove-meeting>

Removes the association between a meeting and a Meeting Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.removemeeting(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
recurrenceId	The recurrence ID for the meeting that needs its association removed. This parameter can be set to 0 for single-instance meetings.	long	/
uid	A persistent GUID for the calendar component.	String	/	UTF-8
sequence	An integer that is used to determine the ordering of updates in case they arrive out of sequence. Updates with a lower-than-current sequence are discarded. If the sequence is equal to the current sequence, the latest update are applied.	long	/
utcDateStamp	The date and time that the instance of the iCalendar object was created. This parameter needs to be in the UTC format (for example, 2003-03-04T04:45:22-08:00).	XMLGregorianCalendar	/
cancelMeeting	True to delete a meeting; false to remove its association with a Meeting Workspace site.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-restore-meeting>

Restores and relinks a meeting that was previously removed from a meeting instance.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.restoremeeting(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
uid	#[payload]	Optional. A persistent GUID for the calendar component.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-set-attendee-response>

Sets the attendee response for a meeting.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.setattendeeresponse(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
attendeeEmail	The e-mail address, specified as email_address@domain.ext, for the responding user.	String	/	UTF-8
recurrenceId	The recurrence ID for the meeting. For single instance meetings, this parameter can be set to zero.	long	/
uid	A persistent GUID for the calendar component.	String	/	UTF-8
sequence	An integer used to determine the ordering of updates in case they arrive out of sequence. Updates with a lower-than-current sequence are discarded. If the sequence is equal to the current sequence, the latest update is applied.	long	/
utcDateTimeOrganizerCriticalChange	This parameter is ignored in this release; therefore, this parameter can be a default date time.	XMLGregorianCalendar	/
utcDateTimeAttendeeCriticalChange	The date and time when the instance of the attendee object was created, expressed in Coordinated Universal Time (UTC).	XMLGregorianCalendar	/
response	Optional. The response from the responding user (responseAccepted, responseTentative, or responseDeclined).	AttendeeResponse	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-set-workspace-title>

Sets the title of the Meeting Workspace site on the specified server running Windows SharePoint Services.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.setworkspacetitle(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
title	#[payload]	Optional. The title for the specified Meeting Workspace site. If the title exceeds 255 characters, it is truncated to the first 255 characters.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-update-meeting>

Updates the meeting information on a Meeting Workspace site.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.updatemeeting(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
uid	A persistent GUID for the calendar component.	String	/	UTF-8
sequence	An integer used to determine the ordering of updates in case they arrive out of sequence. Updates with a lower-than-current sequence are discarded.	long	/
utcDateStamp	The date and time that the instance of the iCalendar object was created in UTC format.	XMLGregorianCalendar	/
title	The title (subject) of the meeting.	String	/	UTF-8
location	The location of the meeting.	String	/	UTF-8
utcDateStart	The start date and time for the meeting, expressed in UTC.	XMLGregorianCalendar	/
utcDateEnd	The end date and time for the meeting, expressed in Coordinated Universal Time (UTC).	XMLGregorianCalendar	/
nonGregorian	True if the calendar is set to a format other than Gregorian; otherwise, false. Setting this parameter to true puts the following message in the summary data of the meeting workspace: "This meeting was created using a calendar and scheduling program that only supports series updates to the Meeting Workspace. Changes you make to individual occurrences of meetings in that program will not appear in the workspace."	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:meeting-update-meeting-from-i-cal>

Updates meeting information stored in Internet Calendar (iCal) format.

API link: http://msdn.microsoft.com/en-us/library/websvcmeetings.meetings.updatemeetingfromical(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
icalText	The iCal representation of the updated meeting.	String	/	UTF-8
ignoreAttendees	True to skip processing of attendee information in the iCal; otherwise, false.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

UpdateMeetingFromICalResponse.UpdateMeetingFromICalResult A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following: <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body> <UpdateMeetingFromICalResponse xmlns= "http://schemas.microsoft.com/sharepoint/soap/meetings/"> <UpdateMeetingFromICalResult> <UpdateMeetingFromICal> <AttendeeUpdateStatus Code="0" Detail="" ManageUserPage="" /> </UpdateMeetingFromICal></UpdateMeetingFromICalResult> </UpdateMeetingFromICalResponse> </soap:Body></soap:Envelope>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:people-is-claims-mode>

Indicates if it is Claims mode

API link: http://msdn.microsoft.com/en-us/library/websvcpeople.people.isclaimsmode(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
boolean	If is claims mode

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:people-resolve-principals>

Resolves an e-mail address or other form of user identification (ID) into a PrincipalInfo object.

API link: Resolves an e-mail address or other form of user identification (ID) into a PrincipalInfo object.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
principalKeys	Logon name of the principal.	PeopleArrayOfString	/
addToUserInfoList	Indicates whether to add the principal to a SPUserCollection that is associated with the Web site.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sharepoint:principal-type>		SPPrincipalType object that specifies user scope and other information.	List<String>

Returns

Return Type	Description
ArrayOfPrincipalInfo	A list of PrincipalInfo objects that is indexed and accessed by the logon name in the AccountName() field.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:people-search-principals>

Returns an array of PrincipalInfo objects from the SPUserCollection for the Web site. All instances have the principal logon name specified in searchText. Only the maxResults objects can be added to the array.

API link: http://msdn.microsoft.com/en-us/library/websvcpeople.people.searchprincipals(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
searchText	Principal logon name.	String	/	UTF-8
maxResults	Unless otherwise specified, the maximum number of principals that can be returned from a provider is 10.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<sharepoint:principal-type>		SPPrincipalType object that specifies user scope and other information.	List<String>

Returns

Return Type	Description
ArrayOfPrincipalInfo	A list of PrincipalInfo objects that is indexed and accessed by principal logon name.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:permission-add-permission>

Modifies site-level permissions for the site group that exists on the site, or adds or modifies permissions to the specified list for the user, site group, or cross-site group that exists on the site.

API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.addpermission(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
objectName	A string that contains the name of the list or site.	String	/	UTF-8
objectType	A string that specifies either List or Web.	String	/	UTF-8
permissionIdentifier	A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies.	String	/	UTF-8
permissionType	A string that specifies user, group (cross-site group), or role (site group). The user or cross-site group has to be valid, and the site group has to already exist on the site.	String	/	UTF-8
permissionMask	A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and defines the permission. Use the pipe symbol ("\|") in C# or Or in Microsoft Visual Basic to delimit values when creating a custom permission mask that combines permissions.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:permission-add-permission-collection>

Modifies site-level permissions for the specified collection of existing site groups, or adds or modifies permissions to the list for the specified collection of existing users, site groups, and cross-site groups.

API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.addpermissioncollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
objectName	A string that contains the name of the list or site.	String	/	UTF-8
objectType	A string that specifies either List or Web.	String	/	UTF-8
permissionsInfoXml	XML fragment in the following format that specifies the permissions to add and that can be passed as a System.Xml.XmlNode object: `<Permissions> <Users> <User LoginName= "DOMAIN\User_Alias" Email="Email_Address" Name="Display_Name" Notes="Notes" PermissionMask="138608641" /> . . . </Users> <Groups> <Group GroupName= "Cross-site_Group" PermissionMask= "1027801615" /> . . . </Groups> <Roles> <Role RoleName="Site_Group" PermissionMask="-1" /> . . . </Roles> </Permissions>`	AddPermissionCollection.PermissionsInfoXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:permission-get-permission-collection>

Returns the collection of permissions for a site or list.

API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.getpermissioncollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
objectName	A string that contains the name of the list or site.	String	/	UTF-8
objectType	A string that specifies either List or Web.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetPermissionCollectionResponse.GetPermissionCollectionResult An XML fragment in the following form that can be assigned to a System.Xml.XmlNode object: <GetPermissionCollection xmlns="http://schemas.microsoft.com/sharepoint/soap/directory/"> <Permissions> <Permission MemberID="1073741829" Mask="-1" MemberIsUser="False" MemberGlobal="False" RoleName="Administrator" /> <Permission MemberID="1073741828" Mask="1029638927" MemberIsUser="False" MemberGlobal="False" RoleName="Web Designer" /> <Permission MemberID="1073741827" Mask="1027801615" MemberIsUser="False" MemberGlobal="False" RoleName="Contributor" /> <Permission MemberID="1073741826" Mask="138608641" MemberIsUser="False" MemberGlobal="False" RoleName="Reader" /> <Permission MemberID="1073741825" Mask="134283264" MemberIsUser="False" MemberGlobal="False" RoleName="Guest" /> <Permission MemberID="1073741830" Mask="134414337" MemberIsUser="False" MemberGlobal="False" RoleName="Site_Group1" /> <Permission MemberID="1073741831" Mask="134283265" MemberIsUser="False" MemberGlobal="False" RoleName="Site_Group2" /> . . . </GetPermissionCollection>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:permission-remove-permission>

Removes the specified permission from the list.

API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.removepermission(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
objectName	A string that contains the name of the list.	String	/	UTF-8
objectType	A string that specifies List.	String	/	UTF-8
permissionIdentifier	A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies.	String	/	UTF-8
permissionType	A string that specifies user, group (cross-site group), or role (site group).	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:permission-remove-permission-collection>

Removes permissions from the list for the specified members.

API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.removepermissioncollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
objectName	A string that contains the name of the list.	String	/	UTF-8
objectType	A string that specifies List.	String	/	UTF-8
memberIdsXml	An XML fragment in the following format that specifies the permissions to remove and that can be passed as a System.Xml.XmlNode object:	RemovePermissionCollection.MemberIdsXml	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:permission-update-permission>

Modifies site-level permissions for the specified site group, or modifies permissions to the list for the specified user, site group, or cross-site group.

API link: http://msdn.microsoft.com/en-us/library/websvcpermissions.permissions.updatepermission(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
objectName	A string that contains the name of the list or site.	String	/	UTF-8
objectType	A string that specifies either List or Web.	String	/	UTF-8
permissionIdentifier	A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies.	String	/	UTF-8
permissionType	A string that specifies user, group (cross-site group), or role (site group). The user or cross-site group must be valid, and the site group must already exist on the site.	String	/	UTF-8
permissionMask	A 32-bit integer that specifies the new permission mask (for example, 134284064). The GetPermissionCollection can be used to return the permissions for the site or list.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:query>

Returns an XML string containing the search results set for the specified query.

API link: http://msdn.microsoft.com/en-us/library/websvcspsearch.queryservice.query(v=office.14).aspx

SQL Search syntax link: http://msdn.microsoft.com/en-us/library/ms443580(v=office.12).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
queryXml	#[payload]	Optional. A string specifying the search query XML. The XML format is defined by the Microsoft.Search.Query Schema	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that contains the query response using elements described by the Microsoft.Search.Response.Document Schema

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-enumerate-folder>

Returns information about the files and folders within a folder on a SharePoint site.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.enumeratefolder(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strFolderUrl	A string that contains the site-relative URL of the folder.	String	/	UTF-8
enumerateFolderResult	A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.	Holder<Long>	/
vUrls	Returns an array that contains information about the files and folders, including their URLs, the date and time that each item was last modified, and a Boolean value that specifies whether the item is a folder.	Holder<ArrayOfSFPUrl>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-attachments>

Returns the URLs for all attachments to a specified item in a SharePoint list.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getattachments(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	A string that contains either the name of the list or the GUID of the list enclosed in curly braces ({}).	String	/	UTF-8
strItemId	A string that contains an integer specifying the identifier (ID) of the item.	String	/	UTF-8
getAttachmentsResult	A long indicating the result of the operation	Holder<Long>	/
vAttachments	A string array that contains the URLs of the attachments.	Holder<SitedataArrayOfString>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-changes>

Returns the changes that occurred on a site collection content from one moment in time to another.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getchanges(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
objectType	The change tracking space to report about, either "ContentDatabase" or "Site". All other objectType values, as defined in ObjectType should not be used. The server may treat all other types as "Site". Note that "Site" in the context of this parameter actually means site collection.	ObjectType	/
contentDatabaseId	GUID of the content database, known in advance or obtained by GetContent request.	String	/	UTF-8
startChangeId	Start change id	Holder<String>	/
endChangeId	End change id	Holder<String>	/
timeout	Timeout, in seconds, which the client gives the server to collect changes. The server MUST NOT spend more than this amount of time preparing the response.	int	/
getChangesResult	Indicates whether the server is aware of any more changes before the one marked by CurrentChangeId token. If the server has successfully collected all change records for the requested increment within the Timeout limit, then the server MUST specify moreChanges = false. Also in this case the server MUST set LastChangeId and CurrentChangeId to the same value. This tells the client that there are no more changes marked before the CurrentChangeId token. If the server was unable to collect all change records within the Timeout or other constraints, the server MUST specify moreChanges = true. This tells the client that it SHOULD repeat the request using the suggested LastChangeId and CurrentChangeId. If the server is unable to collect all change records because the client passed a LastChangeId token that is older than the server's change records, then the sever MUST return the following SOAP error in response to the GetChanges operation:	Holder<String>	/
moreChanges	More changes	Holder<Boolean>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-content>

A string representing information about the web application.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getcontent(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
objectType	The change tracking space to report about, either "ContentDatabase" or "Site". All other objectType values, as defined in ObjectType should not be used. The server may treat all other types as "Site". Note that "Site" in the context of this parameter actually means site collection.	ObjectType	/
objectId	Specifies the name or GUID of an object. The GUID should be enclosed in curly braces ({}).	String	/	UTF-8
folderUrl	Specifies the folder name or the URL of a folder. The URL may be a absolute URL or a server-relative URL.	String	/	UTF-8
itemId	Specifies the ID of the list item.	String	/	UTF-8
retrieveChildItems	Flag specifying whether to get information about the child sites, lists and folders.	boolean	/
securityOnly	Flag specifying whether to get all the information for a list item or items of a folder. If true, the operation must return only the mandatory information, else the operation must return all the information.	boolean	/
lastItemIdOnPage	Used for pagination. Clients use this to sequentially retrieve large amount of data.	Holder<String>	/
getContentResult	Returns change information (ChangeId) about the content database and site collection. Also returns information about the web application, site collection, site, list, list item, folder and attachment.	Holder<String>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-list>

Returns metadata from the specified SharePoint list.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getlist(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	A string that contains either the name of the list or the GUID of the list enclosed in curly braces ({}).	String	/	UTF-8
getListResult	A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.	Holder<Long>	/
sListMetadata	Returns metadata from the list.	Holder<SListMetadata>	/
vProperties	Returns an array that contains information about each field in the list, including its name, title, and type.	Holder<ArrayOfSProperty>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-list-collection>

Returns information about all the lists in the current SharePoint site.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getlistcollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
getListCollectionResult	A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.	Holder<Long>	/
vLists	A string that returns an array that contains information about the lists.	Holder<ArrayOfSList>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-list-items>

Performs a query against the specified SharePoint list.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getlistitems(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strListName	A string that contains the GUID of the list enclosed in curly braces ({}).	String	/	UTF-8
strQuery	A string in the following form containing the Where clause of a Query element that specifies a filter for the query: `<Where> <Lt> <FieldRef Name="ID" /> <Value Type="Counter">3</Value> </Lt> </Where>`	String	/	UTF-8
strViewFields	A string in the following form containing the field references of a ViewFields element that specify which fields to return in the query: `<FieldRef Name="ID" /> <FieldRef Name="Title" />`	String	/	UTF-8
uRowLimit	A 32-bit unsigned integer that specifies the number of rows to return in the query.	long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

String

A string in XML data format that contains a schema and the data returned through the query, as follows:

 <xml xmlns:s="uuid:BDC6E3F0-6DA3-11d1-A2A3-00AA00C14882" xmlns:dt="uuid:C2F41010-65B3-11d1-A29F-00AA00C14882" xmlns:rs="urn:schemas-microsoft-com:rowset" xmlns:z="#RowsetSchema">
  <s:Schema id="RowsetSchema">
    <s:ElementType name="row" content="eltOnly" rs:CommandTimeout="30">
      <s:AttributeType name="ows_Title" rs:name="Title" rs:number="1">
        <s:datatype dt:type="string" dt:maxLength="512" />
      </s:AttributeType>
      <s:AttributeType name="ows_Number" rs:name="Number" rs:number="2">
        <s:datatype dt:type="float" dt:maxLength="8" />
      </s:AttributeType>
      <s:AttributeType name="ows_ID" rs:name="ID" rs:number="3">
        <s:datatype dt:type="i4" dt:maxLength="4" />
      </s:AttributeType>
      <s:AttributeType name="ows_owshiddenversion" rs:name="owshiddenversion" rs:number="4">
        <s:datatype dt:type="i4" dt:maxLength="4" />
      </s:AttributeType>
    </s:ElementType>
  </s:Schema>
  <rs:data ItemCount="1">
    <z:row ows_Title="Value1" ows_Number="100.000000000000" ows_ID="1" ows_owshiddenversion="2" />
    <z:row ows_Title="Value2" ows_Number="100.000000000000" ows_ID="2" ows_owshiddenversion="2" />
    .
    .
    .
  </rs:data>
</xml>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-site>

Returns site metadata, information about the subsites in the current site collection, and information about the cross-site groups on the site and about the users who are members of each group.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getsite(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
getSiteResult	A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.	Holder<Long>	/
sSiteMetadata	Site metadata from the current site.	Holder<SSiteMetadata>	/
vWebs	An array containing information about the sites in the current site collection, including their URLs and the dates they were last modified.	Holder<ArrayOfSWebWithTime>	/
strUsers	This parameter is not used but must be passed.	Holder<String>	/
strGroups	Information about the cross-site groups on the current site in the following form: `<Groups> <Group ID="4" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser= "True" /> <Group ID="4" Name="Group2" Description="Description" OwnerID="1" OwnerIsUser= "True" /> </Groups>`	Holder<String>	/
vGroups	Information about the users in each cross-site group on the site in the following form: `<Users> <User ID="1" Sid="S-1-5-21- 2127521184-1604012920- 1887927527-76687" Name="Display_Name" LoginName="DOMAIN\User_Alias" Email="Email_Address" Notes="" IsSiteAdmin="True" IsDomainGroup="False" /> <User ID="1" Sid="S-1-5-21- 2127521184-1604012920- 1887927527-259353" Name="Display_Name" LoginName="DOMAIN\User_Alias" Email="Email_Address" Notes="" IsSiteAdmin="True" IsDomainGroup="False" /> </Users>`	Holder<SitedataArrayOfString>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-site-and-web>

Returns the absolute URL of a subsite and the absolute URL of its top-level parent site based on the specified site URL.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getsiteandweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strUrl	The absolute URL of the parent top-level site.	String	/	UTF-8
getSiteAndWebResult	A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.	Holder<Long>	/
strSite	The absolute URL of the subsite.	Holder<String>	/
strWeb	The absolute URL of the subsite.	Holder<String>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-site-url>

Returns the GUID and URL of the site collection to which the specified URL belongs.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getsiteurl(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
url	Undefined	String	/	UTF-8
getSiteUrlResult	Undefined	Holder<Long>	/
siteUrl	Undefined	Holder<String>	/
siteId	Undefined	Holder<String>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-url-segments>

A string representing the identifiers of a site, list or list item depending on the specified URL. The behavior of the operation depends on the specified URL.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.geturlsegments(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
strURL	Specifies an absolute URL of any item in the context site.	String	/	UTF-8
getURLSegmentsResult	The result of the operation	Holder<Boolean>	/
strWebID	Specifies the GUID of the site. This GUID must be enclosed in curly braces ({}).	Holder<String>	/
strBucketID	Specifies the GUID the external security provider. This GUID must be enclosed in curly braces ({}).	Holder<String>	/
strListID	Specifies the GUID the list. This GUID must be enclosed in curly braces ({}).	Holder<String>	/
strItemID	Specifies the ID of the list item.	Holder<String>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sitedata-get-web>

Returns site and list metadata, as well as information about the users and site groups for the current SharePoint site.

API link: http://msdn.microsoft.com/en-us/library/websvcsitedata.sitedata.getweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
getWebResult	A 32-bit unsigned integer that returns 0 to indicate that the operation has completed.	Holder<Long>	/
sWebMetadata	Metadata from the current site.	Holder<SWebMetadata>	/
vWebs	An array containing information about the subsites under the current site, including their URLs and the dates they were last modified.	Holder<ArrayOfSWebWithTime>	/
vLists	An array containing information about the lists in the current site, including their GUIDS, Boolean values indicating whether they are empty, and the date they were last modified.	Holder<ArrayOfSListWithTime>	/
vFPUrls	This parameter is not used but must be passed.	Holder<ArrayOfSFPUrl>	/
strRoles	Information about the site groups on the current site in the following form: <Roles> <Role ID="1073741825" Name= "Guest" Description="Can view specific lists or document libraries when given permissions." Type="1" /> <Role ID="1073741826" Name= "Reader" Description= "Has read-only access to the Web site." Type="2" /> <Role ID="1073741827" Name= "Contributor" Description= "Can add content to existing document libraries and lists." Type="3" /> <Role ID="1073741828" Name="Web Designer" Description= "Can create lists and document libraries and customize pages in the Web site." Type="4" /> <Role ID="1073741829" Name= "Administrator" Description= "Has full control of the Web site." Type="5" /> </Roles>	Holder<String>	/
vRolesUsers	String array that contains information about the users for each site group in the following form: `<Users> <User ID="1" Sid="S-1-5-21- 2127521184-1604012920- 1887927527-76687" Name="Display_Name" LoginName="DOMAIN\User_Alias" Email="Email_Address" Notes="" IsSiteAdmin="True" IsDomainGroup="False" /> <User ID="1" Sid="S-1-5-21- 2127521184-1604012920- 1887927527-259353" Name="Display_Name" LoginName="DOMAIN\User_Alias" Email="Email_Address" Notes="" IsSiteAdmin="True" IsDomainGroup="False" /> </Users>`	Holder<SitedataArrayOfString>	/
vRolesGroups	String array that contains information about the cross-site groups that are members of each site group on the site in the following form: `<Groups> <Group ID="4" Name="Group1" Description="Description" OwnerID="1" OwnerIsUser= "True" /> <Group ID="4" Name="Group2" Description="Description" OwnerID="1" OwnerIsUser="True" /> </Groups>`	Holder<SitedataArrayOfString>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sites-create-web>

Create Web

API link: http://msdn.microsoft.com/en-us/library/ee658286(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
url	Url	String	/	UTF-8
title	Title	String	/	UTF-8
description	Description	String	/	UTF-8
templateName	Template Name	String	/	UTF-8
language	Language	Long	/
locale	Locale	Long	/
collationLocale	Collation Locale	Long	/
uniquePermissions	Unique Permissions	Boolean	/
anonymous	Anonymus	Boolean	/
presence	Presence	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sites-delete-web>

Delete web

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.deleteweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
url	#[payload]	Optional. Url	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sites-export-solution>

Export Solution

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.exportsolution(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
solutionFileName	Solution File Name	String	/	UTF-8
title	Title	String	/	UTF-8
description	Description	String	/	UTF-8
fullReuseExportMode	Full Reuse Export Mode	boolean	/
includeWebContent	Include Web Content	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sites-export-web>

Exports a Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.exportweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
jobName	The file name to use for content migration packages.	String	/	UTF-8
webUrl	The URL of the site to export.	String	/	UTF-8
dataPath	The directory location where content migration packages are placed.	String	/	UTF-8
includeSubwebs	True to include subwebs; otherwise, false.	boolean	/
includeUserSecurity	True to include site security groups and group membership information; otherwise, false.	boolean	/
overWrite	True to overwrite the content migration package if it exists; otherwise, false.	boolean	/
cabSize	Indicates the maximum size for the CMP (content migration package) file.	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
int	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sites-get-site>

Get Site

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getsite(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
siteUrl	#[payload]	Optional. Site Url	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sites-get-site-templates>

Returns information about the collection of site definitions and sites templates in the Web application.

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getsitetemplates(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
lcid	A 32-bit integer that specifies the locale identifier (LCID), for example, 1033 in English.	long	/
getSiteTemplatesResult	If successful, returns 0 as a Long	Holder<Long>	/
templateList	A template array whose elements provide fields containing information about each template.	Holder<ArrayOfTemplate>	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sites-get-updated-form-digest>

Get Updated From Digest

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getupdatedformdigest(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	Result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sites-get-updated-form-digest-information>

Get Updated Form Digest Information

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.getupdatedformdigest(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
url	#[payload]	Optional. Url	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
FormDigestInformation	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:sites-import-web>

Import web

API link: http://msdn.microsoft.com/en-us/library/websvcsites.sites.importweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
jobName	Job Name	String	/	UTF-8
webUrl	Web Url	String	/	UTF-8
dataFiles	Data Files	SitesArrayOfString	/
logPath	Log Path	String	/	UTF-8
includeUserSecurity	Include User Security	boolean	/
overWrite	Over Write	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
int	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:versions-delete-all-versions>

Deletes all versions of the specified file.

API link: http://msdn.microsoft.com/en-us/library/websvcversions.versions.deleteallversions(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
fileName	#[payload]	Optional. A string that contains the site-relative location of the folder name and file name of the file whose versions are to be deleted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
DeleteAllVersionsResponse.DeleteAllVersionsResult	An XML fragment in the following form `<results xmlns="http://schemas.microsoft.com/sharepoint/soap/"> <list id="{26E516B0-8241-4B97-984D-000000000000`" /> }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:versions-delete-version>

Deletes the specified file version.

API link: http://msdn.microsoft.com/en-us/library/websvcversions.versions.deleteversion(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
fileName	A string that contains the site-relative location of the folder name and file name of the file whose version is to be deleted.	String	/	UTF-8
fileVersion	A string that specifies the number of the file version to delete.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
DeleteVersionResponse.DeleteVersionResult	An XML fragment in the following form `<results xmlns="http://schemas.microsoft.com/sharepoint/soap/"> <list id="{26E516B0-8241-4B97-984D-000000000000`" /> . . . }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:versions-delete-view>

Deletes the specified view of the specified list.

API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.deleteview(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
listName	A string that contains the internal name of the list.	String	/	UTF-8
viewName	A string that contains the GUID for the view.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:versions-get-versions>

Returns information about the versions of the specified file.

API link: http://msdn.microsoft.com/en-us/library/websvcversions.versions.getversions(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
fileName	#[payload]	Optional. A string that contains the site-relative URL of the file in the form Folder_Name/File_Name.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetVersionsResponse.GetVersionsResult	An XML fragment in the following form `<results xmlns="http://schemas.microsoft.com/sharepoint/soap/"> <list id="{26E516B0-8241-4B97-984D-000000000000`" /> . . . }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:versions-restore-version>

Restores the specified file version.

API link: http://msdn.microsoft.com/en-us/library/websvcversions.versions.restoreversion(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
fileName	A string that contains the site-relative URL of the file in the form Folder_Name/File_Name.	String	/	UTF-8
fileVersion	A string that identifies the file version.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RestoreVersionResponse.RestoreVersionResult	An XML fragment in the following form `<results xmlns="http://schemas.microsoft.com/sharepoint/soap/"> <list id="{26E516B0-8241-4B97-984D-000000000000`" /> }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:views-add-view>

Creates a view for the specified list.

API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.addview(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
listName	A string that contains the internal name of the list.	String	/	UTF-8
viewName	A string that contains the GUID for the view, which determines the view to use for the default view attributes represented by the query, viewFields, and rowLimit parameters. If this argument is not supplied, the default view is assumed.	String	/	UTF-8
viewFields	A ViewFields element that specifies which fields to return in the query and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewFields> <FieldRef Name="Title" /> <FieldRef Name="ID" /> </ViewFields>`	AddView.ViewFields	/
query	A Query element containing the query that determines which records are returned and in what order, and that can be assigned to a System.Xml.XmlNode object. For example, the following query returns list items where the ID is less than 3 and orders the items by title: `<Query> <Where> <Lt> <FieldRef Name="ID" /> <Value Type="Counter">3</Value> </Lt> </Where> <OrderBy> <FieldRef Name="Title" /> </OrderBy> </Query>`	AddView.Query	/
rowLimit	A RowLimit element that specifies the number of items, or rows, to display on a page before paging begins, and that can be assigned to a System.Xml.XmlNode object. The fragment can include the Paged attribute to specify that the view return list items in pages. The following example sets a limit of 100 items per page: `<RowLimit Paged="True">100</RowLimit>`	AddView.RowLimit	/
type	A string that specifies whether the view is an HTML view or a Datasheet view. Possible values include HTML and Grid.	String	/	UTF-8
makeViewDefault	True to make the view the default view for the list.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
AddViewResponse.AddViewResult	A Introduction to Collaborative Application Markup Language (CAML) fragment in the following form that contains the view schema and can be assigned to a System.Xml.XmlNode object. `<AddViewResult> <View Name="{B5C3250A-1974-49E9-9F61-180F86704434`" DefaultView="TRUE" Type="HTML" DisplayName="All Contacts" Url="Lists/Contacts/AllItems.htm" BaseViewID="1" xmlns=""> 100 }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:views-get-view>

Returns the schema of the specified view for the specified list.

API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.getview(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
listName	A string that contains the internal name of the list.	String	/	UTF-8
viewName	A string that contains the GUID for the view. If the view name is blank, the default view is returned.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetViewResponse.GetViewResult	A fragment in Introduction to Collaborative Application Markup Language (CAML) in the following form `<View Name="{EE7C652F-9CBF-433F-B376-86B0EE989A06`" DefaultView="TRUE" Type="HTML" DisplayName="View_Name" Url="Lists/Events/File_Name.aspx" BaseViewID="1"> 2003-03-03T00:00:00Z 100 }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:views-get-view-collection>

Returns the display names, internal names, and URLs for the collection of views of the specified list.

API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.getviewcollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
listName	#[payload]	Optional. A string that contains the internal name of the list.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetViewCollectionResponse.GetViewCollectionResult	A fragment in Introduction to Collaborative Application Markup Language (CAML) in the following form `<GetViewCollectionResult> <Views> <View DisplayName="Allitems" Name="{C1036607-EC8A-11d3-82AA-0050048394B0`" Url="List\Events\Allitems.aspx" /> ... }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:views-get-view-html>

Returns the full schema of the specified view for the specified list, including the HTML sections.

API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.getviewhtml(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
listName	A string that contains the name of the list.	String	/	UTF-8
viewName	A string that contains the GUID specifying the view.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetViewHtmlResponse.GetViewHtmlResult

A fragment in Introduction to Collaborative Application Markup Language (CAML) in the following form

 <GetViewHTMLResult>
  <View Name="{C1036607-EC8A-11d3-82AA-0050048394B0" DefaultView="TRUE" 
    Type="HTML" DisplayName="All Contacts" Url="Lists/Contacts/AllItems.htm" 
    BaseViewID="1" xmlns="">
    
    ...
    
    
    ...
    
    
    ...
    
    
    ...
    
    
    ...
      
    
    ...
    
    
    ...
     
    
    ...
    
    
    ...
    
    
    ...
    
    
       
       
       
       
       
       
    
    
      
        
        
      
    
    
      
    
    100
  

 }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:views-update-view>

Modifies the specified view of the specified list.

API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.updateview(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
listName	A string that contains the internal name of the list.	String	/	UTF-8
viewName	A string that contains the GUID for the view.	String	/	UTF-8
viewProperties	An XML fragment that contains all the view-level properties as attributes, such as Editor, Hidden, ReadOnly, and Title.	UpdateView.ViewProperties	/
query	A Query element containing the query that determines which records are returned and in what order, and that can be assigned to a System.Xml.XmlNode object. The following example performs a query for cases in which the ID field is less than 3, and displays items in the order of their titles: `<Query> <Where> <Lt> <FieldRef Name="ID" /> <Value Type="Counter">3</Value> </Lt> </Where> <OrderBy> <FieldRef Name="Title" /> </OrderBy> </Query>`	UpdateView.Query	/
viewFields	A ViewFields element that specifies which fields to return in the query and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewFields> <FieldRef Name="Title" /> <FieldRef Name="ID" /> </ViewFields>`	UpdateView.ViewFields	/
aggregations	An Aggregations element that specifies the fields to aggregate and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<Aggregations Value="On"> <FieldRef Name="Title" Type="Count"> <FieldRef Name="Number" Type="Sum"> </Aggregations>`	UpdateView.Aggregations	/
formats	A Formats element that defines the grid formatting for columns and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<Formats> <FormatDef Type="RowHeight" Value="67" /> <Format Name="Attachments"> <FormatDef Type="ColWidth" Value="75" /> </Format> <Format Name="LinkTitle"> <FormatDef Type="WrapText" Value="1" /> <FormatDef Type="ColWidth" Value="236" /> </Format> ... </Formats>`	UpdateView.Formats	/
rowLimit	A RowLimit element that specifies the number of items, or rows, to display on a page before paging begins and that can be assigned to a System.Xml.XmlNode object. The fragment can include the Paged attribute to specify that the view return list items in pages. The following example sets a limit of 100 items per page: `<RowLimit Paged="True">100</RowLimit>`	UpdateView.RowLimit	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

UpdateViewResponse.UpdateViewResult

A Introduction to Collaborative Application Markup Language (CAML) fragment in the following form

 <UpdateViewResult>
  <View Name="{B5C3250A-1974-49E9-9F61-180F86704434" DefaultView="TRUE" Type="HTML" 
    DisplayName="All Contacts" Url="Lists/Contacts/AllItems.htm" BaseViewID="1" xmlns=""> 
    
      
      
      
      
      
      
    
    
      
        
        
      
      
        
          
          Today + 1
        
      
    
    
      
    
    100
  

 }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:views-update-view-html>

Updates the specified view with the supplied properties and values, including the display properties of Introduction to Collaborative Application Markup Language (CAML) and HTML.

API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.updateviewhtml(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
listName	A string that contains the internal name of the list.	String	/	UTF-8
viewName	A string that contains the GUID for the view.	String	/	UTF-8
viewProperties	An XML fragment that contains all view-level properties as attributes, such as Editor, Hidden, ReadOnly, and Title.	UpdateViewHtml.ViewProperties	/
toolbar	A Toolbar element that sets the HTML used to render the toolbar in a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<Toolbar Type="Standard"> <IfEqual> <Expr1> <GetVar Name="SearchString" /> </Expr1> <Expr2 /> <Then> ... </Toolbar>`	UpdateViewHtml.Toolbar	/
viewHeader	A ViewHeader element that sets the HTML used to render the header of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewHeader> <HTML> <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0> ]]> </HTML> ... </ViewHeader>`	UpdateViewHtml.ViewHeader	/
viewBody	A ViewBody element that sets the HTML used to render the body of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewBody> <HTML> <![CDATA[ <TR>]]> </HTML> <Fields> <HTML> <![CDATA[ <TD Class=" ]]> </HTML> ... </ViewBody>`	UpdateViewHtml.ViewBody	/
viewFooter	A ViewFooter element that sets the HTML used to render the footer of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewFooter> <HTML> <![CDATA[ </TABLE> ]]> </HTML> <IfEqual> ... </ViewFooter>`	UpdateViewHtml.ViewFooter	/
viewEmpty	A ViewEmpty element that contains the HTML used to render the page if the query returns no items and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewEmpty> <HTML> <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0><tr><td> ]]> </HTML> ... </ViewEmpty>`	UpdateViewHtml.ViewEmpty	/
rowLimitExceeded	A RowLimitExceeded element that specifies alternate rendering for when the specified row limit is exceeded and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<RowLimitExceeded> <HTML><![CDATA[ <table class="ms-summarycustombody" cellpadding=0 cellspacing=0 border=0 rules=rows> ... </td></tr></table> ]]> </HTML> </RowLimitExceeded>`	UpdateViewHtml.RowLimitExceeded	/
query	A Query element containing the query that determines which records are returned and in what order, and that can be assigned to a System.Xml.XmlNode object. The following example performs a query for cases in which the ID field is less than 3, and displays items in the order of their titles: `<Query> <Where> <Lt> <FieldRef Name="ID" /> <Value Type="Counter">3</Value> </Lt> </Where> <OrderBy> <FieldRef Name="Title" /> </OrderBy> </Query>`	UpdateViewHtml.Query	/
viewFields	A ViewFields element that specifies which fields to return in the query and in what order, and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewFields> <FieldRef Name="ID" /> <FieldRef Name="Title" /> </ViewFields>`	UpdateViewHtml.ViewFields	/
aggregations	An Aggregations element that specifies the fields to aggregate and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<Aggregations Value="On"> <FieldRef Name="Title" Type="Count"> <FieldRef Name="Number" Type="Sum"> </Aggregations>`	UpdateViewHtml.Aggregations	/
formats	A Formats element that defines the grid formatting for columns and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<Formats> <FormatDef Type="RowHeight" Value="67" /> <Format Name="Attachments"> <FormatDef Type="ColWidth" Value="75" /> </Format> <Format Name="LinkTitle"> <FormatDef Type="WrapText" Value="1" /> <FormatDef Type="ColWidth" Value="236" /> </Format> ... </Formats>`	UpdateViewHtml.Formats	/
rowLimit	A RowLimit element that specifies the number of items, or rows, to display on a page before paging begins and that can be assigned to a System.Xml.XmlNode object. The fragment can include the Paged attribute to specify that the view return list items in pages. The following example sets a limit of 100 items per page: `<RowLimit Paged="True">100</RowLimit>`	UpdateViewHtml.RowLimit	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

UpdateViewHtmlResponse.UpdateViewHtmlResult

A CAML fragment in the following form that contains the view schema and that can be assigned to a System.Xml.XmlNode object.

 <View Name="{54992C89-4F9F-4B2E-8E5A-F55C1C70831B" Type="HTML" DisplayName="MyView" Url="Lists/TestCustList/MyView.aspx" BaseViewID="1" xmlns="http://schemas.microsoft.com/sharepoint/soap/">
  
    
    
    
    
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  100
  
  ...
  
  
  ...
  

 }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:views-update-view-html2>

Updates the specified view with the supplied properties and values, including the display properties of Introduction to Collaborative Application Markup Language (CAML) and HTML.

API link: http://msdn.microsoft.com/en-us/library/websvcviews.views.updateviewhtml2(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
listName	A string that contains the internal name of the list.	String	/	UTF-8
viewName	A string that contains the GUID for the view.	String	/	UTF-8
viewProperties	An XML fragment that contains all view-level properties as attributes, such as Editor, Hidden, ReadOnly, and Title.	UpdateViewHtml2.ViewProperties	/
toolbar	A Toolbar element that sets the HTML used to render the toolbar in a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<Toolbar Type="Standard"> <IfEqual> <Expr1> <GetVar Name="SearchString" /> </Expr1> <Expr2 /> <Then> ... </Toolbar>`	UpdateViewHtml2.Toolbar	/
viewHeader	A ViewHeader element that sets the HTML used to render the header of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewHeader> <HTML> <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0> ]]> </HTML> ... </ViewHeader>`	UpdateViewHtml2.ViewHeader	/
viewBody	A ViewBody element that sets the HTML used to render the body of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewBody> <HTML> <![CDATA[ <TR>]]> </HTML> <Fields> <HTML> <![CDATA[ <TD Class=" ]]> </HTML> ... </ViewBody>`	UpdateViewHtml2.ViewBody	/
viewFooter	A ViewFooter element that sets the HTML used to render the footer of a view and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewFooter> <HTML> <![CDATA[ </TABLE> ]]> </HTML> <IfEqual> ... </ViewFooter>`	UpdateViewHtml2.ViewFooter	/
viewEmpty	A ViewEmpty element that contains the HTML used to render the page if the query returns no items and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewEmpty> <HTML> <![CDATA[ <TABLE width="100%" cellspacing=0 cellpadding=0 border=0><tr><td> ]]> </HTML> ... </ViewEmpty>`	UpdateViewHtml2.ViewEmpty	/
rowLimitExceeded	A RowLimitExceeded element that specifies alternate rendering for when the specified row limit is exceeded and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<RowLimitExceeded> <HTML><![CDATA[ <table class="ms-summarycustombody" cellpadding=0 cellspacing=0 border=0 rules=rows> ... </td></tr></table> ]]> </HTML> </RowLimitExceeded>`	UpdateViewHtml2.RowLimitExceeded	/
query	A Query element containing the query that determines which records are returned and in what order, and that can be assigned to a System.Xml.XmlNode object. The following example performs a query for cases in which the ID field is less than 3, and displays items in the order of their titles: `<Query> <Where> <Lt> <FieldRef Name="ID" /> <Value Type="Counter">3</Value> </Lt> </Where> <OrderBy> <FieldRef Name="Title" /> </OrderBy> </Query>`	UpdateViewHtml2.Query	/
viewFields	A ViewFields element that specifies which fields to return in the query and in what order, and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<ViewFields> <FieldRef Name="ID" /> <FieldRef Name="Title" /> </ViewFields>`	UpdateViewHtml2.ViewFields	/
aggregations	An Aggregations element that specifies the fields to aggregate and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<Aggregations Value="On"> <FieldRef Name="Title" Type="Count"> <FieldRef Name="Number" Type="Sum"> </Aggregations>`	UpdateViewHtml2.Aggregations	/
formats	A Formats element that defines the grid formatting for columns and that can be assigned to a System.Xml.XmlNode object, as in the following example: `<Formats> <FormatDef Type="RowHeight" Value="67" /> <Format Name="Attachments"> <FormatDef Type="ColWidth" Value="75" /> </Format> <Format Name="LinkTitle"> <FormatDef Type="WrapText" Value="1" /> <FormatDef Type="ColWidth" Value="236" /> </Format> ... </Formats>`	UpdateViewHtml2.Formats	/
rowLimit	A RowLimit element that specifies the number of items, or rows, to display on a page before paging begins and that can be assigned to a System.Xml.XmlNode object. The fragment can include the Paged attribute to specify that the view return list items in pages. The following example sets a limit of 100 items per page: `<RowLimit Paged="True">100</RowLimit>`	UpdateViewHtml2.RowLimit	/
openApplicationExtension	Open Application Extension	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

UpdateViewHtml2Response.UpdateViewHtml2Result

A CAML fragment in the following form that contains the view schema and that can be assigned to a System.Xml.XmlNode object.

 <View Name="{54992C89-4F9F-4B2E-8E5A-F55C1C70831B" Type="HTML" DisplayName="MyView" Url="Lists/TestCustList/MyView.aspx" BaseViewID="1" xmlns="http://schemas.microsoft.com/sharepoint/soap/">
  
    
    
    
    
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  
  ...
  
  100
  
  ...
  
  
  ...
  

 }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-add-web-part>

Adds a new Web Part to a Web Part Page.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.addwebpart(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
pageUrl	A string containing the URL of the Web Part Page.	String	/	UTF-8
webPartXml	A string containing the XML of the Web Part.	String	/	UTF-8
storage	A Storage value indicating how the Web Part was stored.	Storage	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A GUID that identifies the newly created Web Part.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-add-web-part-to-zone>

Add Web Part To Zone

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.addwebparttozone(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
pageUrl	Page Url	String	/	UTF-8
webPartXml	Web Part Xml	String	/	UTF-8
storage	Storage	Storage	/
zoneId	Zone Id	String	/	UTF-8
zoneIndex	Zone Index	int	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-associate-workflow-markup>

Creates a new SPWorkflowAssociation object list applied in the /WorkflowConfig/Association/@ListID attribute in the associated configuration file. If the /WorkflowConfig/Association/@ListID attribute is not applied, the method creates a new SPWorkflowAssociation object on the Windows SharePoint Services 3.0 Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.associateworkflowmarkup(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
configUrl	The Web-relative URL for the configuration file in the configuration file format.	String	/	UTF-8
configVersion	The version number of the configuration file in the format NNNN.NNNN.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	An "Error" or "Success" message. A "Success" message contains the GUID of the new SPWorkflowAssociation.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-convert-web-part-format>

Convert Web Part Format

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.convertwebpartformat(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
inputFormat	Input Format	String	/	UTF-8
formatConversionOption	Format Conversion Option	FormatConversionOption	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-delete-web-part>

Deletes a dynamic Web Part from a Web Part Page.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.deletewebpart(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
pageUrl	A string containing the URL of the page containing the Web Part.	String	/	UTF-8
storageKey	A GUID that identifies of the Web Part.	String	/	UTF-8
storage	A Storage value indicating how the Web Part was stored.	Storage	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-execute-proxy-updates>

Execute Proxy Updates

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.executeproxyupdates(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
updateData	#[payload]	Optional. Update Data	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-fetch-legal-workflow-actions>

Returns a string version of the actions file, as defined by the Actions File Schema

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.fetchlegalworkflowactions(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	Returns the actions file as a string.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-assembly-meta-data>

Get Assembly Metadata

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getassemblymetadata(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
assemblyName	Name of the assembly for which metadata is retrieved	String	/	UTF-8
baseTypes	Base Types	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-binding-resource-data>

Get Binding Resource Data

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getbindingresourcedata(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
resourceName	#[payload]	Optional. Resource Name	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-custom-control-list>

Get Custom Control List

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getcustomcontrollist(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetCustomControlListResponse.GetCustomControlListResult	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-data-from-data-source-control>

Get Data From Data Source Control

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getdatafromdatasourcecontrol(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
dscXml	Dsc Xml	String	/	UTF-8
contextUrl	Context Url	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-expanded-list-view-xml>

Get Expanded List View Xml

API link: http://msdn.microsoft.com/en-us/library/ee658354(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
webId	Web Id	String	/	UTF-8
listViewXml	List View Xml	String	/	UTF-8
listGuid	List Guid	String	/	UTF-8
listUrl	List Url	String	/	UTF-8
listDisplayName	List Display Name	String	/	UTF-8
hasConnection	Has Connection	Boolean	/
partialView	Partial View	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-form-capability-from-data-source-control>

Get Form Capability From Data Source Control

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getformcapabilityfromdatasourcecontrol(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
dscXml	#[payload]	Optional. Dsc Xml	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-safe-assembly-info>

Get Safe Assembly Info

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getsafeassemblyinfo(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetSafeAssemblyInfoResponse.GetSafeAssemblyInfoResult	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-web-part>

Returns the XML data for a dynamic Web Part.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpart(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
pageurl	A string containing the URL of the page containing the Web Part	String	/	UTF-8
storageKey	A GUID that identifies the Web Part	String	/	UTF-8
storage	A Storage value indicating how the Web Part is stored	Storage	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string containing the XML for a Web Part to include the type and assembly name fields.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-web-part2>

Returns the XML data for a dynamic Web Part.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpart2(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
pageurl	A string containing the URL of the page containing the Web Part	String	/	UTF-8
storageKey	A GUID that identifies the Web Part	String	/	UTF-8
storage	A Storage value indicating how the Web Part is stored	Storage	/
behavior	An SPWebServiceBehavior enumeration object indicating whether the client supports Windows SharePoint Services 2.0 or Windows SharePoint Services 3.0.	SPWebServiceBehavior	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string containing the XML for a Web Part to include the type and assembly name fields.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-web-part-cross-page-compatibility>

Returns connection information for all parts on the target page and compatibility information of the source Web Part with all the parts on a target page, which is used to determine whether Web Parts on two different pages are compatible with each other.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartcrosspagecompatibility(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
sourcePageUrl	The URL of the source page.	String	/	UTF-8
sourcePageContents	A string containing the source of the .aspx source Web page.	String	/	UTF-8
targetPageUrl	The URL of the target page.	String	/	UTF-8
targetPageContents	A string containing the source of the .aspx target Web page.	String	/	UTF-8
providerPartID	A string containing the identifier of a part that resides on the source page.	String	/	UTF-8
lcid	A locale identifier for locale-specific properties.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that contains the compatibility information of the providerPartID with all the parts on the target page, along with group and interface information for all the parts on the target page. This string is an XML data island.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-web-part-page>

Get Web Part Page

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartpage(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
documentName	The name of the Web Part Page.	String	/	UTF-8
behavior	An SPWebServiceBehavior enumeration object indicating whether the client supports Windows SharePoint Services 2.0 or Windows SharePoint Services 3.0.	SPWebServiceBehavior	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-web-part-page-connection-info>

Returns connection information for all parts on the same page as well as compatibility results for the provider part with other parts on the same page.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartpageconnectioninfo(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
sourcePageUrl	The URL of the source page.	String	/	UTF-8
sourcePageContents	A string containing the source of the .aspx source Web page.	String	/	UTF-8
providerPartID	A string containing the identifier of a part that resides on the source page.	String	/	UTF-8
lcid	A locale identifier for locale-specific properties.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that contains the group and interface information for all parts on the same page as well as compatibility results for the provider part with other parts on the same page. This string is an XML data island.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-web-part-page-document>

Returns the Web Part Page, complete with the Web Parts and the properties included within each Web Part zone.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartpagedocument(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
documentName	#[payload]	Optional. The name of the Web Part Page.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that contains the Web Part Page and associated Web Parts and properties.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-web-part-properties>

Returns an XML string of all Web Parts associated with a Web Part Page.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartproperties(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
pageUrl	The URL of the page containing the Web Part.	String	/	UTF-8
storage	A Storage value indicating how the Web Part is stored.	Storage	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetWebPartPropertiesResponse.GetWebPartPropertiesResult	SoapXmlElement XML string for all the Web Parts on a Web Part Page. This includes the GUIDs, Web Part properties and their values, and Web Part previews in HTML.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-web-part-properties2>

Returns an XML string of all Web Parts associated with a Web Part Page.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getwebpartproperties2(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
pageUrl	The URL of the page containing the Web Part.	String	/	UTF-8
storage	A Storage value indicating how the Web Part is stored.	Storage	/
behavior	An SPWebServiceBehavior enumeration object indicating whether the client supports Windows SharePoint Services 2.0 or Windows SharePoint Services 3.0.	SPWebServiceBehavior	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetWebPartProperties2Response.GetWebPartProperties2Result	SoapXmlElement XML string for all the Web Parts on a Web Part Page. This includes the GUIDs, Web Part properties and their values, and Web Part previews in HTML.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-get-xml-data-from-data-source>

Returns XML data from the data source provider.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.getxmldatafromdatasource(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
queryXml	#[payload]	Optional. A string containing the information to query the data source.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that contains the XML results of the query.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-remove-workflow-association>

Removes all SPWorkflowAssociation objects on the list defined by the /WorkflowConfig/Association/@ListID value in the configuration file.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.removeworkflowassociation(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
configUrl	Web-relative URL to the configuration file.	String	/	UTF-8
configVersion	Version of the configuration file to be used.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-render-web-part-for-edit>

Returns an XML fragment that includes the Web Part property information and the rendering HTML.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.renderwebpartforedit(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
webPartXml	#[payload]	Optional. A string containing the Web Part XML data.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that represents an XML fragment containing the Web Part property information and the rendering HTML.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-save-web-part>

Saves changes to an existing dynamic Web Part.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.savewebpart(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
pageUrl	The URL of the source page.	String	/	UTF-8
storageKey	A GUID that identifies the Web Part	String	/	UTF-8
webPartXml	A string containing the XML information on the Web Part.	String	/	UTF-8
storage	A Storage value indicating how the Web Part is stored	Storage	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-save-web-part2>

Saves changes to an existing dynamic Web Part, including a change to the Web Part type.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.savewebpart2(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
pageUrl	The URL of the source page.	String	/	UTF-8
storageKey	A GUID that identifies the Web Part.	String	/	UTF-8
webPartXml	A string containing the XML information on the Web Part.	String	/	UTF-8
storage	A Storage value indicating how the Web Part is stored	Storage	/
allowTypeChange	True to allow saving the Web Part as a different type; otherwise, false.	boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webpart-validate-workflow-markup-and-create-support-objects>

Creates a workflow task list, if one is not specified, or if the specified task list does not exist in the context Web site; also updates content types on the task list.

API link: http://msdn.microsoft.com/en-us/library/websvcwebpartpages.webpartpageswebservice.validateworkflowmarkupandcreatesupportobjects(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workflowMarkupText	XML that represents the definition of the workflow schedule; the format for this XML is the XOML format, as defined in Windows Workflow Foundations.	String	/	UTF-8
rulesText	XML that represents the definition of the conditional logic for a workflow schedule; the format for this XML is the RULES format, as defined in Windows Workflow Foundations.	String	/	UTF-8
configBlob	XML that represents the support objects necessary to be created or modified as a result of this action.	String	/	UTF-8
flag	Specifies whether to create the support objects. If set to 1 the method only do validation; if set to 2 to do validation and create the support objects, and all other values are disallowed.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	Returns an XML fragment in the following: `<Success> <TaskList ID="TaskListID"/> </Success>`

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-create-content-type>

Creates a new site content type, with the specified columns and properties, on the site.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.createcontenttype(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
displayName	A string that represents the display name of the new site content type.	String	/	UTF-8
parentType	A string that represents the content type ID of the parent content type on which to base the new site content type.	String	/	UTF-8
newFields	A string that represents the collection of columns to include on the new site content type. Format the column collection as a FieldRefs Element (ContentType) element, where each FieldRef Element (ContentType) child element represents a reference to an existing column to include on the content type.	CreateContentType.NewFields	/
contentTypeProperties	A string that represents the properties to specify for the new site content type. Format the properties as a ContentType Element (ContentType) element, and include the element attributes for the properties you want to specify.	CreateContentType.ContentTypeProperties	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	Returns the content type ID of the new site content type.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-customize-css>

Applies style sheet customization to a particular file.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.customizecss(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cssFile	#[payload]	Optional. The CSS file	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-delete-content-type>

Deletes the specified site content type from the site.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.deletecontenttype(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contentTypeId	#[payload]	Optional. A string that represents the content type ID of the site content type to delete.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
DeleteContentTypeResponse.DeleteContentTypeResult	A string, in the following format, indicating that the method succeeded. `<Success xmlns="http://schemas.microsoft.com/sharepoint/soap/"/>`

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-get-activated-features>

Returns a list of Features that are activated in the Web site and in its parent site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getactivatedfeatures(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string consisting of two comma-delimited parts, one that contains the IDs of Features that are activated in the site collection, and the other that contains the IDs of Features that are activated in the Web site.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-get-all-sub-web-collection>

Returns the titles and URLs of all sites within the current site collection.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getallsubwebcollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetAllSubWebCollectionResponse.GetAllSubWebCollectionResult	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-get-columns>

Returns a collection of the column definitions for the columns available on the site.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getcolumns(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetColumnsResponse.GetColumnsResult

An XML fragment in the form of a Fields Element (List) element that can be assigned to a System.Xml.XmlNode object.

 <Fields>
  <Field ID="{BA934502-D68D-4960-A54B-51E15FEF5FD3" 
    Name="ManagersName" 
    DisplayName="Manager's Name" 
    Group="Core Contact and Calendar Columns" 
    Type="Text" Sealed="TRUE" 
    AllowDeletion="TRUE" 
    xmlns="http://schemas.microsoft.com/sharepoint/soap/" />
  

 }

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-get-content-type>

Returns the content type definition for the specified site content type.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getcontenttype(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
contentTypeId	#[payload]	Optional. A string that represents the content type ID of the site content type.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetContentTypeResponse.GetContentTypeResult

An XML fragment in the form of a ContentType Element (ContentType) element that can be assigned to a System.Xml.XmlNode object. The following example return value is edited for clarity.

 <ContentType 
    ID="0x010100C78DE4D7C0C57C43AF878D28256599CA" 
    Name="NewContentType" 
    Group="Custom Content Types" 
    Description="Create a new document." 
    Version="1" 
    xmlns="http://schemas.microsoft.com/sharepoint/soap/">
  <Folder TargetName="Forms/NewContentType" />
  <Fields>
   …
  <DocumentTemplate TargetName="Forms/NewContentType/template.doc" />
  <XmlDocuments>
    …
  </XmlDocuments>
</ContentType>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-get-content-types>

Returns a collection of content type definitions for all site content types on the specified site.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getcontenttypes(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetContentTypesResponse.GetContentTypesResult

An XML fragment in the following form

 <ContentTypes xmlns="http://schemas.microsoft.com/sharepoint/soap/">
  <ContentType 
      ID="0x010100C78DE4D7C0C57C43AF878D28256599CA" 
      Name="NewContentType" 
      Group="Custom Content Types" 
      Description="Create a new document." 
      Version="1" 
      xmlns="http://schemas.microsoft.com/sharepoint/soap/">
    <Folder TargetName="Forms/NewContentType" />
    <Fields>
     …
    <DocumentTemplate TargetName="Forms/NewContentType/template.doc" />
    <XmlDocuments>
      …
    </XmlDocuments>
  </ContentType>
  <ContentType 
    …
  </ContentType>
</ContentTypes>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-get-customized-page-status>

Gets the customization (also known as "ghosted") status of the file with the specified URL.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getcustomizedpagestatus(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
fileUrl	#[payload]	Optional. The File Url	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
CustomizedPageStatus	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-get-list-templates>

Returns the collection of list template definitions for the current site.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getlisttemplates(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetListTemplatesResponse.GetListTemplatesResult

A fragment in Collaborative Application Markup Language (CAML) in the following form

 <ListTemplates xmlns="http://schemas.microsoft.com/sharepoint/soap/">
   <ListTemplate Name="custlist" DisplayName="Custom List" Type="100" 
      BaseType="0" OnQuickLaunch="TRUE" 
      SecurityBits="11" Description="Create a custom list when you want 
      to specify your own columns. The list opens as a Web page and 
      lets you add or edit items one at a time." 
      Image="/_layouts/images/itgen.gif" />
   <ListTemplate Name="gridlist" DisplayName="Custom List in 
      Datasheet View" Type="120" BaseType="0" 
      OnQuickLaunch="TRUE" SecurityBits="11" Description="Create a 
      custom list when you want to specify your own columns. The list 
      opens in a spreadsheet-like environment for convenient data 
      entry, editing, and formatting. It requires a Windows SharePoint 
      Services-compatible list datasheet control and ActiveX 
      control support." Image="/_layouts/images/itdatash.gif" />
   <ListTemplate Name="doclib" DisplayName="Document Library" 
      Type="101" BaseType="1" 
      OnQuickLaunch="TRUE" SecurityBits="11" Description="Create a 
      document library when you have a collection of documents or other 
      files that you want to share. Document libraries support features 
      such as subfolders, file versioning, and check-in/check-out." 
      Image="/_layouts/images/itdl.gif" DocumentTemplate="101" />
      .
      .
      .
</ListTemplates>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-get-object-id-from-url>

Get Object Id From Url

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getobjectidfromurl(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
objectUrl	#[payload]	Optional. Object Url	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetObjectIdFromUrlResponse.GetObjectIdFromUrlResult	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-get-web>

Returns properties of a site (for example, name, description, and theme).

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getweb(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
webUrl	#[payload]	Optional. A string that contains the absolute URL of the site. To return information about the current site, a period (".") can be passed as the value of this parameter.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
GetWebResponse.GetWebResult	An XML fragment in the following form `<Web Title="Site_Name" Url= "http://Server_Name/sites/Site_Name/Subsite_Name" Description="Description" Language="1033" Theme="Theme" xmlns="http://schemas.microsoft.com/sharepoint/soap/" />`

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-get-web-collection>

Returns the titles and URLs of all sites directly beneath the current site.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.getwebcollection(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type Description

GetWebCollectionResponse.GetWebCollectionResult

An XML fragment in the following form

 <Webs xmlns="http://schemas.microsoft.com/sharepoint/soap/">
   <Web Title="Subsite1_Name" Url="http://Server_Name/[sites]/
      [Site_Name]/[Subsite1]" />
   <Web Title="Subsite2_Name" Url="http://Server_Name/[sites]/
      [Site_Name]/[Subsite2]" />
</Webs>

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-remove-content-type-xml-document>

Removes the specified XmlDocument Element (ContentType) element from the specified site content type.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.removecontenttypexmldocument(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
contentTypeId	A string that represents the content type ID for the site content type.	String	/	UTF-8
documentUri	A string that represents the URI of the XMLDocument element to remove.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
RemoveContentTypeXmlDocumentResponse.RemoveContentTypeXmlDocumentResult	A string, in the following format, indicating that the method succeeded. `<Success xmlns="http://schemas.microsoft.com/sharepoint/soap/"/>`

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-revert-all-file-content-streams>

Reverts the content streams of all files within the Web site.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.revertallfilecontentstreams(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-revert-css>

Reverts style sheet customization of a file to the default style sheet.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.revertcss(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
cssFile	#[payload]	Optional. The Css File	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-revert-file-content-stream>

Reverts the content stream of the file with the specified URL.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.revertfilecontentstream(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
fileUrl	#[payload]	Optional. File Url	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-update-columns>

Creates, updates, or deletes one or more columns on the specified site.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.updatecolumns(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
newFields	A string that represents the collection of columns to create on the site. Format the column collection as a Fields Element (List) element, where each Field Element (List) child element defines a column to create on the site.	UpdateColumns.NewFields	/
updateFields	A string that represents the collection of columns to update on the site. Format the column collection as a Fields Element (List) element, where each Field Element (List) child element defines a column to include on the site. In each Field Element (List) child element, include the element attributes for the column properties you want to update.	UpdateColumns.UpdateFields	/
deleteFields	A string that represents the collection of columns to delete from the site. Format the column collection as a Fields Element (List) element, where each Field Element (List) child element defines a column to delete from the site. In each Field Element (List) child element, include the ID attributes for the column you want to delete.	UpdateColumns.DeleteFields	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
UpdateColumnsResponse.UpdateColumnsResult	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-update-content-type>

Updates the specified site content type.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.updatecontenttype(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
contentTypeId	A string that represents the content type ID of the site content type to update.	String	/	UTF-8
contentTypeProperties	A string that represents the properties to update on the site content type. Format the properties as a ContentType Element (ContentType) element, and include the element attributes for the properties you want to update.	UpdateContentType.ContentTypeProperties	/
newFields	A string that represents the collection of columns to add to the site content type. Format the column collection as a FieldRefs Element (ContentType) element, where each FieldRef Element (ContentType) child element references a site column to add to the site content type.	UpdateContentType.NewFields	/
updateFields	A string that represents the collection of columns to update on the site. Format the column collection as a FieldRefs Element (ContentType) element, where each FieldRef Element (ContentType) child element references a column to update on the site content type. In each FieldRef Element (ContentType) child element, include the element attributes for the column properties you want to update.	UpdateContentType.UpdateFields	/
deleteFields	A string that represents the collection of columns to delete from the site content type. Format the column collection as a FieldRefs Element (ContentType) element, where each FieldRef Element (ContentType) child element references a column to delete from the site content type. In each FieldRef Element (ContentType) child element, include the ID attributes for the column you want to delete.	UpdateContentType.DeleteFields	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
UpdateContentTypeResponse.UpdateContentTypeResult	The result of the operation

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-update-content-type-xml-document>

Adds or overwrites the specified XmlDocument Element (ContentType) element in the site content type.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.updatecontenttypexmldocument(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
contentTypeId	A string that represents the content type ID of the site content type.	String	/	UTF-8
newDocument	A string that represents the XML document to replace the existing XML document.	UpdateContentTypeXmlDocument.NewDocument	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username	Optional. Username	String	/	UTF-8
password	Optional. Password	String	/	UTF-8
serverUrl	Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
UpdateContentTypeXmlDocumentResponse.UpdateContentTypeXmlDocumentResult	A string, in the following format, indicating that the method succeeded. `<Success xmlns="http://schemas.microsoft.com/sharepoint/soap/"/>`

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error

<sharepoint:webs-web-url-from-page-url>

Returns the URL of the parent site for the specified page URL.

API link: http://msdn.microsoft.com/en-us/library/websvcwebs.webs.weburlfrompageurl(v=office.14).aspx

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
pageUrl	#[payload]	Optional. A string that contains the absolute URL of the page.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
username		Optional. Username	String	/	UTF-8
password		Optional. Password	String	/	UTF-8
serverUrl		Optional. Server url	String	/	UTF-8

Returns

Return Type	Description
String	A string that contains the site URL.

Exception Payloads

Payload Class	Description
SharepointRuntimeException	If something goes wrong this exception is throwed with a description of the error