catalog.url module

Functions that return the URL to a ScienceBase resource.

Function

Description

catalog

Returns the base URL of the ScienceBase catalog

extents

Returns the base URL use to query extent type info

item

Returns the URL to a ScienceBase catalog item

parent

Returns the URL to the PWFDF parent item

search

Returns the base URL for searching the catalog

status

Returns the URL to the catalog status page
pwfdf_api.catalog.url.catalog()

Returns the base URL for the ScienceBase catalog

catalog()

Returns the base URL for the ScienceBase catalog

Outputs:

str – The URL of the ScienceBase catalog

pwfdf_api.catalog.url.extents()

Returns the base URL for an extent type info query

extents()

Returns the base URL for an extent type info query. These URLs can be used to determine the extent IDs associated with a given extent type.

Outputs:

str – The base URL for an extent type info query

pwfdf_api.catalog.url.item(id)

Returns the base URL for a ScienceBase catalog item

item(id)

Returns the base URL for a ScienceBase catalog item. Querying this URL will return sbJSON metadata on the associated item.

Inputs:

  • id (str) – A ScienceBase item ID as a string

Outputs:

str – The base URL for the item

pwfdf_api.catalog.url.parent()

Returns the base URL for the PWFDF parent item

parent()

Returns the base URL for the PWFDF parent item. Querying this URL will return sbJSON metadata for the overall collection.

Outputs:

str – The base URL for the PWFDF parent item

pwfdf_api.catalog.url.status()

Returns the base URL for the ScienceBase catalog status

status()

Returns the URL for the ScienceBase catalog status page.

Outputs:

str – The URL of the ScienceBase catalog status page