ExecuteMultipleRequest Class

Definition

Contains the data that is needed to execute one or more message requests as a single batch operation, and optionally return a collection of results.

public ref class ExecuteMultipleRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class ExecuteMultipleRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type ExecuteMultipleRequest = class
    inherit OrganizationRequest
Public NotInheritable Class ExecuteMultipleRequest
Inherits OrganizationRequest
Inheritance
ExecuteMultipleRequest
Attributes

Examples

The following sample shows how to execute the ExecuteMultipleRequest message.

// Create an ExecuteMultipleRequest object.
        requestWithResults = new ExecuteMultipleRequest()
        {
         // Assign settings that define execution behavior: continue on error, return responses.
           Settings = new ExecuteMultipleSettings()
            {
              ContinueOnError = false,
              ReturnResponses = true
            },

// Create an empty organization request collection.
        Requests = new OrganizationRequestCollection()
        };

// Create several (local, in memory) entities in a collection.
        EntityCollection input = GetCollectionOfEntitiesToCreate();

// Add a CreateRequest for each entity to the request collection.
        foreach (var entity in input.Entities)
        {
        CreateRequest createRequest = new CreateRequest { Target = entity };
        requestWithResults.Requests.Add(createRequest);
        }

// Execute all the requests in the request collection using a single web method call.
        ExecuteMultipleResponse responseWithResults =
        (ExecuteMultipleResponse)_serviceProxy.Execute(requestWithResults);

// Display the results returned in the responses.
        foreach (var responseItem in responseWithResults.Responses)
        {
        // A valid response.
        if (responseItem.Response != null)
        DisplayResponse(requestWithResults.Requests[responseItem.RequestIndex], responseItem.Response);

// An error has occurred.
        else if (responseItem.Fault != null)
        DisplayFault(requestWithResults.Requests[responseItem.RequestIndex],
        responseItem.RequestIndex, responseItem.Fault);
        }

The following sample shows how to execute the ExecuteMultipleRequest message.

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the ExecuteMultipleResponse class.

Privileges and Access Rights

There are no specific privileges required for this request. Refer to the required privileges and access rights of each message request you add to the Requests collection. Refer to Privileges by message.

Notes for Callers

CallerId is honored for each message request. See the related topics for throttling limitations.

Constructors

ExecuteMultipleRequest()

Initializes a new instance of the ExecuteMultipleRequest.

Properties

ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
Requests

Gets or sets the collection of message requests to execute.

Settings

Gets or sets the settings that define whether execution should continue if an error occurs and if responses for each message request processed are to be returned.

Applies to

See also