patch

Overview

This endpoint is used for updating information about a version.

HTTP Request

GET /api/v1/datasets/:datasetReference/versions/:tag|"current"|"next"

Path parameters

Parameter
datasetReference	A qualified reference to the dataset. See referencing resources for more information.
tag	The version's tag, of the form v1.0 Alternatively, you may specify current or next , which will return the current (latest) or next (pending) version, respectively.

This endpoint extends the general API structure.

Request body

Provide a JSON object with version fields to update.

Property name	Type	Description
label	string	A user-provided label for the version.
releaseNotes	string	Version release notes. May be up to 5000 characters.

Authorization

Edit access to the corresponding dataset is required. Your access token must have the following scope:

• data.edit

Learn more about authorization.

Response body

Returns a JSON representation of a version.get resource.