USusgs
Harvest

Retrieve information about metadata records in the SDC database.

Retrieve information such as harvest dates, record validation, data source, title, etc. for metadata records in the SDC database using the parameters below.

Parameters

  • pid: Persistent identifier for the metadata record in the format USGS:xxxxxxx, e.g., USGS:5a0b1033e4b09af898cb6e7a
  • doi: Digital object identifier in the format of a valid URL, e.g., https://doi.org/10.5066/P9ZRJ3XU
  • title: Title provided in the metadata record
  • author: Authors of the data listed in the metadata record
  • data_source_name: Name of the USGS science center or program that is responsible for creating and maintaining the metadata and data.
  • harvest_source_name: Name of the repository that is providing the metadata records to the SDC. See a complete list below under HarvestSourceEnum schema.
  • page: Page number of the results set. Default is the first page represented by 1.
  • size: Number of results to return per request. Default is 10.
  • sort_by: Field to sort the results by. Options are:
    • pid (default)
    • title
    • harvest_date
    • modified_date
    • status: Date that a file was last indexed; this will be null if the file has not been indexed
    • harvest_source_name
    • data_source_name
  • sort_desc: Sort results in descending order by field specified in sort_by; true/false
get/datacatalog/api/harvest/files

Request

  • Base URL
    https://data.usgs.gov (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Query parameters

sort_descboolean nullable
pidstring nullable
doistring nullable
titlestring nullable
authorstring nullable
data_source_namestring nullable
harvest_source_namestring nullable
pageinteger
sizeinteger
sort_bystring

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Changes

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