Dataset Fields¶
create¶
HTTP Request
POST https://api.solvebio.com/v2/dataset_fields
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with write permission on the dataset.
Request Body
In the request body, provide an object with the following properties:
| Property | Value | Description |
|---|---|---|
| data_type | string | A valid data type (see below). |
| description | string | Describes the contents of the field. |
| entity_type | string | A valid entity type (see below). |
| expression | string | A valid expression. |
| is_hidden | boolean | Set to True if the field should be excluded by default from the UI. |
| is_list | boolean | Set to True if multiple values are stored as a list. |
| name | string | The "low-level" field name, used in JSON formatted records. |
| ordering | integer | The order in which this column appears when retrieving data from the dataset. Order is 0-based. Default is 0 |
| title | string | The field's display name, shown in the UI and in CSV/Excel exports. |
| url_template | string | A URL template with one or more "{value}" sections that will be interpolated with the field value and displayed as a link in the dataset table |
Field names are immutable once set. The title and description of a field can always be changed.
Data Types¶
| Data Type | Description |
|---|---|
auto (default) |
Attempt to automatically detect the data type upon the first import. |
boolean |
Either True, False, or null. |
date |
A string in ISO 8601 format, for example: "2017-03-29T14:52:01". |
double |
A double-precision 64-bit IEEE 754 floating point. |
float |
single-precision 32-bit IEEE 754 floating point. |
integer |
A signed 32-bit integer with a minimum value of -231 and a maximum value of 231-1. |
long |
A signed 64-bit integer with a minimum value of -263 and a maximum value of 263-1. |
object |
A key/value, JSON-like object, similar to a Python dictionary. |
string |
A valid UTF-8 string up to 32,766 characters in length. |
text |
A valid UTF-8 string of any length, indexed for full-text search. |
blob |
A valid UTF-8 string of any length, not indexed for search. |
Field data types are immutable once they are set. Use dataset migrations to modify data types.
Entity Types¶
| Type | Description | Example |
|---|---|---|
| dataset | SolveBio dataset ID | 510110013133189334 |
| gene | A gene | EGFR |
| genomic_region | A genomic region | GRCH38-7-55019017-55211628 |
| literature | A PubMed ID | 19915526 |
| sample | A sample identifier | TCGA-02-0001 |
| variant | A genomic variant | GRCH38-7-55181378-55181378-T |
Response
The response contains a single DatasetField resource.
get¶
HTTP Request
GET https://api.solvebio.com/v2/dataset_fields/{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 DatasetField resource.
list¶
HTTP Request
GET https://api.solvebio.com/v2/datasets/{DATASET_ID}/fields
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 on the dataset.
Response
The response contains a list of DatasetField resources.
update¶
HTTP Request
PUT https://api.solvebio.com/v2/dataset_fields/{ID}
Parameters
This request does not accept URL parameters.
Authorization
This request requires an authorized user with write permission on the dataset.
Request Body
In the request body, provide a valid DatasetField object (see create above).
Response
The response contains the updated DatasetField resource.