Sign in
Datasets - Data

Update Publication Status

Transition a dataset's publication status following allowed paths.

The allowed set comes from the workflow extension's allowed_transitions(), so an overlay may define its own. The community default is draft -> ready -> internal -> published (and back one step).

patch/datasets/{dataset_id}/status/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

dataset_idstring uuid required

Request body

statusstring required

Example request

{
  "status": "published"
}

Response

Successful Response

idstring required
record_statusstring required
metadata_warningsstring[] nullable

Advisory warnings from the status change — the same inherited-keyword disclosure check the metadata PATCH runs. The transition has already applied.

Example response

{
  "id": "0190f4c8-8c6a-7a21-9a34-13bc2f31dc02",
  "record_status": "published"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.