Use the Retrieve List Items activity to retrieve list item properties for existing lists
from MS SharePoint.
About this task
Use this task to retrieve the Item properties for existing lists from MS SharePoint instance. The
call to this activity is a synchronous call where the input data is sent to the activity for
processing and the response is sent back to the orchestration.
Procedure
- Right click the Orchestrations section and select new orchestration.
- Drag the newly created MS SharePoint endpoint to the orchestration and select
Retrieve List Items activity. The Retrieve List Items activity will be added to the
orchestration. Double click the activity. The MS SharePoint Retrieve List Items
Checklist is displayed.
- In the Checklist, click Retry. Review the default settings and make the
required changes.
- In the Checklist, click Configure. Click
Browse. The List Selection Dialogue is displayed with Lists of only supported
base templates which includes base template id as 100, 105 and 120. Select a List and Click
OK.
- Select the Map Inputs in the Checklist. The XML
Schemas generated from that operation are displayed as nodes under the request input parameter in
the To Activity panel.
- Create a map between the orchestration variables and the input parameter of the activity.
Mandatory Fields:
- retrieveType (Allowed values are SPECIFIC or ALL)
- itemId (Required if retrieveType is given as SPECIFIC)
Sample Input Request
<?xml version="1.0" encoding="UTF-8"?>
<RetrieveListItems xmlns="http://www.IBM.com/xmlns/prod/websphere/j2ca/Sharepoint/retrievelistitems">
<!-- 1. retrieveType value as ALL -->
<RetrieveListItemsRequestDetails xmlns="">
<retrieveType>ALL</retrieveType>
</RetrieveListItemsRequestDetails>
<!-- 2. retrieveType value as SPECIFIC and valid value for itemId-->
<RetrieveListItemsRequestDetails xmlns="">
<retrieveType>SPECIFIC</retrieveType>
<itemId>1</itemId>
</RetrieveListItemsRequestDetails>
</RetrieveListItems>
Note: Values must be provided at run time for the mandatory elements of the input structure. A
value can be provided by specifying a default value for element or by linking the element with an
input node. During run time if no value is provided for a mandatory element, the activity throws an
exception, which is reported by the Web Management Console. If a value is not provided at run time
for an optional input parameter, no exception is thrown during run time.
- Select the Map Outputs in the Checklist. The XML
Schema generated to hold the response of the activity is displayed as nodes under the response
output parameter in the From Activity panel.
- Create a map between the output parameters and orchestration variables.
Results
You have configured the MS SharePoint Retrieve List Items activity.
Note: - You can retrieve properties of multiple list Items at one go using this activity since the input
variable is unbounded.
- You can fetch the choice element data if it is available for the list item. Also you can use the
“Multiple choice fields” in the filter parameters.