Restore dataset to a previous version

Restores the dataset to a previous version state. All draft items are replaced with items from the specified version. If the version is not the latest, a new version snapshot is created. If the version is the latest, only draft items are replaced (revert functionality).

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

version_refstringRequired>=1 character

Version hash or tag to restore from

Response

Version restored successfully

idstring or nullformat: "uuid"

dataset_idstring or nullformat: "uuid"

version_hashstring or null

tagslist of strings or null

items_totalinteger or null

Total number of items in this version

items_addedinteger or null

Number of items added since last version

items_modifiedinteger or null

Number of items modified since last version

items_deletedinteger or null

Number of items deleted since last version

change_descriptionstring or null

metadatamap from strings to strings or null

created_atstring or nullformat: "date-time"

created_bystring or null

last_updated_atstring or nullformat: "date-time"

last_updated_bystring or null

1	curl -X POST http://localhost:5173/api/v1/private/datasets/id/versions/restore \
2	-H "Content-Type: application/json" \
3	-d '{
4	"version_ref": "string"
5	}'

1	{
2	"id": "string",
3	"dataset_id": "string",
4	"version_hash": "string",
5	"tags": [
6	"string"
7	],
8	"items_total": 1,
9	"items_added": 1,
10	"items_modified": 1,
11	"items_deleted": 1,
12	"change_description": "string",
13	"metadata": {},
14	"created_at": "2024-01-15T09:30:00Z",
15	"created_by": "string",
16	"last_updated_at": "2024-01-15T09:30:00Z",
17	"last_updated_by": "string"
18	}

Path parameters

Request

Response

Errors