This topic has not yet been rated - Rate this topic

Batch Element (View)

Published: May 2010

Provides batch processing of commands within HTTP protocol.


<Batch
  OnError = "Return" | "Continue"
  ListVersion = ""
  Version = ""
  ViewName = "">
  <Method>
  ...
  </Method>
  ...
</Batch>

Attribute

Description

ListVersion

Optional Integer. Specifies the version number of the list.

OnError

Optional. The following values are possible:

  • Return — Stops execution of any more methods after the first error is encountered. This is the default.

  • Continue — After an error is encountered, continues executing subsequent methods.

Version

Optional String. Specifies the version number of Microsoft SharePoint Foundation that is running on the server. A version number consists of four integers in the format N.N.N.NNNN, which represent the major, minor, phase, and incremental versions of the product.

ViewName

Optional Guid. Specifies the GUID for the view.

Minimum: 0

Maximum: 1

The Batch element must contain at least one Method element. The Batch element allows the client application to post more than one command to the server at a time.

The following code example, if contained within HTTP protocol, would return a list named "Documents" from the server.

<?xml version="1.0" encoding="UTF-8"?>
<ows:Batch Version="6.0.2.5608" OnError="Return">
  <Method ID="0,ExportList">
    <SetList Scope="Request">Documents</SetList>
    <SetVar Name="Cmd">ExportList</SetVar>
  </Method> 
</ows:Batch>

Date

Description

Reason

May 2010

Initial publication

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Batch element also accepts 'DateInUtc' attribute.
Batch element also accepts 'DateInUtc' attribute. $0$0 $0 $0ex.$0 $0 $0<UpdateListItems xmlns="http://schemas.microsoft.com/sharepoint/soap/">$0 $0    <listName>name_of_list</listName>$0 $0    <updates>$0 $0        <Batch xmlns="" OnError="Return" DateInUtc="True">$0 $0            <Method ID="1" Cmd="Update">$0 $0                <Field Name="field_name">field_value</Field>$0 $0 $0            </Method>$0 $0        </Batch>$0 $0    </updates>$0 $0</UpdateListItems>$0 $0 $0