DownloadDocumentFile
Download a document file.
Example:
EXEC DownloadDocumentFile DocumentId='1234', DownloadLocation='C:/Users/Public/cover.png'
Note about LockDocument: The user who checked the document out and the Document Owner can check it back in. If the user or Document Owner is not available then a Vault Owner or Administrator must undo the checkout. Otherwise, the document cannot progress.
Input
| Name | Type | Required | Accepts Output Streams | Description |
| DocumentId | String | True | False | Required. The document id field value. |
| DownloadLocation | String | False | False | Optional. The location where to download the file. For example, C:/Users/Public/Desktop/document.docx |
| FileStream | String | False | True | An instance of an output stream where file data is written to. Only used if DownloadLocation is not set. |
| LockDocument | String | False | False | Optional. Set to true to Check Out this document before retrieval. |
Result Set Columns
| Name | Type | Description |
| Success | String | Whether the document was downloaded successfully. |
| FileData | String | File data that will be outputted encoded in Base64 if the DownloadLocation and FileStream inpus are empty. |
| FileName | String | The name of the file that was downloaded if included in the response. |