Share via

Batch Element

  • Article

The Batch element provides batch processing of commands within HTTP protocol.

Syntax

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

Attributes

Name 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 Windows SharePoint Services 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 phase numbers.
ViewName Optional Guid. Specifies the GUID for the view.

Element Relationships

Child Elements
Method

Remarks

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

Example

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>