Dataset Exports¶
create¶
HTTP Request
POST https://api.solvebio.com/v2/dataset_exports
Parameters
This request does not accept any URL parameters.
Authorization
This request requires an authorized user with read permission for the dataset.
Request Body
In the request body, provide an object with the following properties:
| Property | Value | Description |
|---|---|---|
| dataset_id | integer | A valid dataset ID. |
| format | string | The export file format. |
| params | object | Dataset query parameters. |
| target_full_path | string | (optional) vault location to store the export output (must be a SolveBio full path). |
| priority | integer | (optional) A priority to assign to this task. |
| send_email_on_completion | boolean | (optional) An email is sent when the export is ready (default: false) |
The following export formats (format property) are available:
| Format | Description | Extension |
|---|---|---|
| json | JSONL format, gzipped. | .json.gz |
| csv | Comma-separated format | .csv |
| csv-expand | Comma-separated format, with expanded list values | .csv |
| excel | Excel (XLSX) format | .xlsx |
| excel-expand | Excel (XLSX) format, with list values expanded | .xlsx |
When using an "expanded" mode, fields containing list values (multiple distinct values) will be expanded into independent columns in the output. This is useful in some downstream applications that do not natively support list within columns.
The following query parameters (params property) are supported for exports:
| Property | Value | Description |
|---|---|---|
| limit | integer | The number of records to export (between 1 and 1,000,000). |
| filters | objects | A valid filter object. |
| fields | string | A list of fields to include in the results. |
| exclude_fields | string | A list of fields to exclude in the results. |
| query | string | A valid query string. |
Please note that facets and offset parameters are not supported for dataset exports.
Response
The response contains a single DatasetExport resource.
delete¶
HTTP Request
DELETE https://api.solvebio.com/v2/dataset_exports/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with write permissions on the dataset.
Request Body
Do not supply a request body with this method.
Response
The response returns "HTTP 200 OK" when successful.
download¶
Dataset export expiry
Dataset exports may expire after 24 hours, after which the download URL will not work. Please re-run the export if necessary.
HTTP Request
GET https://api.solvebio.com/v2/dataset_exports/{ID}/download
Parameters
This request accepts the following parameter:
| Parameter | Value | Description |
|---|---|---|
| redirect | boolean | Return a 302 redirect to the download location (default: true). |
Authorization
This request requires an authorized user with read permission on the dataset.
Response
When using redirect mode (default), the response is a 302 redirect which redirects to the location of the file.
When redirect mode is disabled, the response has the following structure:
| Property | Value | Description |
|---|---|---|
| url | string | The URL to the file. |
get¶
HTTP Request
GET https://api.solvebio.com/v2/dataset_exports/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with read permission on the dataset.
Request Body
Do not supply a request body with this method.
Response
The response contains a DatasetExport resource.
list¶
HTTP Request
GET https://api.solvebio.com/v2/datasets/{DATASET_ID}/exports
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 exports. |
Authorization
This request requires an authorized user with read permission on the dataset.
Response
The response contains a list of DatasetExport resources.
cancel¶
HTTP Request
PUT https://api.solvebio.com/v2/datasets_exports/{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 DatasetExport object (see create above) with status = canceled.
Response
The response will contain a DatasetExport resource with the status canceled.