Поделиться через


workflow EntityType

 

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

Description: Set of logical rules that define the steps necessary to automate a specific business process, task, or set of actions to be performed.

Entity Set path:[organization URI]/api/data/v8.2/workflows

Base Type: crmbaseentity EntityType

Display Name: Process

Primary Key: workflowid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to workflow

Operations using the workflow entity type.

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

asyncautodelete

Edm.Boolean

Description: Indicates whether the asynchronous system job is automatically deleted on completion.

Default Options:

1 : Yes
0 : No

Display Name: Delete Job On Completion

businessprocesstype

Edm.Int32

Description: Business Process Type.

Default Options:

0 : Business Flow
1 : Task Flow

Display Name: Business Process Type

category

Edm.Int32

Description: Category of the process.

Default Options:

0 : Workflow
1 : Dialog
2 : Business Rule
3 : Action
4 : Business Process Flow

Display Name: Category

clientdata

Edm.String

Description: Business logic converted into client data

Display Name: Client Data

Read-only property

componentstate

Edm.Int32

Description: For internal use only.

Default Options:

0 : Published
1 : Unpublished
2 : Deleted
3 : Deleted Unpublished

Display Name: Component State

Read-only property

createdon

Edm.DateTimeOffset

Description: Date and time when the process was created.

Display Name: Created On

Read-only property

createstage

Edm.Int32

Description: Stage of the process when triggered on Create.

Default Options:

20 : Pre-operation
40 : Post-operation

Display Name: Create Stage

deletestage

Edm.Int32

Description: Stage of the process when triggered on Delete.

Default Options:

20 : Pre-operation
40 : Post-operation

Display Name: Delete stage

description

Edm.String

Description: Description of the process.

Display Name: Description

entityimage

Edm.Binary

Description: Shows the default image for the record.

Display Name: Default Image

entityimage_timestamp

Edm.Int64

Description:

Read-only property

entityimage_url

Edm.String

Description:

Read-only property

entityimageid

Edm.Guid

Description: For internal use only.

Display Name: Entity Image Id

Read-only property

formid

Edm.Guid

Description: Unique identifier of the associated form.

Display Name: Form ID

inputparameters

Edm.String

Description: Input parameters to the process.

Display Name: Input Parameters

introducedversion

Edm.String

Description: Version in which the form is introduced.

Display Name: Introduced Version

iscrmuiworkflow

Edm.Boolean

Description: Indicates whether the process was created using the Microsoft Dynamics 365 Web application.

Default Options:

1 : Yes
0 : No

Display Name: Is CRM Process

Read-only property

iscustomizable

BooleanManagedProperty ComplexType

Description: Information that specifies whether this component can be customized.

Display Name: Customizable

ismanaged

Edm.Boolean

Description: Indicates whether the solution component is part of a managed solution.

Default Options:

1 : Managed
0 : Unmanaged

Display Name: Is Managed

Read-only property

istransacted

Edm.Boolean

Description: Whether or not the steps in the process are executed in a single transaction.

Default Options:

1 : Yes
0 : No

Display Name: Is Transacted

languagecode

Edm.Int32

Description: Language of the process.

Display Name: Language

mode

Edm.Int32

Description: Shows the mode of the process.

Default Options:

0 : Background
1 : Real-time

Display Name: Mode

modifiedon

Edm.DateTimeOffset

Description: Date and time when the process was last modified.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Name of the process.

Display Name: Process Name

ondemand

Edm.Boolean

Description: Indicates whether the process is able to run as an on-demand process.

Default Options:

1 : Yes
0 : No

Display Name: Run as On Demand

overwritetime

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Record Overwrite Time

Read-only property

primaryentity

Edm.String

Description: Primary entity for the process. The process can be associated for one or more SDK operations defined on the primary entity.

Display Name: Primary Entity

processorder

Edm.Int32

Description: Type the business process flow order.

Display Name: Process Order

processroleassignment

Edm.String

Description: Contains the role assignment for the process.

Display Name: Role assignment for Process

rank

Edm.Int32

Description: Indicates the rank for order of execution for the synchronous workflow.

Display Name: Rank

rendererobjecttypecode

Edm.String

Description: The renderer type of Workflow

Display Name: Renderer Type

runas

Edm.Int32

Description: Specifies the system user account under which a workflow executes.

Default Options:

0 : Owner
1 : Calling User

Display Name: Run As User

scope

Edm.Int32

Description: Scope of the process.

Default Options:

1 : User
2 : Business Unit
3 : Parent: Child Business Units
4 : Organization

Display Name: Scope

solutionid

Edm.Guid

Description: Unique identifier of the associated solution.

Display Name: Solution

Read-only property

statecode

Edm.Int32

Description: Status of the process.

Default Options:

0 : Draft
1 : Activated

Display Name: Status

statuscode

Edm.Int32

Description: Additional information about status of the process.

Default Options:

1 : Draft
2 : Activated

