CloneContractRequest Class
Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online
Contains the data that is needed to copy an existing contract and its line items.
Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)
Syntax
'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class CloneContractRequest
Inherits OrganizationRequest
[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class CloneContractRequest : OrganizationRequest
Example
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 the first clone of the contract.
CloneContractRequest cloneRequest = new CloneContractRequest()
{
ContractId = _contractId,
IncludeCanceledLines = false
};
CloneContractResponse cloneResponse =
(CloneContractResponse)_serviceProxy.Execute(cloneRequest);
_firstCloneId = ((Contract)cloneResponse.Entity).ContractId.Value;
Remarks
Message Availability
This message works regardless whether the caller is connected to the server or offline.
Usage
Pass an instance of this class to the Execute method, which returns an instance of CloneContractResponse.
Privileges and Access Rights
To perform this action, the caller must have privileges on the Contract entity and access rights on the record specified in the ContractId property. For a complete list of the required privileges, see CloneContract Privileges.
Notes for Callers
By default the caller will become the owner for the new record. For this to work, the caller must have both Create and Read privileges for the contract entity. For more information, see Privileges by Entity. Alternatively, you can set the ownerid property to the ID of another user.
Inheritance Hierarchy
System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.CloneContractRequest
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.
Platforms
Development Platforms
Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)
Target Platforms
Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),
Change History
See Also
Reference
CloneContractRequest Members
Microsoft.Crm.Sdk.Messages Namespace
CloneContractResponse
Other Resources
Contract Entities
CloneContract Privileges
Contract Entity Messages and Methods
Sample: Manage Contracts
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.
© 2013 Microsoft Corporation. All rights reserved.