NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterDescription
<description.json>

A path to a file in your file system.

In

The contents of this file

, specify the metadata that you want to upload and optionally specify Globus information. For details, refer to the following files in the HPC_DME_APIs\utils\templates folder

depend on the source of your data:

  • If you are uploading from your file system,

refer to dataobject-sync-metadata.json.
  • specify the metadata that you want to upload:

    Code Block
    { 
        "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

, refer to dataobject-async-metadata.json.
  • endpoint, the file path on that endpoint, and the metadata that you want to upload:

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

...