Actions REST

The Actions REST activity helps to call actions using the Customer Engagement Web API and perform operations in the Microsoft Dynamics CRM server.

You can call bound and unbound actions on the Microsoft Dynamics CRM server. You can also use custom bound and unbound actions. For more information on actions, see the Dynamics 365 Customer Engagement Web API Action Reference documentation.

General

On the General tab, you can establish a connection to the Microsoft Dynamics CRM server, and specify the type of action you want to call.

The following table lists the configurations on the General tab of the Actions REST Entity activity:

Field Module Property? Description
Name No Specify the name of the activity in the process definition.
Dynamics CRM REST Connection Yes Specify a shared connection resource.

Click the icon to select a space connection. If no matching Dynamics CRM REST connections are found, click Create Shared Resource in the Select DynamicscrmRestResource Resource Template dialog to create one. See Creating a Dynamics CRM REST Connection for more details.

Dynamics CRM Action No Specify the action to be called.

Click Fetch Action to open the Action Selection dialog that contains all the available actions. Select an action from the list and click OK. The selected action is automatically specified in this field. (In the Action Selection dialog, if required, click Refresh List to retrieve the latest list of actions and entity metadata from the server.)

Entity for Bound Action No Specify the entity to be bound with an action.
Note: This field is displayed only if you select a bound action in the Action Selection dialog

Select the entity to be bound with the action from the Entity for Bound Action drop-down list.

Build Schema No

Click Build Schema to generate input and output schema for the Actions REST Entity activity.

If there are no entity types in the parameters/return type, then the input and output schema are formed automatically. Otherwise, the Action Build Schema Configuration dialog opens.

  1. Select the input or output type from the Select I/O Type list.

  2. Select the parameter from the Select Parameter list.

  3. Choose one entity at a time from the Dynamics CRM Entity list and click Add to open the Attributes Selection Dialog.

    1. To select all the attributes in the list, click Select All.

    2. To remove all the selected attributes in the list, click Deselect All.

    3. To save the changes, click OK.

    4. To discard the changes, click Cancel.

  4. After attributes selection is completed for all entities, click Save to form the input and output schema for the action.

  5. Click Cancel to discard the changes.

Note: Build Schema is visible when the user selects valid Dynamics CRM Action from the Fetch Action dialog.
CRMBaseEntity Params No

You can select either the collection or noncollection type of crmbaseentities present in input params/output return types for an Action from an Actions activity.

Note: This field is only displayed if you select the action that has crmbaseentity params/return type from the Actions Selection dialog.
  1. Click Select CRMBaseEntity. The CRMBaseEntity Configuration window opens.

    To configure CRMBaseEntity collection type of parameter:

    1. Select the input or output type from the Select I/O Type list.
    2. Select the parameter from the Select parameter list.
    3. Select one or more entities from Dynamics CRM Entity list:
      • To select all the entities in the list, click Select All.
      • To remove all the selected entities, click Deselect All.
      • To see the updated entities list, click Refresh List.
    4. Click Add. The selected input/output parameters and entities appear in the List of parameters table.

    To configure CRMBaseEntity noncollection type of parameter:

    1. Select the input or output type from the Select I/O Type list.
    2. Select the parameter from the Select parameter list.
    3. To select the Dynamics CRM Entity, click Fetch Entity. Entity Selection dialog is opened, select the entity from the list and click OK. If you want to remove the selected entity, click Clear Entity.
    4. Click Add. The selected input/output params and entities appear in the List of parameters table.
  2. To save the process and update the Actions activity with the latest configurations, click Save. To discard the changes performed, click Cancel.
  3. To delete the input/output parameters entity data, select the row to be deleted from the list and click Delete. Click Edit to make the changes in the input/output parameters, click Save Edit to save the changes or click Cancel Edit to discard the changes. You can edit only one parameter row at a time. However, you can delete multiple parameter rows at a time.

Description

On the Description tab, enter a short description for the Actions REST activity.

Input

The input of this activity varies depending on the action selected when configuring the General tab. If the action is bound, the input also varies depending on the entity that the action is bound to. For more information on the action input, see theDynamics 365 Customer Engagement Web API Action Reference documentation.

Output

The output of this activity varies depending on the action selected when configuring the General tab. If the action is bound, the output also varies depending on the entity that the action is bound to. For more information on the action output, see the Dynamics 365 Customer Engagement Web API Action Reference documentation.

Fault

The Fault tab displays the error code and error message of the Actions REST activity. See Error Codes for a more detailed explanation of errors.

The following table lists error schema elements on the Fault tab of the Actions REST activity:

Error Schema Element Data Type Description
message String The error message returned by the plug-in.
messageCode String The error code returned by the plug-in.