Back to Microsoft SharePoint Integrations
Handler · Version 1

Sharepoint List Retrieve

Download GitHub


This handler makes a SOAP call (using Savon) to the SharePoint Web Services to get the contents of a list from a specific SharePoint site. As long as the user has sufficient privileges, the first call to SharePoint returns a hash containing all of the Site lists and their details. The handler then uses that list to get the correct list id that corresponds with the list title given during input and then makes another SOAP call to get the the list contents which are returned in a hash. The handler then takes that response, cleans up the hash, and then converts it to a JSON table to allow for easy access of the information. Any errors that occur during this process will be caught and re-raised by the handler. Authentication is done through SSL, so the SharePoint site being accessed needs to be setup to allow SSL connections.

  • Make sure the SharePoint Web Services database is turned on.

How to Obtain the Homepage URL Info Value

To find the homepage url, all you have to do is look at the URL of any page on the SharePoint site. The url that should be inputted should contain both the base url (the top-most site in the collection) and the sub-site that you are on. For example, given the following URL: The base site is "", the sub-site is "development" and the 'HomePage URL' task info values should be set to:

Name Description Sample
username The username of the Sharepoint account.
password The password of the Sharepoint account. *********
domain The domain of the Sharepoint server where the information will be pulled from.
self-signed_cert If the Certificate that you are using for verification is self-signed, then input 'true'. If it is not, input 'false'.
homepage_url The url for the homepage of the Sharepoint site that this handler will have access to.
enable_debug_logging Enable debug logging if the value is set to 'Yes'. No
Name Description Sample
List Name The name of the list that should be retrieved. Tasks
Name Description
JSON A JSON table that returns all of the lists on the specified site, with information such as Title, Description, ID, etc. for each list. For an example of the results, please see the 'Sample Results String' section below.

SharepointListRetrieve_V1 (2012-07-16)

  • Initial version. See README for details.
Download GitHub

On This Page

Looking for a workflow engine? Learn more about the Kinetic Data Enterprise Workflow Platform. Check it out
Return to Top