sdkmessageprocessingstep EntityType

  • Reference
Namespace:
Microsoft.Dynamics.CRM

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

Entity Set Path
[organization URI]/api/data/v9.0/sdkmessageprocessingsteps
Base Type
crmbaseentity
Display Name
Sdk Message Processing Step
Primary Key
sdkmessageprocessingstepid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
asyncautodelete Edm.Boolean

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

Display Name: Asynchronous Automatic Delete

Default Options
Value Label
1 Yes
0 No
canusereadonlyconnection Edm.Boolean

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

Display Name: Intent

Default Options
Value Label
1 Yes
0 No
category Edm.String

For internal use only.

Display Name: Category
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
configuration Edm.String

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

Display Name: Configuration
createdon Edm.DateTimeOffset

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

Display Name: Created On

Read Only
customizationlevel Edm.Int32

Customization level of the SDK message processing step.

Read Only
description Edm.String

Description of the SDK message processing step.

Display Name: Description
eventexpander Edm.String

Configuration for sending pipeline events to the Event Expander service.

Display Name: EventExpander
filteringattributes Edm.String

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

Version in which the form is introduced.

Display Name: Introduced Version
iscustomizable BooleanManagedProperty

Information that specifies whether this component can be customized.

Display Name: Customizable
ishidden BooleanManagedProperty

Information that specifies whether this component should be hidden.

Display Name: Hidden
ismanaged Edm.Boolean

Information that specifies whether this component is managed.

Display Name: State

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
mode Edm.Int32

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

Display Name: Execution Mode

Default Options
Value Label
0 Synchronous
1 Asynchronous
modifiedon Edm.DateTimeOffset

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

Display Name: Modified On

Read Only
name Edm.String

Name of SdkMessage processing step.

Display Name: Name
overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
rank Edm.Int32

Processing order within the stage.

Display Name: Execution Order
runtimeintegrationproperties Edm.String

For internal use only. Holds miscellaneous properties related to runtime integration.

Display Name: Runtime Integration Properties
sdkmessageprocessingstepid Edm.Guid

Unique identifier of the SDK message processing step entity.
sdkmessageprocessingstepidunique Edm.Guid

Unique identifier of the SDK message processing step.

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
stage Edm.Int32

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

Display Name: Execution Stage

Default Options
Value Label
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)
80 Pre-Commit stage fired before transaction commit (For internal use only)
90 Post-Commit stage fired after transaction commit (For internal use only)
statecode Edm.Int32

Status of the SDK message processing step.

Display Name: Status

Default Options
Value Label
0 Enabled
1 Disabled
statuscode Edm.Int32

Reason for the status of the SDK message processing step.

Display Name: Status Reason

Default Options
Value Label
1 Enabled
2 Disabled
supporteddeployment Edm.Int32

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

Display Name: Deployment

Default Options
Value Label
0 Server Only
1 Microsoft Dynamics 365 Client for Outlook Only
2 Both
versionnumber Edm.Int64

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

Read Only

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
_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_plugintypeeventhandler_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

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 createdby_sdkmessageprocessingstep
createdonbehalfby systemuser lk_sdkmessageprocessingstep_createdonbehalfby
eventhandler_plugintype plugintype plugintype_sdkmessageprocessingstep
eventhandler_serviceendpoint serviceendpoint serviceendpoint_sdkmessageprocessingstep
impersonatinguserid systemuser impersonatinguserid_sdkmessageprocessingstep
modifiedby systemuser modifiedby_sdkmessageprocessingstep
modifiedonbehalfby systemuser lk_sdkmessageprocessingstep_modifiedonbehalfby
organizationid organization organization_sdkmessageprocessingstep
plugintypeid plugintype plugintypeid_sdkmessageprocessingstep
sdkmessagefilterid sdkmessagefilter sdkmessagefilterid_sdkmessageprocessingstep
sdkmessageid sdkmessage sdkmessageid_sdkmessageprocessingstep
sdkmessageprocessingstepsecureconfigid sdkmessageprocessingstepsecureconfig sdkmessageprocessingstepsecureconfigid_sdkmessageprocessingstep

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
SdkMessageProcessingStep_AsyncOperations asyncoperation owningextensionid
sdkmessageprocessingstepid_sdkmessageprocessingstepimage sdkmessageprocessingstepimage sdkmessageprocessingstepid

Solutions

The following solutions include the sdkmessageprocessingstep entity type.

Name Description
msft_RuntimeExtensions This solution contains all necessary plugin assemblies as well as Custom Apis required to get the count of Category Attributes that needs to be updated for each organization, as well as plugins to update those attributes for SdkSteps. Get CustomApi will return how many rows of SdkSteps needs updates
API messages extension solution This solution contains CDS API message extensions.
RuntimeIntegration CDS Runtime Integration Extensions Solution

See also