NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: For HPCDATAMGM-1077: Added new options.

...

Code Block
dm_get_dataobject [-hoptional parameters] <dataobject-path> [metadata-file] [REST-response]

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 omit this parameter, the system saves the file as get-item-response-header.tmp in your home directory.
[-o <metadata-file>]

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

  • If you specify this parameter, the system saves the metadata to the specified file in the specified location.
  • If you omit this parameter, the system prints the metadata to standard output and saves the file as get-item-response-message.json.tmp in your home directory.

The metadata includes information about the data file, a list of attribute values for the file, and a list of attribute values for the parent collection.

<dataobject-path> 
The path to the data file in DME.
[metadata-file]

An optional path and filename in your file system.

  • If you specify this parameter, the system creates the specified file in the specified location and saves the metadata in that file.
  • If you do not specify this parameter, the system prints the metadata to standard output.

The system provides information about the data file, a list of attribute values for the file, and a list of attribute values for the parent collection.

[REST-response]

Include Page
shared info - REST-response parameter
shared info - REST-response parameter

...