SdkMessageProcessingStep entity messages and methods

  • Article

 

Applies To: Dynamics CRM 2013

This entity defines how a plug-in or custom workflow activity should be registered in a stage of the event execution pipeline and under what conditions it should be executed. The schema name for this entity is SdkMessageProcessingStep. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message

Description

CreateRequest

Creates an SDK message processing step. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes an SDK message processing step. You can also call the IOrganizationService.Delete method.

RetrieveRequest

Retrieves an SDK message processing step. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of SDK message processing steps. You can also call the IOrganizationService.RetrieveMultiple method.

SetStateRequest

Sets the state of the SDK message processing step. The possible states are defined in the SdkMessageProcessingStepState enumeration. For a list of possible states, see SDKMessageProcessingStep entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

UpdateRequest

Updates an SDK message processing step. You can also call the IOrganizationService.Update method.

See Also

Plug-in registration entities
SdkMessageProcessingStepImage entity messages and methods
SdkMessageProcessingStep entity privileges