v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-2391313.3 KB

Public

Get a list of recipes

Returns a paged list of recipes

get/recipes

Query parameters

limitinteger

Maximum number of items that will be returned. A value of zero will return zero items. The default value is 20, and the maximum limit allowed is 1000

offsetinteger

Starting index of the items array that will be returned. By default it is zero, meaning that the returned items will start from the beginning.

Response

A list of recipes

countnumber

The number of recipes returned

total_countnumber

The total number of recipes

offsetnumber

The first row of resources to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter

limitnumber

The number of items per page

Example response

{
  "items": [
    {
      "id": "b944be78-f56d-409b-9ebd-ab2b77ffe187",
      "alias": "CPI COICOP",
      "files": [
        {
          "description": "CPI COICOP v4"
        }
      ],
      "output_instances": [
        {
          "dataset_id": "931a8a2a-0dc8-42b6-a884-7b6054ed3b68",
          "editions": [
            "Time-series"
          ],
          "title": "UK consumer price inflation",
          "code_lists": [
            {
              "id": "e44de4c4-d39e-4e2f-942b-3ca10584d078",
              "name": "calendar-years",
              "href": "http://localhost:22300/code-lists/e44de4c4-d39e-4e2f-942b-3ca10584d0782"
            }
          ]
        }
      ],
      "cantabular_blob": "People"
    }
  ]
}