Edit

Share via

Method element (View)

  • 06/29/2022

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Used in batch processing to specify commands within the Batch element.

<Method ID="Text"
  Cmd = "Text"
  ID = "Text">
</Method>

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute Description
Cmd
Optional Text. Used in Web services to specify the command to post to the server for updating list items. Possible values include the following:
- Delete: Delete the specified item.
- New: Create the specified item.
- Update: Modify the specified item.
ID
Required Text. A freeform identification string that is not actually used by the server but that is returned to the client.

Child elements

Parent elements

Occurrences

  • Minimum: 1
  • Maximum: Unbounded

Remarks

The Method element is required for the Batch element, which is embedded within HTTP protocol and allows the client application to post more than one command at a time to the server.

In operations where the SetVar element is used within the Method element to post commands, the Cmd attribute can contain methods in the Windows SharePoint Services RPC Protocol protocol.

When used with the UpdateListItems method of the Lists Web service, each Method element contains Field elements that specify the column values for each item being updated.

Example

The following example uses the Method element to post the remote procedure call (RPC) ExportList command and return the schema of a specified list.

<Batch OnError="Return">
  <Method ID="0,ExportList">
    <SetList Scope="Request">EF2F5A21-0FD0-4654-84ED-
        112B4F5A48F8</SetList>
    <SetVar Name="Cmd">ExportList</SetVar>
  </Method>
</Batch>