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 each single-line code, replaced the Code Block macro with a Panel macro and Text to Copy macro.

...

  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. Include Page
    shared step - create or update parent collection while registering data file
    shared step - create or update parent collection while registering data file
  3. Run the following command:

    code
    Panel
    borderColorsilver
    borderStylesolid
    Clipboard

    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 register. 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 register.

For example, the following command registers the data.txt file from the JaneDoe folder in the file system to the Project_New collection in DME:

code
Panel
borderColorsilver
borderStylesolid
Clipboard

dm_register_dataobject_presigned

/cygdrive/c/Users/JaneDoe/my-metadata.json

/Example_Archive/PI_Lab1/Project_New

/cygdrive/c/Users/JaneDoe/data.txt