RollupRequest RollupRequest RollupRequest RollupRequest Class


Contains the data that is needed to retrieve all the entity records that are related to the specified record.

For the Web API use the Rollup Function.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

public ref class RollupRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
public sealed class RollupRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type RollupRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RollupRequest
Inherits OrganizationRequest


// Create RollupRequest
    var rollupRequest = new RollupRequest();
        rollupRequest.Query = query;
        rollupRequest.Target = new EntityReference("account", _accountId);
        rollupRequest.RollupType = RollupType.Extended;
    Console.WriteLine("Created RollupRequest.");
#endregion Create RollupRequest

#region Execute RollupRequest
// Execute RollupRequest

var rollupResponse = (RollupResponse)svc.Execute(rollupRequest);
Console.WriteLine("Executed RollupRequest.");

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.



A rollup operation retrieves all annotations that are related to a specified account. An annotation is a note that is attached to one or more objects, including other notes.

Message Availability

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


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

Privileges and Access Rights

To perform this action, the caller must have privileges on the specified entities in the TargetQuery properties. The caller must also have access rights on the specified record in the Target property and read access rights on the records that are returned from the query. For a complete list of the required privileges, see Rollup message privileges.

Notes for Callers

The target entities include: account, contact, and opportunity. The rollup type (RollupType) for the supported entities depends on the target entity type.

Supported Entities

The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server.



















Rollup Types

The following table lists the available rollup types for each supported entity depending on the target of the rollup operation.

Supported entity

Target entity

Rollup type


RollupRequest() RollupRequest() RollupRequest() RollupRequest()

Initializes a new instance of the RollupRequest class.


ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

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

(Inherited from OrganizationRequest)
Query Query Query Query

Gets or sets the query criteria for the rollup operation. Required.

RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

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

(Inherited from OrganizationRequest)
RollupType RollupType RollupType RollupType

Gets or sets the rollup type. Required.

Target Target Target Target

Gets or sets the target record for the rollup operation. Required.

Applies to

See also