USusgs
Data Release

Update the status of a data release.

Update the status of a data release.

Only admins are allowed to update a release to Published.

Notification emails:

When **send_email** is True, a notification email is sent on the
following status transitions:

* ``Created`` -> ``Submitted``
* ``Under Revision`` -> ``Revision Submitted``

Each notification goes to the same set of recipients:

* the current user,
* the Data Release Team, and
* the Science Center Data Manager(s), if applicable.

:param item_id: The ID of the release.
:param data: StatusEnum for the desired status.
:param send_email: boolean If True, send a notification email when the status transition is one of those listed above. Transitions other than those listed do not generate a notification, regardless of this value. :params update_doi: boolean if true, update the AIS DOI on publish.

put/datacatalog/api/data-release/{id}/status

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

Request body

status'Created' | 'Submitted' | 'Locked' | 'Provisional' | 'Published' | 'Under Revision' | 'Revision Submitted' | 'Revised' | 'Deprecated' required

The status of a data release within the curation process.

created = "Created" Default status when a record is first created in the repository. submitted = "Submitted" Data release has been submitted to the curation team locked = "Locked" Data release is not public but has been locked to edits to allow for an external review period. provisional = "Provisional" Data release is subject to revision and has been released prior to Bureau approval to meet an immediate need. published = "Published" Data release has received Bureau approval and is publicly available. underRevision = "Under Revision" Data release is being revised. The dataset metadata may be available but files are not accessible. revisionSubmitted = "Revision Submitted" Data release has been submitted to the curation team for revision. revised = "Revised" Data release has been revised. deprecated = "Deprecated" Data release was previously published but access to the data files needed to be removed due to errors or sensitivity converns.

send_emailboolean

If True, send a notification email

update_doiboolean

If True, update AIS DOI on publish.

Response

Successful Response

successboolean required

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

Changes

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