Dynamiq
Datasets

Update a dataset version

Replaces a draft version's item schema. Only draft versions are editable; updating a released version returns 400. The new schema must remain compatible with every existing item, otherwise the request is rejected.

PUT
/v1/dataset-versions/{dataset_version_id}

Authorization

personalAccessToken
AuthorizationBearer <token>

Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.

In: header

Path Parameters

dataset_version_id*string

Dataset version UUID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/dataset-versions/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
    "version": 0,
    "status": "draft",
    "schema": {
      "type": "any",
      "properties": {
        "property1": {
          "type": "any",
          "properties": {},
          "required": true
        },
        "property2": {
          "type": "any",
          "properties": {},
          "required": true
        }
      },
      "required": true
    },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "created_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    },
    "updated_by": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "first_name": "string",
      "last_name": "string",
      "avatar_url": "string"
    }
  }
}
{
  "error": {
    "code": "bad_request",
    "message": "Bad Request",
    "details": {
      "input": "cannot be blank"
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Delete a dataset version

Deletes a draft version and all of its items. Released versions cannot be deleted and return `400`.

Download a dataset version

Streams a dataset version's items as a downloadable file (`Content-Disposition: attachment; filename="<dataset_version_id>.<format>"`). The body is the array of item `data` objects, serialized as a JSON array (`format=json`, the default) or as newline-delimited JSON (`format=jsonl`).