Using the MS SharePoint Retrieve Lists Activity

Use the Retrieve Lists activity to retrieve list properties from MS SharePoint.

About this task

Use this task to retrieve list properties 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

  1. Right click the Orchestrations section and select new orchestration.
  2. Drag the newly created MS SharePoint endpoint to the orchestration and select Retrieve Lists activity. The Retrieve Lists activity will be added to the orchestration. Double click the activity. The MS SharePoint Retrieve Lists Checklist is displayed.
  3. In the Checklist, click Retry. Review the default settings and make the required changes.
  4. 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.
  5. Create a map between the orchestration variables and the input parameter of the activity.
    Mandatory Fields:
    • retrieveType (Valid values are ALL and SPECIFIC)
    • retrieveListBy (Valid values are LIST_ID and LIST_TITLE)
    • listId (Required if retrieveType is given as SPECIFIC and retrieveListBy as LIST_ID)
    • listTitle (Required if retrieveType is given as SPECIFIC and retrieveListBy as LIST_TITLE)

    Sample Input Request

    <?xml version="1.0" encoding="UTF-8"?>
    <RetrieveList xmlns="http://www.IBM.com/xmlns/prod/websphere/j2ca/Sharepoint/retrievelist">
    <!--1.	retrieveType value as ALL-->
    
    <RetrieveListRequestDetails xmlns="">
    <retrieveType>ALL</retrieveType>
    </RetrieveListRequestDetails>
    
    
    <!--2.	retrieveType value as SPECIFIC and retrieveListBy as LIST_TITLE-->
         <RetrieveListRequestDetails xmlns="">
            <retrieveType>SPECIFIC</retrieveType>
            <retrieveListBy>LIST_TITLE</retrieveListBy>
            <listTitle>List103</listTitle>
         </RetrieveListRequestDetails>
    
    
    <!--3.	retrieveType value as SPECIFIC and retrieveListBy as LIST_ID-->
         <RetrieveListRequestDetails xmlns="">
            <retrieveType>SPECIFIC</retrieveType>
            <retrieveListBy>LIST_ID</retrieveListBy>
            <listId>efb347bd-2b4f-4859-b67c-80c7e60ed8fa</listId>
         </RetrieveListRequestDetails>
      </RetrieveList>
    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.
  6. 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.
  7. Create a map between the output parameters and orchestration variables.

Results

You have configured the MS SharePoint Retrieve Lists activity.
Note:

You can retrieve properties of multiple lists at one go using this activity since the input variable is unbounded.

Limitation:

ExpandChildren option in retrieve Lists activity is not working for SharePoint On-Premise. This is the known API behaviour for SharePoint On-Premise.




Feedback | Notices


Timestamp icon Last updated: Monday, 6 March 2017


http://pic.dhe.ibm.com/infocenter/wci/v7r0m0/topic/com.ibm.wci.doc/MSSharePoint_retrieve_list_activity.html