NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 20

changes.mady.by.user Frost, Ruth (NIH/NCI) [C]

Saved on

compared with

New Version Current

changes.mady.by.user Frost, Ruth (NIH/NCI) [C]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Deleted based on 1/19 discussion.

...

If your user account has the Read , Write, or Own permission level on a data file in file in DME, the following command allows you to retrieve all metadata associated with that data file:

code
Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_get_dataobject

[

-h

optional 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.
<dataobject-path>
The path to the data file in DME.
[-a <attribute name>]An optional parameter, specifying an attribute to obtain the value of that attribute.
[-D <REST-response>[metadata-file]

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

  • If you specify this parameter, the system creates 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 local system. The system always creates a metadata file:

  • If you specify this parameter, the system saves the metadata in that fileto the specified file in the specified location.
  • If you do not specify 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 system provides 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.

[REST-response]
Include Page
shared info - REST-response parametershared info - REST-response parameter
<dataobject-path>
The path to the data file in DME.

For example, the following command allows you to view the metadata associated with the sample.txt data file:

code
Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_get_dataobject

/Example_Archive/PI_Lab1/Project_Orig/sample.txt


The basic format of the command output is as follows:

...

In this format, the "dataObject" and "selfMetadataEntries" elements provide information about the file you specified, while the "parentMetadataEntries" element provides information about the collection that contains the file you specified. For instructions on performing a similar task in the GUI, refer to Viewing Metadata via the GUI.