Using the MS SharePoint Delete Lists Activity

Use the Delete Lists activity to delete lists in MS SharePoint.

About this task

Use this task to delete lists in 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 Delete Lists activity. The Delete Lists activity will be added to the orchestration. Double click the activity. The MS SharePoint Delete 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:
    • deleteType (Allowed value are Permanent or Recycle Bin)
    • deleteBy (Valid values are LIST_ID and LIST_TITLE)
    • listId (If deleteBy is given as LIST_ID)
    • listTitle(If deleteBy is given as LIST_TITLE)

    Sample Input Request

    <?xml version="1.0" encoding="UTF-8"?>
    <DeleteList xmlns="http://www.IBM.com/xmlns/prod/websphere/j2ca/Sharepoint/deletelist">
    
    <!-- 1.	deleteType value as Permanent , deleteBy as LIST_TITLE -->
         <DeleteListRequestDetails xmlns="">
            <deleteType>Permanent</deleteType>
            <deleteBy>LIST_TITLE</deleteBy>
            <listTitle>Test List2</listTitle>
         </DeleteListRequestDetails>
    
    <!-- 2.	deleteType value as Recycle Bin , deleteBy as LIST_ID-->
         <DeleteListRequestDetails xmlns="">
            <deleteType> Recycle Bin</deleteType>
            <deleteBy>LIST_ID</deleteBy>
            <listId>087176c2-a1b9-4c97-b7fd-17787d6797de</listId>
         </DeleteListRequestDetails>
      </DeleteList>
    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 Delete Lists activity.
Note:

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




Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/MSSharePoint_delete_list_activity.html