NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Copied from the "Downloading a Single File to Your File System via the CLU" page.
Excerpt
hiddentrue

dm_register_dataobject_multipart

If your user account has the Read, Write, or Own permission level on a collection, the following command allows you to download a data file in that collection to your file system:

Code Block
dm_download_dataobject [optional parameters] <source-path> <destination-file>

(The dm_download_dataobject_presigned command is no longer supported.) 

The following table describes each parameter:

ParameterDescription
[-h]If you want to print a usage (help) message for this command, specify this option.
[-D <REST-response>]

An optional parameter, specifying a path and filename in your file system. The system always creates a response file:

  • If you specify this parameter, the system saves the response from the server to the specified file in the specified location.
  • If you do not specify this parameter, the system saves the file as download-dataobject-response-header.tmp in your home directory.
<source-path>
A path within DME. Specify the data file that you want to download.
<destination-file>
A path in your file system. Specify where you want the system to create the downloaded file. The destination folder structure you specify must already exist.

The following example downloads a sample.txt file from the Project_Orig collection in DME to a JaneDoe folder in Windows. 

Code Block
dm_download_dataobject /Example_Archive/PI_Lab1/Project_Orig/sample.txt /cygdrive/c/Users/JaneDoe