SharePoint REST Select ListItem

The SharePoint REST Select ListItem activity not only supports selecting list items from a specific Microsoft SharePoint list using different query conditions.

The SharePoint REST Select ListItem activity is always used with the SharePoint REST Update ListItem activity and the SharePoint REST Delete ListItem activity. The purpose of the SharePoint REST Select ListItem activity is to serve as a helper for the update and delete operations when you do not know the ID of the item that you want to update or delete.

The SharePoint REST Select ListItem activity can also be used to look up the format of the input value when you use the SharePoint REST Add ListItem and SharePoint REST Update ListItem activities to add or update list items.

Note: This activity does not support selecting list items across different SharePoint lists. Additionally, you cannot select list items by using content types for the following Microsoft SharePoint lists: Agenda, Objectives, Decisions, Categories, Directions, Things to Bring, and Survey List.

General

On the General tab, you can establish a connection to a Microsoft SharePoint server, specify the list item that you want to select, and set the Timeout time for calling the process.

The following table lists the configurations on the General tab of the SharePoint REST Select ListItem activity:

Field Module Property? Description
Name No (Required) Specify the name to be displayed as the label for the activity in the process. The default value is SharePointRESTSelectListItem.
SharePoint REST Connection Yes (Required) Click the icon to select a SharePoint REST connection.

If no matching SharePoint REST Connection shared resources are found, click Create Shared Resource to create one. See Creating a SharePoint REST Connection for more details.

Web Name No (Required) Get the target website.

Click Fetch Webs to get available websites from the site collection specified in the SharePoint REST Connection shared resource.

List Name No (Required) Get the list that you want to operate on.

Click Fetch Lists to get available lists from the site selected in the Web Name field.

CAML Source No (Required) Specify the query schema of Collaborative Application Markup Language (CAML). The following options of the CAML source are available:

  • Simple CAML: supports the Contains and Eq queries. After you provide values for the list item in the Input tab, the activity uses the non-empty values to do the searching.

    If the input value is Text, Note, URL, Choice, or Multi choice data Type, the query are generated as a Contains query. Others are generated as an Eq query. See Input Guidelines for more details about these Microsoft SharePoint data types.

  • Input CAML: supports typing a CAML query directly in the CAMLText field in the Input tab. The root node of the query must be Query.
    Note: CAML is an XML-based language that is used in Microsoft SharePoint Foundation to define the fields and views that are used in sites and lists. See http://msdn.microsoft.com/en-us/library/ms426449.aspx for details about CAML.

Page Size Yes (Required) Specify the maximum numbers of list items that can be queried at once. The default value is 0 , which returns all the results.
Timeout(sec) Yes (Required) Specify how long the plug-in waits for the process to perform the select operation. The default value is 120.
Note: The select operation might fail or succeed if it times out when started at run time. The result is undefined. You have to provide enough time for the select operation to perform.

Description

On the Description tab, you can enter a short description for the SharePoint REST Select ListItem activity.

Input

On the Input tab, you can specify the list item that you want to select.

The following table lists the input elements on the Input tab of the SharePoint REST Select ListItem activity:

Input Item Data Type Description
FieldValues N/A The attributes of the selected item. It varies depending on the list. See Input Guidelines for details about how to provide a valid input. The input item only is displayed when you select Simple CAML as the CAML source.
Note: When the activity uses the recipient field to select a list item, the activity only supports typing a single value in this input item each time.
CAMLText String The CAML query. You can manually type in a query or you can use the generated query from the previous activity in the current process. The input item only is displayed when you select Input CAML as the CAML source.
Note: The root node of the CAML query must be Query.

Output

On the Output tab, you can view all returned query results.

The following table lists the output elements on the Output tab of the SharePoint REST Select ListItem activity:

Output Item Data Type Description
ResultCount Integer The number of results returned by the query.
Source   String The mode of the query.
Results
Item N/A The attributes of the queried item. It varies depending on different content types. For the meaning of each attribute, see the Microsoft SharePoint documentation for more details.

Fault

On the Fault tab, you can find the error code and error messages of the SharePoint REST Select ListItem activity. See Error Codes for more detailed explanation of errors.

The following table lists error schema elements on the Fault tab of the SharePoint REST Select ListItem activity:

Error Schema Element Data Type Description
SharePointRestPluginException
msg String Displays the error message returned by the plug-in.
msgCode String Displays the error code returned by the plug-in.
SharePointRestRemoteException
msg String Displays the error message of the Microsoft SharePoint system when processing a request from the plug-in.
msgcode String Displays the error code of the Microsoft SharePoint system when processing a request from the plug-in.
encoding String Displays the error encoding of the Microsoft SharePoint system when processing a request from the plug-in.
ActivityTimedOutException
msg String Displays the error message when the Select ListItem operation times out.
msgcode String Displays the error code when the Select ListItem operation times out.