Delete Attachment

UiPath.ServiceNow.Activities.DeleteAttachment

The Delete Attachment activity uses the the ServiceNow Attachment - DELETE API to delete a specific file (ObjectSysId).

After deleting the attachment, 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).

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 ServiceNow Scope activity to your project.
3. Add the Delete Attachment activity inside the ServiceNow Scope activity.
4. Enter a value for the Input properties.
5. Create and enter ResponseStatus variable for the Output properties.
   • Your input property value is sent to the Attachment - DELETE API.
   • The API returns the ResponseStatus value to your output property variable.
     
     

     

     
     

Properties

Common

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

Input

• ObjectSysId - The sys_id of the attachment you want to delete. Enter a String or String variable. 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.

Misc

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

Output

• AttachmentId - The sys_id of the attachment. Enter a String a variable. The variable you create for this property can be used as an input variable in subsequent activities (e.g., Get ServiceNow Record, Download Attachment, etc.).
• ServiceNowStatus - 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.