HUhubmapconsortium

Retracts a dataset after it has been published. Requires a json body with a single field {retraction_reason: string}. The dataset for the given id is modified to include this new retraction_reason field and sets the dataset property sub_status to Retracted. The complete modified dataset is returned. Requires that the dataset being retracted has already been published (dataset.status == Published. Requires a user token with membership in the HuBMAP-Data-Admin group otherwise then a 403 will be returned.

Changed on
put/datasets/{id}/retract

Request

  • Base URL
    https://entity.api.hubmapconsortium.org
  • Auth
    • API key in header Authorization
    • or none

Path parameters

idstring required

The unique identifier of entity. This identifier can be either a HubMAP ID (e.g. HBM123.ABCD.456) or UUID

Request body

retraction_reasonstring

Free text describing why the dataset was retracted

Response

The complete dataset with modified sub_status and retraction_reason

object required

Changes