Get Documents

UiPath.DocuSign.Activities.Envelope.GetDocuments

The Get Documents activity uses the DocuSign eSignature API to download a document, set of documents, or otherwise get a list of documents from an envelope.

To download all documents as a single PDF or ZIP, specify the (Local Folder Path) parameter. Otherwise it will return the list of documents as an output parameter (Documents).

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 Get 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.
• Envelope Id - The ID of the envelope. This field supports only Strings or String variables.
• Local Folder Path - The folder location to download the file to. This field supports only Strings or String variables.
• Optional Parameters - A set of optional parameters. Enter a Dictionary<string,string> or Dictionary<string,string> variable.
  • There are 9 optional parms which are all strings
  • An example is New Dictionary(Of String, String) From {{"0", "string"}, {"1", "string2"}}

Properties

Common

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

Misc

• Download Type - Get documents as a PDF file or as a ZIP archive.
• 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.