v1

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

Update a code list

Update an code list of a specific instance in the specific recipe and update in mongo

put/recipes/{recipe_id}/instances/{dataset_id}/code-lists/{code_list_id}

Path parameters

recipe_idstring required

A unique id for a recipe

dataset_idstring required

An id for an instance in the recipe

code_list_idstring required

An id for codelist in an instance of a recipe

Request body

idstring

A unique id for a single code list

namestring

The name of the codelist

hrefstring

A URL to the code list

is_hierarchyboolean

A bool to inform if there is hierarchy for codelist

Example request

{
  "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 code list updates