Skip to main content

Delete Record

UiPath.MicrosoftDynamics.Activities.DeleteRecord

The Delete Record activity uses the Web API DELETE operation to delete a record.

After deleting the record, the activity outputs the status of the request (success/failure information) in a ResponseStatus object (MicrosoftDynamicsStatus) that you can use in subsequent activities (e.g., conditional logic).

How it works​

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Microsoft Dynamics Application Scope activity to your project.
  3. Add an activity or run an external process that outputs the record identifier (e.g., Insert Record, Search Records).
  4. Add the Delete Record activity inside the Microsoft Dynamics Application Scope activity.
  5. Select the Object you want to delete and enter a value for the Input property.
  6. Create and enter a ResponseStatus variable for the Output property.

    • Your input property values are sent in the DELETE operation request.

    • The operation returns the ResponseStatus and value to your output property variable.

      docs image

In the Body of the Activity​

  • Object - Select an Object using the Object Wizard.

Properties​

Common​

  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Input​

  • Id - The identifier assigned to the record that you want to delete. This field supports only Strings or String variables. To get the record Id value, use an activity or run an external process that outputs the record identifier (e.g., Insert Record, Search Records).

Misc​

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Output​

  • ResponseStatus - The status of the request (success/failure information). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). The ResponseStatus object includes three properties that you can use in other activities.
    • Success - Boolean - Specifies whether the API request was successful.
    • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
    • Message - String - The error message.

Example​

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guide.

docs image