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

次の表は、このメッセージをサポートする既定のエンティティを示しています。メッセージのエンティティの「可用性」列には、呼び出し元がサーバーに接続されている必要がある場合は "サーバー"、呼び出し元がサーバーに接続できる場合、またはサーバーから切断されている場合は "両方" と表示されています。

Rollup Types

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

継承階層

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.