CKAN Requests

Legacy applications using the CKAN API can use these compatibility endpoints to read and export the data catalogue.

current_package_list_with_resources

GET https://data.website/api/action/current_package_list_with_resources

Returns a list of the site's datasets ("packages" in CKAN) and their resources. The list is sorted recently-modified first.

{
  "success": true,
  "result": [
    {
      "owner_org": "5b858cb2-5c92-4b2b-8c1d-141cfc330d9c",
      "maintainer": "",
      "relationships_as_object": [],
      "relationships_as_subject": [],
      "private": false,
      "maintainer_email": "",
      "num_tags": 0,
      "odi-certificate": null,
      "revision_id": null,
      "title": "GLA Code of Statistics",
      "id": "75f7b64c-ef7e-4f45-9b03-6f194b6785b8",
      "metadata_created": "2018-08-09T13:06:01.791Z",
      "metadata_modified": "2018-12-19T15:49:33.503Z",
      "author": "GLA",
      "author_email": "Statistics@london.gov.uk",
      "state": "active",
      "notes": "<p>This timetable shows the advance publication dates of statistics published by the GLA Group under voluntary application of the UK Statistics Authority Code of Practice.</p>\n<p>\n<br>\n</p>\n<h3>List of GLA Group Statistics</h3>\n<p>This document lists statistics published by the GLA Group under voluntary application of the UK Statistics Authority Code of Practice.</p>\n<p>\n<br>\n</p>\n<h3>Advanced Publication Timetable</h3>\n<p>This timetable shows the advance publication dates of statistics published by the GLA Group under voluntary application of the UK Statistics Authority Code of Practice.</p>",
      "notes_markdown": "This timetable shows the advance publication dates of statistics published by the GLA Group under voluntary application of the UK Statistics Authority Code of Practice.\n\n\n\nList of GLA Group Statistics\nThis document lists statistics published by the GLA Group under voluntary application of the UK Statistics Authority Code of Practice.\n\n\n\nAdvanced Publication Timetable\nThis timetable shows the advance publication dates of statistics published by the GLA Group under voluntary application of the UK Statistics Authority Code of Practice.",
      "version": null,
      "license_id": "",
      "type": "dataset",
      "num_resources": 3,
      "name": "code-of-statistics",
      "isopen": null,
      "url": null,
      "license_text": null,
      "license_title": "Not Specified",
      "creator_user_id": null,
      "tags": [],
      "groups": [
        {
          "id": "1d5852ed-0315-4472-927a-3d1bdaa4f630",
          "display_name": "Transparency",
          "title": "Transparency",
          "description": "",
          "name": "transparency",
          "image_display_url": "https://airdrive-images.s3-eu-west-1.amazonaws.com/london/img/topic/2018-11-01T18%3A46%3A24.62/transparency.png"
        }
      ],
      "resources": [
        {
          "position": 2,
          "url": "https://airdrive-secure.s3-eu-west-1.amazonaws.com/london/dataset/advance-publication-timetable/2018-08-09T14%3A23%3A39/Compliance%20statement.pdf",
          "format": "pdf",
          "name": "GLA code of statistics compliance statement.pdf",
          "description": null,
          "package_id": "75f7b64c-ef7e-4f45-9b03-6f194b6785b8",
          "hash": "6b7d229cbbafec17b10f587c6e4ada51",
          "created": "2018-08-09T14:23:40.987Z",
          "size": 147172,
          "last_modified": null,
          "id": "163051ae-7bf4-46a9-adc6-80f40afe6822",
          "url_type": null,
          "webstore_url": null,
          "webstore_last_updated": null,
          "cache_url": null,
          "resource_type": null,
          "cache_last_updated": null,
          "datastore_json": {},
          "lazyboy_json": {},
          "revision_id": null,
          "mimetype": null,
          "mimetype_inner": null,
          "state": "active"
        },
        {
          "position": 0,
          "url": "https://airdrive-secure.s3-eu-west-1.amazonaws.com/london/dataset/code-of-statistics/2018-11-21T16%3A50%3A52/GLA%20and%20functional%20bodies%20statistics.docx",
          "format": "document",
          "name": "GLA and functional bodies statistics.docx",
          "description": null,
          "package_id": "75f7b64c-ef7e-4f45-9b03-6f194b6785b8",
          "hash": "5fb1a3a9233156fa881fe9e63d300c35",
          "created": "2018-11-21T16:50:54.108Z",
          "size": 31146,
          "last_modified": null,
          "id": "c504324c-b3e7-4982-8582-f03c1c0b8ff3",
          "url_type": null,
          "webstore_url": null,
          "webstore_last_updated": null,
          "cache_url": null,
          "resource_type": null,
          "cache_last_updated": null,
          "datastore_json": {},
          "lazyboy_json": {},
          "revision_id": null,
          "mimetype": null,
          "mimetype_inner": null,
          "state": "active"
        },
        {
          "position": 1,
          "url": "https://airdrive-secure.s3-eu-west-1.amazonaws.com/london/dataset/code-of-statistics/2018-12-19T15%3A49%3A30/GLA%20and%20Functional%20Bodies%20Advance%20Publication%20Timetable.xlsx",
          "format": "spreadsheet",
          "name": "GLA and Functional Bodies Advance Publication Timetable.xlsx",
          "description": null,
          "package_id": "75f7b64c-ef7e-4f45-9b03-6f194b6785b8",
          "hash": "1459a78772bdd5631af2d0fba42bf7e0",
          "created": "2018-12-19T15:49:31.681Z",
          "size": 30473,
          "last_modified": null,
          "id": "c7049207-f879-43fc-ac79-069acaeb25a4",
          "url_type": null,
          "webstore_url": null,
          "webstore_last_updated": null,
          "cache_url": null,
          "resource_type": null,
          "cache_last_updated": null,
          "datastore_json": {},
          "lazyboy_json": {},
          "revision_id": null,
          "mimetype": null,
          "mimetype_inner": null,
          "state": "active"
        }
      ],
      "organization": {
        "title": "Greater London Authority (GLA)",
        "id": "5b858cb2-5c92-4b2b-8c1d-141cfc330d9c",
        "image_url": "https://airdrive-images.s3-eu-west-1.amazonaws.com/london/img/publisher/2018-05-25T16%3A48%3A43.94/gla.png",
        "is_organization": true,
        "name": "gla",
        "revision_id": null,
        "type": "organization",
        "description": "The GLA is a strategic regional authority, with powers over transport, policing, economic development, and fire and emergency planning. Three functional bodies — Transport for London, the Mayor's Office for Policing and Crime, and London Fire and Emergency Planning Authority — are responsible for delivery of services in these areas. ",
        "state": "active",
        "approval_status": "approved",
        "created": "2014-10-01T12:57:27.134Z"
      }
    },
    ...
  ]
}

