NIH | National Cancer Institute | NCI Wiki  

WIKI MAINTENANCE NOTICE

Please be advised that NCI Wiki will be undergoing maintenance Monday, July 22nd between 1700 ET and 1800 ET and will be unavailable during this period.
Please ensure all work is saved before said time.

If you have any questions or concerns, please contact the CBIIT Atlassian Management Team.

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

This page is a work in progress.

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

dm_get_dataobject <dataobject-path> [metadata-file] [REST-response]

The following table describes each parameter:

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

An optional path and filename.

  • 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]

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 response header (response from the server) in that file.

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

dm_get_dataobject /TEST_Archive/PI_Lab1/Project_Orig/sample.txt

The basic format of the command output is as follows:

{
    "dataObjects": [
        {
            "dataObject": {...},
            "metadataEntries": {
                "parentMetadataEntries": [...],
                "selfMetadataEntries": [...]
            }
        }
    ]
}

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 Data Details via the GUI

  • No labels