Skip to content

Dataset Migrations

create

HTTP Request

POST https://api.solvebio.com/v2/dataset_migrations

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with read permissions from the source dataset, and write permissions to the target dataset.

Request Body

In the request body, provide an object with the following properties:

Property Value Description
commit_mode string A valid commit mode.
include_errors boolean If True, a new field (_errors) will be added to each record containing expression evaluation errors (default: True).
source_id integer The ID of a valid, queryable dataset.
source_params object The query parameters used on the source dataset (see below).
target_fields objects A list of valid dataset fields to create or override in the target dataset.
target_id integer A valid dataset with write permissions.
validation_params object (optional) Configuration parameters for validation.

The following query parameters (source_params property) are supported for migrations:

Property Value Description
limit integer The number of records to migrate from the source dataset.
filters objects A valid filter object.
fields string A list of fields to include from the source dataset.
exclude_fields string A list of fields to exclude from the source dataset.
query string A valid query string.

Response

The response contains a new DatasetMigration resource.

delete

Not recommended

Deleting dataset migrations is not recommended as data provenance will be lost.

HTTP Request

DELETE https://api.solvebio.com/v2/dataset_migrations/{ID}

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with write permissions.

Request Body

Do not supply a request body with this method.

Response

The response returns "HTTP 200 OK" when successful.

get

HTTP Request

GET https://api.solvebio.com/v2/dataset_migrations/{ID}

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with permission.

Request Body

Do not supply a request body with this method.

Response

The response contains a DatasetMigration resource.

list

HTTP Request

GET https://api.solvebio.com/v2/dataset/{DATASET_ID}/migrations

Parameters

This request accepts the following parameters:

Parameter Value Description
limit integer The number of objects to return per page.
offset integer The offset within the list of available objects.

Authorization

This request requires an authorized user with read permission.

Response

The response contains a list of DatasetMigration resources from the specified source dataset.

cancel

HTTP Request

PUT https://api.solvebio.com/v2/datasets_migrations/{ID}/cancel

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with read permission on the dataset.

Request Body

In the request body, provide a valid DatasetMigration object (see create above) with status = canceled.

Response

The response will contain a DatasetMigration resource with the status canceled.