RollupRequest 类

应用到: CRM 2015 on-prem, CRM Online

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

命名空间: Microsoft.Crm.Sdk.Messages
程序集: Microsoft.Crm.Sdk.Proxy (在 Microsoft.Crm.Sdk.Proxy.dll 中)

语法

声明
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class RollupRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class RollupRequest : OrganizationRequest

示例

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.

// Create RollupRequest
RollupRequest 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
RollupResponse rollupResponse = (RollupResponse)_serviceProxy.Execute(rollupRequest);
Console.WriteLine("Executed RollupRequest.");

备注

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

无论调用方是连接到服务器还是处于脱机状态，此消息都可正常工作。

Usage

Pass an instance of this class to the Execute 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 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

下表显示支持此消息的默认实体。对于此消息的列出实体，如果调用方必须连接到服务器，则“可用性”列显示“Server”；如果调用方可连接到服务器也可以从服务器断开连接，则显示“Both”。

Entity	Availability
activitypointer	Both
annotation	Both
contract	Both
incident	Both
invoice	Both
opportunity	Both
quote	Both
salesorder	Both

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
activitypointer	account or contact	Related, Extended
activitypointer	opportunity	None
annotation	account or contact	Related, Extended, None
annotation	opportunity	Related, Extended, None
contract	account or contact	Related, Extended
incident	account or contact	Related
invoice	account or contact	Related, Extended
opportunity	account or contact	Related, Extended
quote	account or contact	Related, Extended
salesorder	account or contact	Related, Extended

继承层次结构

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.RollupRequest

线程安全性

此类型的所有公共静态（Visual Basic 中的 Shared）成员都是线程安全成员。不保证任何实例成员是线程安全成员。

平台

开发平台

Windows Vista、Windows Server 2003 和

目标平台

Windows Vista,Windows XP

Change History

另请参阅

参考

RollupRequest 成员
Microsoft.Crm.Sdk.Messages 命名空间
RollupResponse

其他资源

Rollup Privileges
Sample: Rollup Records Related to a Specified Record
How Role-Based Security Can Be Used to Control Access to Entities In CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) In CRM

Send comments about this topic to Microsoft.
© 2014 Microsoft Corporation. All rights reserved.