# Save-VaultFile Downloads a file from Vault to a local directory. ## Syntax ```powershell Save-VaultFile -File [-DownloadDirectory ] [-Version ] [-ExcludeChildren] [-NoRecursiveChildren] [-NotOverride] [-IncludeAttachments] [-IncludeHiddenEntities] [-IncludeParents] [-RecursiveParents][-IncludeRelatedDocumentation] [] ``` ## Parameters | Type | Name | Description | Default value | Optional | | |-----------------|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|----------|-----| | String | File | Path to the file, which should be downloaded | | no | | | String | DownloadDirectory | Absolute Path to a local file. If NOT set, it will download the file to the vault workspace.
If the target directory doesn't exist it will be created | | yes | | | Enum | Version | Version of the related files to be downloaded.
Possible values are: *Latest*, *Actual* and *Revision* | Latest | yes | | | SwitchParameter | ExcludeChildren | Children of the source file will be excluded | | yes | | | SwitchParameter | NoRecursiveChildren | Only the first level of children will be included | | yes | | | SwitchParameter | ExcludeLibaryContents | Entities that are a part of a Vault Library will be excluded | | yes | | | SwitchParameter | NotOverride | Folder/Files will not be overwritten, if they already exists | | yes | | | SwitchParameter | IncludeAttachments | Attachments of the file will be included | | yes | | | SwitchParameter | IncludeHiddenEntities | Hidden entities will be included | | yes | | | SwitchParameter | IncludeParents | Parents of the source file will be included | | yes | | | SwitchParameter | RecursiveParents | Parents will be included recursively | | yes | | | SwitchParameter | IncludeRelatedDocumentation | The related documentation of the source file will be included.
For example, a DWG might be considered related documentation for an assembly. The DWG is not considered an attachment or a dependent | | yes | | ## Return type [File[]]() ← on success\ **empty** ← on failure. Exception/ErrorMessage can be accessed using [\$Error](). ## Remarks The cmdlet downloads a file from the Vault Server to a local directory. The result of the cmdlet contains a list of all the downloaded files.\ Each of those files have an additional property '*LocalPath*' containing the full path (including the file name) of the downloaded file. ## Examples **Download a File** ```powershell $result = Save-VaultFile -File "$/Designs/Sample/Not.iam" -DownloadDirectory "C:\temp\Vault\Sample\" $result[0].LocalPath #Returns C:\temp\Vault\Sample\Not.iam ``` **Download a File to the vault workspace including related documentation files** ```powershell $result = Save-VaultFile -File "$/Designs/Sample/Not.iam" -IncludeRelatedDocumentation ```