package_list

GET https://data.website/api/action/package_list

Returns a list of the site's datasets ("packages" in CKAN) by slug. You can query individual datasets using CKAN's /api/action/package_show?id=$slug

{
  "success": true,
  "result": [
    "19-year-olds-qualified-to-nvq-level-3",
    "1a---1c-eynsham-drive-public-consultation",
    "2010-2013-gla-budget-detail",
    ...
  ]
}

package_show

GET https://data.website/api/action/package_show

Return the metadata of a dataset ("package" in CKAN) and its resources. The fields are renamed to match the output of a CKAN site. Additionally, the `notes` field supports full HTML, and comes with `notes_markdown` to provide a friendly version of the dataset description for harvesters.

Query Parameters

NameTypeDescription

id

string

Slug or UUID

{
  "success": true,
  "result": {
    "owner_org": "e7246a83-9b58-4662-b240-3fe876d6fae6",
    "maintainer": "Opinion Research and General Statistics (GLA)",
    "relationships_as_object": [],
    "relationships_as_subject": [],
    "private": false,
    "maintainer_email": "datastore@london.gov.uk",
    "num_tags": 7,
    "revision_id": null,
    "title": "Active People Survey KPI Data, Borough",
    "id": "711246ab-55e5-46e3-83cc-26fd36d46406",
    "metadata_created": "2012-12-01T15:34:51.000Z",
    "metadata_modified": "2014-07-04T14:24:58.000Z",
    "author": "Sport England",
    "author_email": "",
    "state": "active",
    "notes": "<p>Key Performance Indicators from Active People Survey (APS).</p>",
    "notes_markdown": "Key Performance Indicators from Active People Survey (APS).",
    "email_notify_maintainer": false,
    "version": null,
    "license_id": "ogl-v2",
    "type": "dataset",
    "num_resources": 0,
    "email_notify_author": false,
    "name": "active-people-survey-kpi-data-borough",
    "isopen": null,
    "url": null,
    "license_text": null,
    "license_title": "UK Open Government Licence (OGL v2)",
    "creator_user_id": null,
    "tags": [
      {
        "vocabulary_id": null,
        "state": "active",
        "display_name": "sport",
        "id": null,
        "name": "sport"
      },
      ...
    ],
    "groups": [
      {
        "id": "4199df0d-d454-4373-b710-aeed29098a59",
        "display_name": "Health",
        "title": "Health",
        "description": "",
        "name": "health",
        "image_display_url": "https://airdrive-images.s3-eu-west-1.amazonaws.com/london/img/topic/2018-11-01T18%3A45%3A28.38/health.png"
      },
      ...
    ],
    "resources": [],
    "organization": {
      "title": "Sport England",
      "id": "e7246a83-9b58-4662-b240-3fe876d6fae6",
      "image_url": "https://airdrive-images.s3-eu-west-1.amazonaws.com/london/img/publisher/2018-05-25T16%3A54%3A43.39/sport-england.png",
      "is_organization": true,
      "name": "sport-england",
      "revision_id": null,
      "type": "organization",
      "description": "",
      "state": "active",
      "approval_status": "approved",
      "created": "2014-10-01T12:57:31.928Z"
    }
  }
}

package_search

GET https://data.website/api/action/package_search

Searches the data catalogue and returns CKAN-style packages. Accepts the same querystring format as `/api/datasets` (see [Export Metadata](/datapress/export-metadata)).

Query Parameters

NameTypeDescription

q

string

Free text search string

size

string

Number of rows (packages) to return. Default 10.

from

integer

Row offset used to paginate through the results.

resources.format

string

Filter on the resources `format` field, eg. `api`, `csv` or `spreadsheet`.

parent

string

UUID of the parent team.

datastore_search

GET https://data.website/api/action/datastore_search

CKAN-style wrapper around /api/table/:id.

Path Parameters

NameTypeDescription

id

string

UUID of the

PreviousUpdating a Dataset

Last updated