OFoffice-of-national-statistics

Get Schema Metadata

Changed on

Get all schema metadata associated with a specific survey id.

Parameters: survey_id (str): survey id of the collection schema_processor_service (SchemaProcessorService): injected dependency for processing the metadata collection.

get/v1/schema_metadata

Request

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

Query parameters

survey_idstring nullable

Response

Successful Response

survey_idstring required
schema_locationstring required
sds_schema_versioninteger required
sds_published_atstring required
schema_versionstring required
titlestring required
guidstring required

Changes

  • 9a87e51baf13Revision changes
    • info

      api operation id get_schema_metadata_collection_v1_schema_metadata_get removed and replaced with Get_Schema_Metadata_v1_schema_metadata_get

    • info

      endpoint deprecated

  • d3f01a32165fRevision changes
    • info

      query request parameter survey_id list-of-types was widened by adding types null

    • info

      for the query request parameter survey_id, the type was generalized from string to no type