Skip to content

Dataset Templates

create

HTTP Request

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

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with appropriate permissions.

Request Body

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

Property Value Description
fields objects A list of valid dataset fields.
name string A short name for the new template.
description string A description for the template.

Response

The response contains the new DatasetTemplate resource.

delete

HTTP Request

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

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with write permissions on the resource.

Request Body

Do not supply a request body with this method.

Response

The response returns "HTTP 200 OK" when successful.

generate

HTTP Request

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

Parameters

This request does not accept URL parameters.

Authorization

This request requires an authorized user with permission.

Request Body

Do not supply a body in this request.

Response

The response contains an unsaved DatasetTemplate object for the specified dataset.

get

HTTP Request

GET https://api.solvebio.com/v2/dataset_templates/{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 DatasetTemplate resource.

list

HTTP Request

GET https://api.solvebio.com/v2/dataset_templates

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 resources visible to the requesting user.