/datasets

GET

Returns a list of all datasets provided by the ONS that can be filtered using the filter API

Responses

200: A json list containing datasets which have been published

Example value
{
  "description": "A list of datasets",
  "type": "object",
  "properties": {
    "count": {
      "description": "The number of datasets returned",
      "type": "integer",
      "readOnly": true
    },
    "items": {
      "type": "array",
      "items": {
        "description": "A model for the response body when getting a dataset",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "description": "An unique id for a dataset",
                "type": "string",
                "readOnly": true,
                "example": "DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC"
              }
            }
          },
          {
            "description": "The dataset",
            "type": "object",
            "properties": {
              "collection_id": {
                "description": "The id of the unpublished collection (of datasets) that this dataset is associated with",
                "type": "string"
              },
              "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"
              },
              "keywords": {
                "description": "A list of keywords for a dataset",
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "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_rights": {
                    "type": "object",
                    "properties": {
                      "href": {
                        "description": "A url to the standard Government access right text for the dataset",
                        "type": "string"
                      }
                    }
                  },
                  "editions": {
                    "type": "object",
                    "properties": {
                      "href": {
                        "description": "A URL to all editions for this dataset",
                        "type": "string",
                        "example": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions"
                      }
                    },
                    "readOnly": true
                  },
                  "latest_version": {
                    "description": "An object containing the latest version id and link",
                    "type": "object",
                    "properties": {
                      "href": {
                        "description": "A link to the latest version and edition of the dataset",
                        "type": "string",
                        "example": "http://localhost:8080/datasets/DE3BC0B6-D6C4-4E20-917E-95D7EA8C91DC/editions/2017/versions/2"
                      },
                      "id": {
                        "description": "The unique id for the latest version of a dataset",
                        "type": "string"
                      }
                    },
                    "readOnly": true
                  },
                  "self": {
                    "description": "A link to this resource",
                    "type": "object",
                    "properties": {
                      "href": {
                        "description": "A URL to this resource",
                        "type": "string"
                      }
                    },
                    "readOnly": true
                  },
                  "taxonomy": {
                    "description": "A link to the taxonomy of the dataset",
                    "type": "object",
                    "properties": {
                      "href": {
                        "description": "A url to the taxonomy of the dataset",
                        "type": "string"
                      }
                    }
                  }
                }
              },
              "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_frequency": {
                "description": "The release frequency of a dataset",
                "type": "string"
              },
              "state": {
                "description": "The state of the resource, can only be one of the following:\n  * created\n  * completed (instances only)\n  * failed (instances only)\n  * edition-confirmed (instances and versions only)\n  * associated (not editions)\n  * published\n",
                "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 this resource on the web",
                "type": "string"
              }
            }
          }
        ]
      }
    },
    "limit": {
      "description": "The number of datasets requested",
      "type": "integer"
    },
    "offset": {
      "description": "The first row of datasets to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter",
      "type": "integer"
    },
    "total_count": {
      "description": "The total number of datasets",
      "type": "integer",
      "readOnly": true
    }
  }
}

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

Example value
null