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-1311: Added statement about 2 GB.
Excerpt
hiddentrue

dm_register_dataobject_presigned

If both of the following conditions are true, you can upload a data file to an existing collection in DME: 

...

The dm_register_dataobject_presigned command gets a pre-signed URL from DME and uses it to upload data directly to the NCI Data Vault, instead of through DME. If the file is larger than two GB, refer to Using dm_register_dataobject_multipart

To register a data file:

  1. In your file system, create a JSON file that specifies the metadata for the new data file, as follows:

    Code Block
    { 
        "generateUploadRequestURL" : true,
        "metadataEntries": [
          {
            "attribute": "description",
            "value": "my-dataObject-description"
          },
          {
            "attribute": "my-second-attribute-name",
            "value": "my-second-attribute-value"
          }
        ]
    }
  2. Run the following command:

    Code Block
    dm_register_dataobject_presigned [optional parameters] <description.json> <destination-path> <source-file>

    The following table describes each parameter:

    ParameterDescription
    [-h]
    If you want to print a usage (help) message for this command, specify this option.
    [-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 dataObject-registration-response-header.tmp in your home directory.
    [-o <output-json-file>]

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

    • If you specify this parameter, the system saves the output to the specified file in the specified location.
    • If you omit this parameter, the system saves the output as dataObject-registration-response-message.json.tmp in your home directory. 

    If the command is successful, the output file is empty.

    <description.json>
    A path to the JSON file that specifies the metadata for the new data file.
    <destination-path>
    A path within DME, including the name of the file you intend to upload. Specify where you want the system to create the new data file.
    <source-file>

    A path in your file system, specifying the data file that you want to upload.

...