Data Release

Get the status of a Globus file transfer task.

Get the status and details of a Globus file transfer task.

Use this endpoint to check on a transfer previously submitted through any of the transfer endpoints -- globus-transfer-in, globus-transfer-out, and their component counterparts. Each of those endpoints returns a task_id in its response data; pass that value here as the task_id path parameter to poll the transfer's progress and outcome.

The task is looked up using the requesting user's Globus credentials, so a user can only retrieve tasks they submitted.

The response data contains the Globus transfer task document. Notable fields include:

  • status: The task's current state -- ACTIVE (in progress), SUCCEEDED (completed successfully), or FAILED.
  • task_id: The Globus task identifier.
  • files_transferred: The number of files transferred so far.
  • bytes_transferred: The number of bytes transferred so far.
  • source_endpoint_id / destination_endpoint_id: The collections involved in the transfer.
  • request_time / completion_time: When the task was submitted and, if finished, when it completed.

See the Globus Transfer API get_task documentation for the full set of fields: https://docs.globus.org/api/transfer/task/#get_task_by_id.

.. code-block::

{
    "success": true,
    "message": "Request processed successfully",
    "data": {
        "task_id": "<Globus task ID>",
        "status": "SUCCEEDED",
        "files_transferred": 3,
        "bytes_transferred": 10240,
        "source_endpoint_id": "<Globus collection ID>",
        "destination_endpoint_id": "<Globus collection ID>"
    }
}

:param task_id: The Globus transfer task ID returned by a transfer endpoint. :param token: A valid bearer token for the user. :returns: A success :class:GetTaskInfoResponse whose data is the Globus transfer task document, passed through unchanged. :raises GlobusTransferTaskNotFound: If the task does not exist or is not accessible to the requesting user (returned as 404 Not Found).

get/datacatalog/api/data-release/files/task/{task_id}

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

task_idstring required

Response

Successful Response

successboolean required

A boolean (true/false) indicating if the request was successful.

dataobject

The Globus transfer task document. See https://docs.globus.org/api/transfer/task/#get_task_by_id for the full set of fields.

Changes

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