Data Release

Get components by release.

Retrieves a paginated list of data release components from Globus Search.

The returned value is in the following form:

.. code-block::

{
    "data": {
        "published": [<published_document>],
        "draft": [<draft_document>]
    },
    "count": int,
    "has_next_page": int,
    "limit": int,
    "offset: int,
    "total: int,
}

where at least one of the "published" or "draft" entries must be present. If the Globus Search subject has an entry with name "Published", its document will be placed under <published_document>. If the Globus Search entry has other entries, the document for the last such entry will be placed under <draft_document>. This method does not ensure that only one draft-type entry is present.

If no entries exist under the given Globus Search subject or if Globus Search returns a 404 error, this method will raise a 404 error. If Globus Search returns an error other than a 404, a 500 error will be raised.

If a bearer token is included, the response will contain items which are visible to the identity associated with the token. If no bearer token is included the response will only contain items which are publicly visible.

:param id: The ID (Globus Search subject) of the data release. :param limit: The size of a page of results :param offset: An offset for pagination. :optional_param token: A valid bearer token for the user. :return: A JSON document as described above.

get/datacatalog/api/data-release/{id}/components

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

Query parameters

qstring
limitinteger
offsetinteger
sortstring
sort_dirstring

Request body

object[] nullable required

Response

Successful Response

successboolean required

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

countinteger required

Count of items in response.

has_next_pageboolean required

A boolean (true/false) indicating if more items are available.

limitinteger required

The number of items to return in a response.

offsetinteger required

The number of items skipped in the result set.

totalinteger required

The total number of items.

Changes

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