Workflow (process) entity messages and methods
Collapse the table of content
Expand the table of content

Workflow (process) entity messages and methods

 

Applies To: CRM 2016 on-prem, CRM Online

The workflow (process) entity represents a series of interrelated action steps and the workflow rules that drive the transition between these steps. A workflow process defines the actions the workflow should take at each step and the workflow rules that the workflow should use to evaluate when to go to the next step. The schema name for this entity is Workflow. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with theIOrganizationService.Execute method.

Message

Description

AssignRequest

Assigns a workflow to another user or team.

CreateRequest

Creates a workflow. You can also call the IOrganizationService.Create method.

CreateWorkflowFromTemplateRequest

Creates a workflow from a workflow template.

DeleteRequest

Deletes a workflow. You can also call the IOrganizationService.Delete method.

ExecuteWorkflowRequest

Executes a workflow.

GrantAccessRequest

Shares a workflow with another security principal (user or team).

ModifyAccessRequest

Changes the access rights for a workflow previously shared with another security principal (user or team).

RetrieveRequest

Retrieves a workflow. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of workflows. You can also call the IOrganizationService.RetrieveMultiple method.

RetrievePrincipalAccessRequest

Retrieves the access the specified security principal (user or team) has to a workflow.

RetrieveSharedPrincipalsAndAccessRequest

Retrieves the security principals (users or teams) that have access to a workflow, together with their access rights to the workflow.

RevokeAccessRequest

Removes all access to a workflow for the specified security principal (user or team).

SetStateRequest

Sets the state of a workflow.The possible states are defined in the WorkflowState enumeration. You can see the states in the Workflow entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

UpdateRequest

Updates a workflow. You can also call the IOrganizationService.Update method.

Microsoft Dynamics CRM 2016 and CRM Online

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show:
© 2016 Microsoft