Upload Note Attachment

UiPath.MicrosoftDynamics.Activities.UploadNoteAttachment

The Upload Note Attachment activity uses the Web API PATCH operation to upload an attachment to an annotation (note).

After uploading the attachment, 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 an annotation identifier (e.g., Insert Record, Search Records).
4. Add the Upload Note Attachment activity inside the Microsoft Dynamics Application Scope activity.
5. Enter values for the Input properties.
6. Create and enter a ResponseStatus variable for the Output property.
   • Your input property values are sent in the Web API PATCH operation request.
   • The operation 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

• NoteId - The identifier assigned to the annotation that you want to upload an attachment to. This field supports only Strings or String variables. To get the NoteId (i.e. annotationid) value, use an activity or run an external process that outputs an annotation identifier (e.g., Insert Record, Search Records).
• File - The complete local path to the file that you want to upload. This field supports only Strings or String variables. Only one file can be attached to a note. If a note has an existing attachment, this activity replaces that one with the file you enter in this property.

Misc

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

Options

• MimeType - Optional mime type of the attached file.

Output

• AttachmentId - The identifier assigned to the attachment that was uploaded. This field supports only String variables. To delete an attachment, you can use the AttachmentId variable in a Delete Record activity; select the ActivityMimeAttactment object.
• 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.
    Note: This activity does not output an AttachmentId (like the Upload Activity Attachment activity) because a note can only have one attachment. This is also the reason the Download Note Attachment does not have an AttachmentId input property (like the Download Activity Attachment).

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.