CloneContractRequest Class


Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy



[DataContractAttribute(Namespace = "")]
public sealed class CloneContractRequest : OrganizationRequest
[DataContractAttribute(Namespace = "")]
public ref class CloneContractRequest sealed : OrganizationRequest
[<DataContractAttribute(Namespace = "")>]
type CloneContractRequest = 
        inherit OrganizationRequest
<DataContractAttribute(Namespace := "")>
Public NotInheritable Class CloneContractRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod CloneContractRequest()

Initializes a new instance of the CloneContractRequest class.


Name Description
System_CAPS_pubproperty ContractId

Gets or sets the ID of the contract to be copied. Required.

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty IncludeCanceledLines

Gets or sets a value that indicates whether the canceled line items of the originating contract are to be included in the copy (clone). Required.

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)


Message Availability

This message works regardless whether the caller is connected to the server or offline. 


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 message 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.


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 =
_firstCloneId = ((Contract)cloneResponse.Entity).ContractId.Value;

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.

See Also

Microsoft.Crm.Sdk.Messages Namespace
Contract entities
CloneContract message privileges
Contract entity messages and methods
Sample: Manage contracts
How role-based security can be used to control access to entities in Microsoft Dynamics CRM
How record-based security can be used to control access to records in Microsoft Dynamics CRM

Return to top

© 2016 Microsoft. All rights reserved. Copyright