Skip to navigation

Update a curriculum container

View as Markdown

Updates a container’s own fields: title, description, creditPoints, creditPointsMax and sort.

Neither the owner nor the parent moves: attaching goes through PUT /{structureId}/owner, and re-parenting isn’t supported. Omitted fields are cleared.

Authentication

AuthorizationBearer

Paste a Keycloak access token (no "Bearer " prefix)

Path parameters

structureIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
titlestringOptional
e.g. "Core Subjects".
descriptionstringOptional
The requirement in words, e.g. "Students must take 30 UOC of the following subjects."
creditPointsintegerOptional
UOC that must be taken from this container.
creditPointsMaxintegerOptional

Upper bound, where the handbook states one. Must not be less than creditPoints.

sortintegerOptional
Position among siblings. Defaults to 0.

Response

The container was updated.
idstringOptionalformat: "uuid"
parentIdstringOptionalformat: "uuid"
Null for a root container.
titlestringOptional
descriptionstringOptional
creditPointsintegerOptional
creditPointsMaxintegerOptional
sortintegerOptional
statusstringOptional

DRAFT | LIVE. DRAFT is hidden from normal curriculum reads and keeps the tree's placement editable.

unplacedbooleanOptional

True while this container belongs to no program or specialisation. Place it with PUT /{structureId}/owner or /{structureId}/parent.

Errors

400
Bad Request Error
404
Not Found Error