SetProcess Action

  • Article

 

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

Sets another business process flow instance as the active process instance for the target entity record. If there isn't any active business process flow instance for the target entity record and the specified business process flow definition, a new business process flow instance will be created and set as the active instance.

This Web API action corresponds to the organization service SetProcessRequest.

SetProcess action is not bound to any entity types.

SetProcess action does not return a value.

Parameters

Parameters allow for data to be passed to the action.

Name

Type

Nullable

Unicode

Description

Target

crmbaseentity EntityType

false

The target entity.

NewProcess

crmbaseentity EntityType

The business process flow definition to be set to the target entity.

NewProcessInstance

crmbaseentity EntityType

The business process flow instance to be set as the active business process flow instance for the target entity. Optional. If you do not specify this parameter and there isn't any active business process flow instance for the target entity record and the specified business process flow definition, a new business process flow instance will be created and set as the active instance.

See Also

Use Web API actions
Web API EntityType Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright