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.
Request
- Base URLhttps://data.usgs.gov (the document declares no server; this is the origin it was published from)
- AuthOAuth 2Authorization code: https://auth.globus.org/v2/oauth2/authorize?scope=openidToken URL: https://data.usgs.gov/datacatalog/api/auth/login
Path parameters
Request body
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.