v1

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

Update an instance

Update an instance of recipe by getting the specific instance and recipe by id and update in mongo

put/recipes/{recipe_id}/instances/{dataset_id}

Path parameters

recipe_idstring required

A unique id for a recipe

dataset_idstring required

An id for an instance in the recipe

Request body

dataset_idstring

A unique id for a dataset

editionsstring[]

Types of editions within the dataset

titlestring

The title for the dataset

Example request

{
  "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"
    }
  ]
}

Response

Specific recipe updated successfully with given instance updates