Skip to main content

Get File Comments

UiPath.Box.Activities.File.GetFileComments

The Get File Comments activity uses the Box List file comments API to retrieve the comments from a specified file (File Id).

After retrieving the comments, the activity outputs an BoxComment[] object (Comments) that includes the comment details.

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 Box Scope activity to your project.
  3. Add an activity or run an external process that outputs a File.Id value (e.g., Upload File, Search for Content, etc.).
  4. Add the Get File Comments activity inside the Box Scope activity.
  5. Enter a value for the Input property.
  6. Create and enter a BoxComment[] variable for the Output property.

    • Your input property values are sent in the List file comments API operation request.

    • The operation returns the BoxComment[] value to your output property variable.

      docs image

Properties​

Common​

  • ContinueOnError - Specifies if you want the activity to continue running when an error is thrown. This field supports only Boolean values.
  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Input​

  • File ID - The ID of the file that you want to retrieve comments from. This field supports only Strings or String variables. To get the File ID value, add an activity or run an external process that outputs a File.Id object (e.g., Upload File, Search for Content, etc.).

Misc​

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

Output​

  • Comments - The <IEnumerable<BoxComment> object that includes the comment details. Enter a BoxComment[] variable. The BoxComment[] object includes multiple properties that you can use in other activities.