OFoffice-of-national-statistics

Get Dataset Metadata

Changed on

Retrieve the matching dataset metadata, given the survey_id and period_id.

Parameters: survey_id (str): The survey id of the dataset being queried. period_id (str): The period id of the dataset being queried.

get/v1/dataset_metadata

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

survey_idstring nullable
period_idstring nullable

Response

Successful Response

dataset_idstring required
survey_idstring required
period_idstring required
form_typesstring[] required
sds_published_atstring required
total_reporting_unitsinteger required
sds_dataset_versioninteger required
filenamestring required
titlestring nullable

Changes

  • 9a87e51baf13Revision changes
    • info

      api operation id get_dataset_metadata_collection_v1_dataset_metadata_get removed and replaced with Get_dataset_metadata_v1_dataset_metadata_get

    • info

      endpoint deprecated

  • 0b183cf4153bRevision changes
    • breaking

      removed the required property / from the response with the status