Batch Element

Article
05/05/2014

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Provides batch processing of commands within HTTP protocol.

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

Attributes

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 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 versions of the product.
ViewName	Optional Guid. Specifies the GUID for the view.

Child Elements

Method

Parent Elements

None

Occurrences

Minimum: 0

Maximum: 1

Remarks

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.

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>

Share via