Edit

Share via

Batch element (View)

  • Article

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

Provides batch processing of commands within HTTP protocol.

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

Elements and attributes

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

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 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.

Child elements

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>