Query Lists

This property is used to specify XML to select the lists you want to have returned. There are two ways to use Query Lists, depending on what you want to achieve.

•      If you want to retrieve data from specific named lists that exist on the same site as the Site List Data Provider, simply type the name of the list from which you want to retrieve data. This allows you to specify exactly the lists/libraries you want to work with.

o  If you want to query multiple lists, type each list name separated by a comma.

o  If the named list(s) does not exist on the same site as the Site List Data Provider, it will use your query columns as a schema and return data from any lists in the current site that include those columns.

•      If you want to retrieve data from all lists of a particular type, regardless of how the lists are named, use an XML  block like this example: 

<Lists BaseType="1" MaxListLimit="0"/>

The parameters that can be used in this case are Attributes, List Sub Element, and WithIndex Sub Element, described below.

Attributes

•      ServerTemplate – Limits the query to lists of the specified server template.

•      BaseType – Limits the query to lists of a specified base type.

o  0 – Generic List

o  1 – Document Library

o  3 – Discussion Forum

o  4 – Vote or Survey

o  5 – Issues List

•      Hidden – Determines if lists that are hidden are returned. (Options: TRUE/FALSE)

•      MaxListLimit – Controls the maximum amount of lists queried. If set to 0, then no limit is specified. The default is 1000.

List Sub Element

If you would like to return specific lists, use <List ID=""/> for each list to be returned. A maximum of 10 may be consumed in this way. The ID should be identified in all capital letters.

The easiest way to determine the list ID is to go to the list’s settings that you want to pull from and locate the ID in the URL, as shown here:

Example:

<Lists>

 <List ID="7A9FDBE6-0841-430a-8D9A-53355801B5D5" />

 <List ID="3D18F506-FCA1-451e-B645-2D720DC84FD8" />

</Lists>

WithIndex Sub Element

If you would like to only return lists that have a specific index field, specify each index field within the Lists elements.

•      FieldID – The ID of the field

•      Type – Type of field (Must be "Text")

•      Value – Value the field should contain.

Example:

 <WithIndex FieldId="D4819257-6B69-41F1-82C8-A91615BFF500" Type="Text" Value="Complete" />