NIH | National Cancer Institute | NCI Wiki  

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 10 Next »

If your user account has the Read, Write, or Own permission level on a data file in DME, you can search for that data. You can generate a list of such data files that match a search query. You can also specify a search path to narrow the search. The list provides the full path to each file in DME. 

To search for data:

  1. In your file system, create a JSON file that specifies a search query. (For more information, TBD)
  2. Run the following command:

    dm_query_dataobject [-D REST-response] [-o output-file] <criteria.json> [search-path]

    The following table describes each parameter: 

    ParameterDescription
    [-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 query-dataobject-response-header.tmp in your home directory.
    [-o <output-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 query-dataobject-response-message.json.tmp in your home directory.
    <criteria.json>
    A path and filename for a JSON file in your file system, containing the compound query for the search.
    [search-path]
    An optional parameter, specifying the path to the collection in DME in which you want to search.

For example, consider the following criteria.json file.

TBD

With the above criteria.json file, the following command generates a list of data files in DME.

TBD
  • No labels