NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added an example.

...

ParameterDescription
<description.json>

A path to a file in your file system. The contents of this file depend on the source of your data:

  • If you are uploading from your file system, specify the metadata that you want to upload. Click the following link to view the syntax:

    Code Block
    collapsetrue
    { 
        "metadataEntries": [
          {
            "attribute": "description",
            "value": "my-dataObject-description"
          },
          {
            "attribute": "my-second-attribute-name",
            "value": "my-second-attribute-value"
          }
        ]
    }
  • If you are uploading from Globus, specify the Globus endpoint, the file path on that endpoint, and the metadata that you want to upload. Click the following link to view the syntax:

    Code Block
    collapsetrue
    { 
      "source": {
        "fileContainerId": "globus-shared-endpoint-uid",
        "fileId": "file-path-on-shared-globus-endpoint"
      },
      "metadataEntries": [
        {
          "attribute": "description",
          "value": "my-file-description"
        }, 
        {
          "attribute": "my-second-attribute-name",
          "value": "my-second-attribute-description"
        }
      ]
    }
<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 to a file in your file system:

  • If you are uploading from your file system, use this parameter to specify the file that you want to upload.
  • If you are uploading from Globus, omit this parameter.

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

Code Block
dm_register_dataobject my-metadata.json /TEST_Archive/PI_Lab1/Project_New /cygdrive/c/Users/JaneDoe/data.txt

For instructions on performing similar tasks in the GUI, refer to the following pages:

...