Migrate a dataset to a data model (Beta)

POST

/v2/datasets/:datasetId/migrate

Migrate a dataset (deprecated) to a data model. The response always includes the dataset’s link details and its link and reference counts. For more information on how datasets are migrated to data models, see Migrate a dataset to a data model.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

Retrieve the datasetId by calling the /v2/datasets endpoint.
To skip the migration and return only the dataset’s link details and its link and reference counts, pass dryRun: true.

Usage scenarios

Plan dataset migration: Pass dryRun: true to review the datasets and connection tables linked to the dataset, and how many documents reference it, before you migrate.
Migrate datasets in bulk: If you want to migrate several datasets, you can use this endpoint to programmatically migrate the datasets returned by /v2/datasets with a migrationStatus of not-migrated.

Migrate a dataset (deprecated) to a data model. The response always includes the dataset's link details and its link and reference counts. For more information on how datasets are migrated to data models, see [Migrate a dataset to a data model](https://help.sigmacomputing.com/docs/migrate-a-dataset-to-a-data-model). **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **datasetId** by calling the [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) endpoint. - To skip the migration and return only the dataset's link details and its link and reference counts, pass `dryRun: true`. ### Usage scenarios - **Plan dataset migration**: Pass `dryRun: true` to review the datasets and connection tables linked to the dataset, and how many documents reference it, before you migrate. - **Migrate datasets in bulk**: If you want to migrate several datasets, you can use this endpoint to programmatically migrate the datasets returned by [/v2/datasets](https://help.sigmacomputing.com/reference/list-datasets) with a `migrationStatus` of `not-migrated`.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

datasetIdstringRequired

Request

The request body.

shouldUpdateReferencesbooleanRequired

Whether to update references in workbooks that use this dataset to point to the new data model.

destFolderIdstringOptional

Optional destination folder ID where the data model should be created. If not provided, the data model will be created in the same folder as the dataset.

dryRunbooleanOptional

If true, do not perform the migration. Only return the link details and the link and reference counts. Defaults to false.

Response

The response body.

dataModelIdstring or null

ID of the newly-created data model. Null when dryRun is true.

linkslist of objects

All datasets or connection tables linked to this dataset. Each can be a source, target, or part of a series of links.

linkCountdouble

Number of links the dataset has to other datasets.

referenceCountdouble

Number of references from other datasets to this dataset.

$	curl -X POST https://api.sigmacomputing.com/v2/datasets/datasetId/migrate \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"shouldUpdateReferences": true
>	}'

1	{
2	"dataModelId": "string",
3	"links": [
4	{
5	"source": {
6	"datasetId": "string",
7	"type": "dataset"
8	},
9	"target": {
10	"datasetId": "string",
11	"type": "dataset"
12	}
13	}
14	],
15	"linkCount": 1.1,
16	"referenceCount": 1.1
17	}