Versions

Update Version

Partially update a version of a given dataset.

Update metadata or change latest tag.

Only the dataset's owner or a user with ADMIN user role can do this operation.

patch/dataset/{dataset}/{version}

Request

  • Base URL: https://data-api.globalforestwatch.org (the document declares no server; this is the origin it was published from)
  • URL: https://data-api.globalforestwatch.org/dataset/{dataset}/{version}
  • Auth: OAuth 2 (password, token URL /token)

Path parameters

datasetstring required
versionstring required

Request body

is_downloadableboolean

Flag to specify if assets associated with version can be downloaded.If not set, value will default to settings of underlying dataset

is_latestboolean

Indicate if the current version should be tagged latest. This will cause redirects from {dataset}/latest to {dataset}/{current_version}.When tagging a version to latest any other version currently tagged latest will be untagged.

Example request

{
  "metadata": {
    "content_date_range": {
      "start_date": "2000-01-01",
      "end_date": "2021-04-06"
    },
    "content_date_description": "2000 - present"
  }
}

Response

Successful Response

statusstring

Example response

{
  "data": {
    "metadata": {
      "content_date_range": {
        "start_date": "2000-01-01",
        "end_date": "2021-04-06"
      },
      "content_date_description": "2000 - present"
    }
  }
}

Changes

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