Display Name: Status Reason

subprocess

Edm.Boolean

Description: Indicates whether the process can be included in other processes as a child process.

Default Options:

1 : Yes
0 : No

Display Name: Is Child Process

syncworkflowlogonfailure

Edm.Boolean

Description: Select whether synchronous workflow failures will be saved to log files.

Default Options:

1 : Yes
0 : No

Display Name: Log upon Failure

triggeroncreate

Edm.Boolean

Description: Indicates whether the process will be triggered when the primary entity is created.

Default Options:

1 : Yes
0 : No

Display Name: Trigger On Create

triggerondelete

Edm.Boolean

Description: Indicates whether the process will be triggered on deletion of the primary entity.

Default Options:

1 : Yes
0 : No

Display Name: Trigger On Delete

triggeronupdateattributelist

Edm.String

Description: Attributes that trigger the process when updated.

Display Name: Trigger On Update Attribute List

type

Edm.Int32

Description: Type of the process.

Default Options:

1 : Definition
2 : Activation
3 : Template

Display Name: Type

uniquename

Edm.String

Description: Unique name of the process

Display Name: Unique Name

updatestage

Edm.Int32

Description: Select the stage a process will be triggered on update.

Default Options:

20 : Pre-operation
40 : Post-operation

Display Name: Update Stage

versionnumber

Edm.Int64

Description:

Read-only property

workflowid

Edm.Guid

Description: Unique identifier of the process.

Display Name: Process

workflowidunique

Edm.Guid

Description: For internal use only.

Read-only property

xaml

Edm.String

Description: XAML that defines the process.

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Retrieve data about lookup properties

Name

Single-valued navigation property

Description

_activeworkflowid_value

activeworkflowid

Unique identifier of the latest activation record for the process.

_createdby_value

createdby

Unique identifier of the user who created the process.

_createdonbehalfby_value

createdonbehalfby

Unique identifier of the delegate user who created the process.

_modifiedby_value

modifiedby

Unique identifier of the user who last modified the process.

_modifiedonbehalfby_value

modifiedonbehalfby

Unique identifier of the delegate user who last modified the process.

_ownerid_value

ownerid

Unique identifier of the user or team who owns the process.

_owningbusinessunit_value

owningbusinessunit

Unique identifier of the business unit that owns the process.

_owningteam_value

owningteam

Unique identifier of the team who owns the process.

_owninguser_value

owninguser

Unique identifier of the user who owns the process.

_parentworkflowid_value

parentworkflowid

Unique identifier of the definition for process activation.

_plugintypeid_value

Unique identifier of the plug-in type.

_sdkmessageid_value

Unique identifier of the SDK Message associated with this workflow.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name

Type

Partner

activeworkflowid

workflow EntityType

workflow_active_workflow

createdby

systemuser EntityType

workflow_createdby

createdonbehalfby

systemuser EntityType

workflow_createdonbehalfby

modifiedby

systemuser EntityType

workflow_modifiedby

modifiedonbehalfby

systemuser EntityType

workflow_modifiedonbehalfby

ownerid

principal EntityType

owner_workflows

owningbusinessunit

businessunit EntityType

business_unit_workflow

owningteam

team EntityType

team_workflow

owninguser

systemuser EntityType

system_user_workflow

parentworkflowid

workflow EntityType

workflow_parent_workflow

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name

Type

Partner

lk_asyncoperation_workflowactivationid

asyncoperation EntityType

workflowactivationid

process_processstage

processstage EntityType

processid

slabase_workflowid

sla EntityType

workflowid

slaitembase_workflowid

slaitem EntityType

workflowid

workflow_active_workflow

workflow EntityType

activeworkflowid

Workflow_Annotation

annotation EntityType

objectid_workflow

workflow_expiredprocess

expiredprocess EntityType

processid

workflow_leadtoopportunitysalesprocess

leadtoopportunitysalesprocess EntityType

processid

workflow_newprocess

newprocess EntityType

processid

workflow_opportunitysalesprocess

opportunitysalesprocess EntityType

processid

workflow_parent_workflow

workflow EntityType

parentworkflowid

workflow_phonetocaseprocess

phonetocaseprocess EntityType

processid

Workflow_SyncErrors

syncerror EntityType

regardingobjectid_workflow_syncerror

workflow_translationprocess

translationprocess EntityType

processid

Operations bound to workflow

The following operations are bound to the workflow entity type.

Name

Bound to

CreateWorkflowFromTemplate Action

Entity

ExecuteWorkflow Action

Entity

Operations using the workflow entity type.

The following operations use the workflow entity type in a parameter or return type.

Name

How used

Description

CreateWorkflowFromTemplate Action

entity Parameter

Creates a workflow (process) from a workflow template.

CreateWorkflowFromTemplate Action

ReturnType

Creates a workflow (process) from a workflow template.

ExecuteWorkflow Action

entity Parameter

Executes a workflow.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action 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