Data Release

Transfer files from a data release component to an external Globus collection.

Transfer files out from a data release component to an external Globus collection.

This endpoint takes a JSON payload consisting of a destination_collection_id string and either a files_to_transfer list (paths relative to the component directory) or a transfer_all flag. When transfer_all is true, the entire component directory is transferred. Set recursive to true to transfer directory entries listed in files_to_transfer.

The transfer mirrors the component's directory structure in the destination collection, i.e. files land under a <release_id>/<component_name>/ directory. Files are placed relative to the destination collection's default directory; supply destination_path to target a specific directory the destination endpoint permits writes to (files then land under <destination_path>/<release_id>/<component_name>/).

A file path cannot contain any of the following characters: < > : " / \ | ? *.

.. code-block::

{
    "destination_collection_id": "<Globus collection ID>",
    "destination_path": "globus-connect-personal",
    "files_to_transfer": ["example.xml", "data/subset.csv"],
    "recursive": false
}

Alternatively, transfer everything:

.. code-block::

{
    "destination_collection_id": "<Globus collection ID>",
    "transfer_all": true
}

The response data includes a task_id for the submitted transfer. Poll the transfer's status with GET /data-release/files/task/{task_id}.

:param id: The ID of the data release component. :param params: The JSON payload containing the destination_collection_id and either files_to_transfer or transfer_all.

post/datacatalog/api/component/{id}/files/globus-transfer-out

Request

  • Base URL
    https://data.usgs.gov (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Authorization code: https://auth.globus.org/v2/oauth2/authorize?scope=openid
    Token URL: https://data.usgs.gov/datacatalog/api/auth/login

Path parameters

idstring required

Request body

destination_collection_idstring required
destination_pathstring

Directory within the destination collection to transfer files into, relative to that collection's default directory. Files are mirrored under <destination_path>/<release_id>/.... Leave empty to use the collection's default directory. Set this to a directory the destination endpoint permits writes to (for Globus Connect Personal, one of its configured accessible directories).

files_to_transferstring[] nullable

Paths, relative to the data release or component directory, of the files or directories to transfer out to the destination collection. Directory entries require recursive to be true. Mutually exclusive with transfer_all.

transfer_allboolean

When true, transfer the entire data release directory (including all component files) or the entire component directory. Mutually exclusive with files_to_transfer.

recursiveboolean

When true, entries in files_to_transfer that refer to directories are transferred recursively.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.