List Documents

UiPath.DocuSign.Activities.EnvelopeList.ListDocuments

The List Documents activity uses the DocuSign eSignature API to get a list of documents in an envelope.

There are a number of optional filters you can use with this activity to affect the list of items that are returned.

How it works

The following steps are 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 DocuSign Scope activity to your project.
3. Add the List Documents activity inside the DocuSign Scope activity.
4. Enter values for the properties located inside the body of the activity.
5. Create and enter a ResponseStatus variable for the Output property.

In the Body of the Activity

• Account Id - The account id to create an envelope in. This field supports only Strings or String variables. This is either an account number (int) or account ID (GUID).
• Envelope Id - The envelope id. This field supports only Strings or String variables.
• Documents by UserId - If true, allows recipients to get documents by their user id. This field supports only Boolean variables. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.
• Include Document Size - Whether or not to include the document size. This field supports only Boolean variables.
• Include Metadata - Whether or not to include meta data. This field supports only Boolean variables. If true, includes metadata that indicates which properties the sender can edit.
• Include Tabs - Whether or not to include tabs. This field supports only Boolean variables. If true, information about the tabs associated with the documents are included
• Recipient Id - Allows the sender to retrieve the documents as one of the recipients that they control. Enter a String variable. The (Documents by UserId) parameter must be set to false for this to work.
• Shared User Id - The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This field supports only String variables. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the RADmin console).
• Envelope Documents Result - The documents included in the envelope. This field supports only EnvelopeDocumentsResult variables.

Properties

Common

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

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). This field supports only ResponseStatus variables.