NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: For HPCDATAMGM-1142: Added link pointing to page tree I had drafted for API back in August.

...

  1. In your file system, create a JSON file that specifies a search query. ( For more information, TBD)refer to Building a Query to Search for Data via the CLU
  2. Run the following command:

    Code Block
    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.

...