CreateWorkflowFromTemplateRequest Class


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

Contains the data that is needed to create a workflow (process) from a workflow template.

For the Web API use the CreateWorkflowFromTemplate Action.

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

Inheritance Hierarchy



[DataContractAttribute(Namespace = "")]
public sealed class CreateWorkflowFromTemplateRequest : OrganizationRequest
<DataContractAttribute(Namespace := "")>
Public NotInheritable Class CreateWorkflowFromTemplateRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod CreateWorkflowFromTemplateRequest()

Initializes a new instance of theCreateWorkflowFromTemplateRequest class.


Name Description
System_CAPS_pubproperty ExtensionData

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

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

System_CAPS_pubproperty WorkflowName

Gets or sets the name of the new workflow. Required.

System_CAPS_pubproperty WorkflowTemplateId

Gets or sets the ID of the workflow template. Required.


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

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


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

Privileges and Access Rights

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


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.

// Connect to the Organization service. 
// The using statement assures that the service proxy will be properly disposed.
using (_serviceProxy = new OrganizationServiceProxy(serverConfig.OrganizationUri, serverConfig.HomeRealmUri,
                                                     serverConfig.Credentials, serverConfig.DeviceCredentials))
    // This statement is required to enable early-bound type support.

    OrganizationServiceContext _orgContext = new OrganizationServiceContext(_serviceProxy);


    CreateWorkflowFromTemplateRequest request = new CreateWorkflowFromTemplateRequest()
        WorkflowName = "Workflow From Template",
        WorkflowTemplateId = _processTemplateId

    // Execute request.
    CreateWorkflowFromTemplateResponse response = (CreateWorkflowFromTemplateResponse)_serviceProxy.Execute(request);
    _processId = response.Id;

    // Verify success.
    // Retrieve the name of the workflow.
    ColumnSet cols = new ColumnSet("name");
    Workflow newWorkflow = (Workflow)_serviceProxy.Retrieve(Workflow.EntityLogicalName, response.Id, cols);
    if (newWorkflow.Name == "Workflow From Template")
        Console.WriteLine("Created {0}.", request.WorkflowName);


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
Workflow and process entities
Workflow (process) entity messages and methods
Sample: Create a process using a template

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright