Export Metadata

Export Datasets & Resources as JSON

GET https://data.website/api/datasets/export.json

Download the list of all dataset metadata as a JSON array.

Query Parameters

Name	Type	Description
format	string	Filter datasets which contain at least one file of this format (eg: csv, spreadsheet, pdf, xml)

200 Cake successfully retrieved.

[
  {
    "id": "93ab473e-e20d-4784-b464-12024997889c",
    "slug": "street-cafe-licences-in-leeds",
    "parent": "1c58ec82-1ac9-4e53-bc9b-57d33febed93",
    "state": "active",
    "sharing": "public",
    "licence": "ogl-v3",
    "createdAt": "2015-10-01T15:40:13.000Z",
    "updatedAt": "2019-01-16T08:03:17.574Z",
    "next_review_date": "2019-10-01",
    "leeds_is_developer_dataset": false,
    "_canRead": [
      "#public"
    ],
    "_appearsIn": [
      "1c58ec82-1ac9-4e53-bc9b-57d33febed93",
      "bf6234fe-7efe-422f-8ba4-595b1a675066"
    ],
    "title": "Street café licences in Leeds",
    "author": "Leeds City Council",
    "maintainer": "Richard Brook",
    "author_email": "[e-mail]",
    "licence_notes": "",
    "odi-certificate": "",
    "maintainer_email": "[e-mail]",
    "update_frequency": "Annually",
    "leeds_attribution": "<p>Click this link for information: <a href=\"https://www.leeds.gov.uk/opendata/terms-and-licences\" target=\"_blank\" rel=\"nofollow\">https://www.leeds.gov.uk/opendata/terms-and-licences</a>\r\n</p>",
    "leeds_service_list": "Local economic development",
    "leeds_subject_list": "Business and industry",
    "leeds_spatial_coverage": "City and Hunslet",
    "leeds_technical_documentation": "",
    "readonly": {
      "parent": {
        "id": "1c58ec82-1ac9-4e53-bc9b-57d33febed93",
        "slug": "leedscitycouncil",
        "title": "Leeds City Council",
        "img": "https://airdrive-images.s3-eu-west-1.amazonaws.com/leeds/img/publisher/2018-05-25T16%3A33%3A57.91/leedscitycouncil.jpg",
        ...
      },
      "rootOrg": {
        ...
      },
      "licence": {
        "title": "UK Open Government Licence (OGL v3)",
        "url": "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
        "is_okd_compliant": true
      },
      "topics": {
        "4de24888-f9ba-11e4-8954-08002750a12e": {
          "title": "Tourism",
          "img": "https://airdrive-images.s3-eu-west-1.amazonaws.com/leeds/img/topic/2018-11-01T18%3A43%3A08.76/tourism.png",
          "slug": "tourism",
          "description": ""
        },
        ...
      },
      "auth": {
        "package_update": false
      }
    },
    "tags": [
      "tourism",
      "cafes",
      "business",
      "licence",
      "restaurants",
      "cafe",
      "restaurant",
      "age friendly",
      "Supporting Leeds",
      "food"
    ]
  },
  ...
]

Export Datasets & Resources (Excel spreadsheet)

GET https://data.website/api/datasets/export.xlsx

Download an Excel workbook containing two worksheets: A table of datasets, and a table of resources.

200

OUTPUT: Excel XLSX file
-----------------------
NOTE: The workbook has two tabs: 'datasets' and 'resources'.

Export Datasets (CSV)

GET https://data.website/api/datasets/export.datasets.csv

Download a CSV table of all the datasets.

Path Parameters

Name	Type	Description
	string

200

OUTPUT: CSV file
----------------
NOTE: The resources (files) in each dataset are not included.

Export Resources (CSV)

GET https://data.website/api/datasets/export.resources.csv

Download a CSV table of all the resources (files) in this data portal.

Path Parameters

Name	Type	Description
	string

200

OUTPUT: CSV file
----------------
NOTE: The 'dataset' column is a foreign key
referencing the 'slug' in the dataset table.

Export Datasets & Resources (CSV, zipped)

GET https://data.website/api/datasets/export.zip

Download a ZIP file containing two CSVs: datasets.csv and resources.csv.

200