sdkmessageprocessingstep EntityType

Dynamics CRM 2016
 

Updated: November 29, 2016

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

Description: Stage in the execution pipeline that a plug-in is to execute.

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

Base Type: crmbaseentity EntityType

Display Name: Sdk Message Processing Step

Primary Key: sdkmessageprocessingstepid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation 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: Asynchronous Automatic Delete

canusereadonlyconnection

Edm.Boolean

Description: Identifies whether a SDK Message Processing Step type will be ReadOnly or Read Write. false - ReadWrite, true - ReadOnly

Default Options:

1 : Yes
0 : No

Display Name: Intent

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

configuration

Edm.String

Description: Step-specific configuration for the plug-in type. Passed to the plug-in constructor at run time.

Display Name: Configuration

createdon

Edm.DateTimeOffset

Description: Date and time when the SDK message processing step was created.

Display Name: Created On

Read-only property

customizationlevel

Edm.Int32

Description: Customization level of the SDK message processing step.

Read-only property

description

Edm.String

Description: Description of the SDK message processing step.

Display Name: Description

filteringattributes

Edm.String

Description: Comma-separated list of attributes. If at least one of these attributes is modified, the plug-in should execute.

Display Name: Filtering Attributes

introducedversion

Edm.String

Description: Version in which the form is introduced.

Display Name: Introduced Version

iscustomizable

BooleanManagedProperty ComplexType

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

Display Name: Customizable

ishidden

BooleanManagedProperty ComplexType

Description: Information that specifies whether this component should be hidden.

Display Name: Hidden

ismanaged

Edm.Boolean

Description: Information that specifies whether this component is managed.

Default Options:

1 : Managed
0 : Unmanaged

Display Name: State

Read-only property

mode

Edm.Int32

Description: Run-time mode of execution, for example, synchronous or asynchronous.

Default Options:

0 : Synchronous
1 : Asynchronous

Display Name: Execution Mode

modifiedon

Edm.DateTimeOffset

Description: Date and time when the SDK message processing step was last modified.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Name of SdkMessage processing step.

Display Name: Name

overwritetime

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Record Overwrite Time

Read-only property

rank

Edm.Int32

Description: Processing order within the stage.

Display Name: Execution Order

sdkmessageprocessingstepid

Edm.Guid

Description: Unique identifier of the SDK message processing step entity.

sdkmessageprocessingstepidunique

Edm.Guid

Description: Unique identifier of the SDK message processing step.

Read-only property

solutionid

Edm.Guid

Description: Unique identifier of the associated solution.

Display Name: Solution

Read-only property

stage

Edm.Int32

Description: Stage in the execution pipeline that the SDK message processing step is in.

Default Options:

5 : Initial Pre-operation (For internal use only)
10 : Pre-validation
15 : Internal Pre-operation Before External Plugins (For internal use only)
20 : Pre-operation
25 : Internal Pre-operation After External Plugins (For internal use only)
30 : Main Operation (For internal use only)
35 : Internal Post-operation Before External Plugins (For internal use only)
40 : Post-operation
45 : Internal Post-operation After External Plugins (For internal use only)
50 : Post-operation (Deprecated)
55 : Final Post-operation (For internal use only)

Display Name: Execution Stage

statecode

Edm.Int32

Description: Status of the SDK message processing step.

Default Options:

0 : Enabled
1 : Disabled

Display Name: Status

statuscode

Edm.Int32

Description: Reason for the status of the SDK message processing step.

Default Options:

1 : Enabled
2 : Disabled

Display Name: Status Reason

supporteddeployment

Edm.Int32

Description: Deployment that the SDK message processing step should be executed on; server, client, or both.

Default Options:

0 : Server Only
1 : Microsoft Dynamics 365 Client for Outlook Only
2 : Both

Display Name: Deployment

versionnumber

Edm.Int64

Description: Number that identifies a specific revision of the SDK message processing step.

Read-only property

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

_createdby_value

createdby

Unique identifier of the user who created the SDK message processing step.

_createdonbehalfby_value

createdonbehalfby

Unique identifier of the delegate user who created the sdkmessageprocessingstep.

_eventhandler_value

eventhandler_plugintype

eventhandler_serviceendpoint

Unique identifier of the associated event handler.

_impersonatinguserid_value

impersonatinguserid

Unique identifier of the user to impersonate context when step is executed.

_modifiedby_value

modifiedby

Unique identifier of the user who last modified the SDK message processing step.

_modifiedonbehalfby_value

modifiedonbehalfby

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

_organizationid_value

organizationid

Unique identifier of the organization with which the SDK message processing step is associated.

_sdkmessagefilterid_value

sdkmessagefilterid

Unique identifier of the SDK message filter.

_sdkmessageid_value

sdkmessageid

Unique identifier of the SDK message.

_sdkmessageprocessingstepsecureconfigid_value

sdkmessageprocessingstepsecureconfigid

Unique identifier of the Sdk message processing step secure configuration.

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

createdby

systemuser EntityType

createdby_sdkmessageprocessingstep

createdonbehalfby

systemuser EntityType

lk_sdkmessageprocessingstep_createdonbehalfby

eventhandler_plugintype

plugintype EntityType

plugintype_sdkmessageprocessingstep

eventhandler_serviceendpoint

serviceendpoint EntityType

serviceendpoint_sdkmessageprocessingstep

impersonatinguserid

systemuser EntityType

impersonatinguserid_sdkmessageprocessingstep

modifiedby

systemuser EntityType

modifiedby_sdkmessageprocessingstep

modifiedonbehalfby

systemuser EntityType

lk_sdkmessageprocessingstep_modifiedonbehalfby

organizationid

organization EntityType

organization_sdkmessageprocessingstep

plugintypeid

plugintype EntityType

plugintypeid_sdkmessageprocessingstep

sdkmessagefilterid

sdkmessagefilter EntityType

sdkmessagefilterid_sdkmessageprocessingstep

sdkmessageid

sdkmessage EntityType

sdkmessageid_sdkmessageprocessingstep

sdkmessageprocessingstepsecureconfigid

sdkmessageprocessingstepsecureconfig EntityType

sdkmessageprocessingstepsecureconfigid_sdkmessageprocessingstep

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

SdkMessageProcessingStep_AsyncOperations

asyncoperation EntityType

owningextensionid

sdkmessageprocessingstepid_sdkmessageprocessingstepimage

sdkmessageprocessingstepimage EntityType

sdkmessageprocessingstepid

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: