Classe RollupRequest

S'applique à: 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.

Espace de noms: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (dans Microsoft.Crm.Sdk.Proxy.dll)

Syntaxe

'Déclaration
<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

Exemple

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.");

Remarques

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

Ce message fonctionne, que l'appelant soit connecté au serveur ou en mode hors connexion.

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

Le tableau suivant montre les entités par défaut prenant en charge ce message. Pour obtenir la liste des entités répertoriées dans ce message, la colonne Disponibilité indique la valeur Serveur si l'appelant doit être connecté au serveur et la valeur Les deux si l'appelant peut être connecté ou déconnecté du serveur.

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

Hiérarchie d'héritage

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

Cohérence de thread

Tous les membres statiques publics (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres d'instance ne sont pas garantis thread-safe.

Plateformes

Plateformes de développement

Windows Vista, Windows Server 2003 et

Plateformes cibles

Windows Vista,Windows XP

Change History

Voir aussi

Référence

Membres RollupRequest
Espace de noms Microsoft.Crm.Sdk.Messages
RollupResponse

Autres ressources

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.