RecalculateRequest Class

Artikel
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to recalculate system-computed values for rollup fields in the goal hierarchy.

For the Web API use the Recalculate Action.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

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

Syntax

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

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

Constructors

	Name	Description
	RecalculateRequest()	Initializes a new instance of the RecalculateRequest class.

Properties

	Name	Description
	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.)
	Target	Gets or sets the target record for the recalculate operation. Required.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the RecalculateResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Goal entity and access rights on the specified record in the Target property. For a complete list of the required privileges, see Recalculate message privileges.

Notes for Callers

Regardless which goal record is a target of the recalculate operation, the rollup fields for all goals in the specified hierarchy are updated.

Note

For each goal in the hierarchy, this operation recalculates the rollup field values that are specified in the associated rollup field (RollupField) entity records. The remaining goal-related rollup fields contain null values.

Examples

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.


// Calculate roll-up of goals.
RecalculateRequest recalculateRequest = new RecalculateRequest()
{
    Target = new EntityReference(Goal.EntityLogicalName, _parentGoalId)
};
_serviceProxy.Execute(recalculateRequest);

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Freigeben über