/datasets/{id}/editions/{edition}/versions/{version}/metadata

GET

Get all metadata relevant to a version

Parameters

Name Type Description
edition path An edition of a dataset
id path Id that represents a dataset
version path A version of a dataset

Responses

200: Json object containing all metadata for a version

Example value
{
  "description": "An object containing all metadata information against a version",
  "type": "object",
  "properties": {
    "alerts": {
      "description": "A list of alerts, for example corrections after the resource has been published",
      "type": "array",
      "items": {
        "description": "Important information relating to a version of a dataset",
        "type": "object",
        "properties": {
          "date": {
            "description": "The date and time of when an alert took place",
            "type": "string"
          },
          "description": {
            "description": "Detail of what a user needs to be aware of for this dataset",
            "type": "string"
          },
          "type": {
            "description": "The type of alert",
            "type": "string",
            "example": "correction"
          }
        }
      }
    },
    "contacts": {
      "description": "A list containing contact details of staticians for a dataset",
      "type": "array",
      "items": {
        "description": "A list of objects containing contact information for this dataset",
        "type": "object",
        "properties": {
          "email": {
            "description": "An email address to contact the statistician",
            "type": "string"
          },
          "name": {
            "description": "The name of the statistician",
            "type": "string"
          },
          "telephone": {
            "description": "Telephone number to contact the statistician",
            "type": "string"
          }
        }
      }
    },
    "description": {
      "description": "A description for a dataset",
      "type": "string"
    },
    "dimensions": {
      "description": "A list of codelists for each dimension of this version",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "The dimension description",
            "type": "string"
          },
          "href": {
            "description": "A link to the codelist corresponding to this dimension",
            "type": "string"
          },
          "id": {
            "description": "The codelist id corresponding to this dimension",
            "type": "string"
          },
          "label": {
            "description": "A human readable label for dimension",
            "type": "string"
          },
          "name": {
            "description": "The dimension name",
            "type": "string"
          }
        }
      }
    },
    "distribution": {
      "description": "A list of media types that the version data of an edition of a dataset can be accessed",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "downloads": {
      "description": "A selection of download objects containing information of downloadable files.",
      "type": "object",
      "properties": {
        "csv": {
          "description": "Object containing information of a downloadable file",
          "type": "object",
          "properties": {
            "href": {
              "description": "The URL to the generated file",
              "type": "string"
            },
            "size": {
              "description": "The size of the file in bytes",
              "type": "string"
            }
          }
        },
        "xls": {
          "description": "Object containing information of a downloadable file",
          "type": "object",
          "properties": {
            "href": {
              "description": "The URL to the generated file",
              "type": "string"
            },
            "size": {
              "description": "The size of the file in bytes",
              "type": "string"
            }
          }
        }
      }
    },
    "keywords": {
      "description": "A list of keywords for a dataset",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "latest_changes": {
      "description": "A list of changes between version of an edition for a dataset and the previous version of the same dataset edition",
      "type": "array",
      "items": {
        "description": "A single change between this version and the previous version of an edition for a dataset",
        "type": "object",
        "properties": {
          "description": {
            "description": "A description of what has changed between versions",
            "type": "string"
          },
          "name": {
            "description": "The name of the change that has occurred between versions",
            "type": "string",
            "example": "changes in classification"
          },
          "type": {
            "description": "The type of change",
            "type": "string",
            "example": "summary of changes"
          }
        }
      }
    },
    "license": {
      "description": "The standard Government license right text for the dataset",
      "type": "string"
    },
    "links": {
      "description": "A list of links related to this resource",
      "type": "object",
      "properties": {
        "access_right": {
          "type": "object",
          "properties": {
            "href": {
              "description": "A url to the standard Government access right text for the dataset",
              "type": "string"
            }
          }
        },
        "self": {
          "description": "A link to this resource",
          "type": "object",
          "properties": {
            "href": {
              "description": "A URL to this resource",
              "type": "string"
            }
          },
          "readOnly": true
        },
        "spatial": {
          "type": "object",
          "properties": {
            "href": {
              "description": "A url to a list of geography ranges for the version of the dataset",
              "type": "string"
            }
          }
        },
        "version": {
          "description": "The dataset version this resource belongs to",
          "type": "object",
          "properties": {
            "href": {
              "description": "A URL to the version this resource relates to",
              "type": "string"
            },
            "id": {
              "description": "The version number this resource relates to",
              "type": "string"
            }
          }
        },
        "website_version": {
          "description": "A link to the location of this version of the dataset on the web",
          "type": "object",
          "properties": {
            "href": {
              "description": "The uri to the location of this version of the dataset on the web",
              "type": "string"
            }
          }
        }
      },
      "readOnly": true
    },
    "methodologies": {
      "description": "A list of methodologies for a dataset",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "The description of a methodology",
            "type": "string"
          },
          "href": {
            "description": "The url to a methodology",
            "type": "string"
          },
          "title": {
            "description": "The title of a methodology",
            "type": "string"
          }
        }
      }
    },
    "national_statistic": {
      "description": "The flag indicating the resource is a national statistic. These are certified as compliant with the Code of Practice for Official Statistics",
      "type": "boolean"
    },
    "next_release": {
      "description": "The next release date for a dataset",
      "type": "string"
    },
    "publications": {
      "description": "A list of publications for a dataset",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "description": "The description of a publication",
            "type": "string"
          },
          "href": {
            "description": "The url to a publication",
            "type": "string"
          },
          "title": {
            "description": "The title of a publication",
            "type": "string"
          }
        }
      }
    },
    "publisher": {
      "description": "The publisher of the dataset",
      "type": "object",
      "properties": {
        "href": {
          "description": "A link to the publishers homepage",
          "type": "string"
        },
        "name": {
          "description": "The name of the publisher",
          "type": "string"
        },
        "type": {
          "description": "The type of publisher",
          "type": "string"
        }
      }
    },
    "qmi": {
      "description": "Object containing information on the quality and methodology index of a dataset",
      "type": "object",
      "properties": {
        "description": {
          "description": "The description of a quality and methodology index",
          "type": "string"
        },
        "href": {
          "description": "The url to a quality and methodology index",
          "type": "string"
        },
        "title": {
          "description": "The title of a quality and methodology index",
          "type": "string"
        }
      }
    },
    "related_datasets": {
      "description": "A list of objects containing information of datasets related to a dataset",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "href": {
            "description": "The url to a related dataset",
            "type": "string"
          },
          "title": {
            "description": "The title of a related dataset",
            "type": "string"
          }
        }
      }
    },
    "release_date": {
      "description": "The release date of this version of the dataset",
      "type": "string"
    },
    "release_frequency": {
      "description": "The release frequency of a dataset",
      "type": "string"
    },
    "temporal": {
      "description": "A list of frequencies the dataset covers for a particular period of time",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "end_date": {
            "description": "The end date of the time period in which the version of the dataset covers this frequency",
            "type": "string"
          },
          "frequency": {
            "description": "The time frequency the version of the dataset covers for the period of time between start_date and end_date",
            "type": "string"
          },
          "start_date": {
            "description": "The start date of the time period in which the version of the dataset covers this frequency",
            "type": "string"
          }
        }
      }
    },
    "theme": {
      "description": "The theme for a dataset",
      "type": "string"
    },
    "title": {
      "description": "The title of the dataset",
      "type": "string",
      "example": "CPI"
    },
    "unit_of_measure": {
      "description": "The unit of measure for the dataset observations",
      "type": "string"
    },
    "uri": {
      "description": "The uri to the location of the dataset on the web",
      "type": "string"
    },
    "usage_notes": {
      "description": "A note relating to the dataset. This will appear in downloaded datasets",
      "type": "object",
      "properties": {
        "note": {
          "description": "The content of the note",
          "type": "string"
        },
        "title": {
          "description": "The title of the note",
          "type": "string"
        }
      }
    }
  }
}

400: Invalid request, reasons can be one of the following: * dataset id was incorrect * edition was incorrect

Example value
null

404: Version not found

Example value
null

500: Failed to process the request due to an internal error

Example value
null