RecalculateRequest Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains the data that is needed to recalculate system-computed values for rollup fields in the goal hierarchy.
public ref class RecalculateRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RecalculateRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type RecalculateRequest = class
inherit OrganizationRequest
Public NotInheritable Class RecalculateRequest
Inherits OrganizationRequest
- Inheritance
- Attributes
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 instance. For the complete sample, see the link later in this topic.
Remarks
For the Web API use the Recalculate action.
Usage
Pass an instance of this class to the Execute(OrganizationRequest) 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.
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.
Constructors
RecalculateRequest() |
Initializes a new instance of the RecalculateRequest class. |
Properties
ExtensionData |
Gets or sets the structure that contains extra data. Optional. (Inherited from OrganizationRequest) |
Item[String] |
Gets or sets the indexer for the |
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 the request. 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. |