sdkmessageprocessingstep EntityType
Stage in the execution pipeline that a plug-in is to execute.
- Entity set path:
- [organization URI]/api/data/v9.2/sdkmessageprocessingsteps
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Sdk Message Processing Step
- Primary key:
- sdkmessageprocessingstepid
- Primary name column:
- 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
|
||||||||||||||||||||||||||||
| canbebypassed | Edm.Boolean |
Default options
|
||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||
| 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 |
||||||||||||||||||||||||||||
| enablepluginprofiler | Edm.Boolean |
EnablePluginProfiler Display name: EnablePluginProfiler
Default options
|
||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||
| mode | Edm.Int32 |
Run-time mode of execution, for example, synchronous or asynchronous. Display name: Execution Mode
Default options
|
||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||
| statecode | Edm.Int32 |
Status of the SDK message processing step. Display name: Status
Default options
|
||||||||||||||||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the SDK message processing step. Display name: Status Reason
Default options
|
||||||||||||||||||||||||||||
| supporteddeployment | Edm.Int32 |
Deployment that the SDK message processing step should be executed on; server, client, or both. Display name: Deployment
Default options
|
||||||||||||||||||||||||||||
| 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 Lookup property data.
| 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. |
| _fxexpressionid_value | fxexpression |
Unique identifier for fxexpression associated with SdkMessageProcessingStep. |
| _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. |
| _powerfxruleid_value | powerfxrule |
Unique identifier for powerfxrule associated with SdkMessageProcessingStep. |
| _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 |
| fxexpression | fxexpression | fxexpression_sdkmessageprocessingstep |
| impersonatinguserid | systemuser | impersonatinguserid_sdkmessageprocessingstep |
| modifiedby | systemuser | modifiedby_sdkmessageprocessingstep |
| modifiedonbehalfby | systemuser | lk_sdkmessageprocessingstep_modifiedonbehalfby |
| organizationid | organization | organization_sdkmessageprocessingstep |
| plugintypeid | plugintype | plugintypeid_sdkmessageprocessingstep |
| powerfxrule | powerfxrule | powerfxrule_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 |