The Delete ServiceNow Record activity uses the the ServiceNow Table - DELETE API to delete a specific record (sys_id).
After deleting the record, the activity outputs the status of the request (success/failure information) in a
ResponseStatus object (ServiceNowStatus) that you can use in subsequent activities (e.g., conditional logic).
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.
- Complete the Setup steps.
- Add the ServiceNow Scope activity to your project.
- Add the Delete ServiceNow Record activity inside the ServiceNow Scope activity.
- Click the Configure button inside the Delete ServiceNow Record activity (this opens the Object Wizard).
- Select the Object that you want to delete and enter values for the Input properties.
- Create and enter a
ResponseStatusvariable for the Output property.
- Your input property values are sent to the Table - DELETE API.
- The API returns the
ResponseStatusvalue to your output property variable.
To enter your Delete ServiceNow Record property values, click the Configure button to open the Object Wizard and select a ServiceNow object (you also have the option to enter the object as a
To learn more about the Object Wizard, see the Business Activity Frameworks page.
- Object - The type of ServiceNow object that you want to delete. Use the Object Wizard to select an object or enter a valid
- DisplayName - The display name of the activity. This field supports only
- Id - The sys_id of the ServiceNow record that you want to retrieve. Enter a
Stringvariable. To get the sys_id value, you can follow one of the methods shown in the ServiceNow unique record identifier (sys_id) documentation or right-click on the record in the ServiceNow UI and select the Copy sys_id option in the pop-out menu.
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
- ResponseStatus - The status of the request (success/failure information). Enter a
ResponseStatusvariable (UiPath.BAF.Models.ResponseStatus). The
ResponseStatusobject 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.
- Success -
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.
Updated 2 months ago