OFoffice-of-national-statistics
Private

Update the state of a version

Changed on

Update the state of a version of a static dataset.

put/datasets/{id}/editions/{edition}/versions/{version}/state

Request

  • Base URL
    https://api.beta.ons.gov.uk/v1
  • Auth
    API key in header Authorization

Path parameters

idstring required

ID that represents a dataset

editionstring required

An edition of a dataset

versionstring required

A version of a dataset

Request body

state'created' | 'completed' | 'failed' | 'edition-confirmed' | 'associated' | 'published'

The state of the resource, can only be one of the following:

  • created
  • completed (instances only)
  • failed (instances only)
  • edition-confirmed (instances and versions only)
  • associated (not editions)
  • published

Example request

{
  "state": "published"
}

Response

State updated successfully

Changes