![]() |
Page History
Excerpt | ||
---|---|---|
| ||
dm_get_collection |
Note |
---|
This page is a work in progress. |
The following command gets all metadata associated with a collection:
If your user account has the Read permission level on a collection in DME, the following command allows you to retrieve all metadata associated with that collection:
Panel | |||||
---|---|---|---|---|---|
| |||||
| |||||
|
The following table describes each parameter:
Parameter | Description | |||||
---|---|---|---|---|---|---|
[- | path>The path to the collection. | h] | If you want to print a usage (help) message for this command, specify this option. | |||
[-D <REST-response> | [metadata-file] | An optional parameter, specifying a path and filename in your local system. The system always creates a response file:
| creates
| and saves the metadata in that file
| do not specify
| prints the metadata to standard output
|
[ | REST-o <metadata- | responsefile>] | An optional parameter, specifying a path and filename in your local system. The system always creates a metadata file:
| creates
| response header in that file.
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. | |
<collection-path> | The path to the collection in DME. |
For example, the following command allows you to retrieve the metadata associated with the PI_Lab1 collection:
Panel | |||||
---|---|---|---|---|---|
| |||||
|
The basic format of the command output is as follows:
Code Block |
---|
{
"collections": [
{
"collection": {...},
"metadataEntries": {
"parentMetadataEntries": [...],
"selfMetadataEntries": [...]
}
}
]
} |
In this format, the "collection" and "selfMetadataEntries" elements provide information about the collection you specified, while the "parentMetadataEntries" element provides information about the collection that contains the collection you specifiedFor instructions on performing the same task in the GUI, refer to Viewing Data Details via the GUI.