logo
Documentation Powered by ReDoc

Isabl API (v1)

Download OpenAPI specification:Download

E-mail: medinaj@mskcc.org License: MIT License Terms of Service

Advanced Lookups

All query parameters in this API support advanced lookup types:

Lookup Type Description Example
! Negate any query name!=isabel
[i]exact Exact match name__exact=isabel
name__iexact=IsAbeL
[i]contains Value contains query name__contains=isa
name__icontains=iSa
[i]startswith Value starts with query name__startswith=isab
name__istartswith=iSab
[i]endswith Value starts with query name__endswith=bel
name__iendswith=bEl
in Comma separated query name__in=isabel,gunes
isnull Value is null name__isnull=true
regex Use regex pattern name__regex=isabel
gt Greater than total__gt=1
gte Greater or equal total__gte=1
lt Less than total__lt=1
lte Less than or equal total__lte=1

Datetime Filters

Datetime query parameters support extra lookups. These lookups can be combined with those previously described:

Lookup Type Description Example
No lookup, ISO format required created=
date Filter by date YYYY-MM-DD. created__date=2016-06-04
created__date__gt=2016-06-04
day Filter by day DD created__day=04
month Filter by month MM created__month=06
year Filter by year YYYY created__year=2016
time Filter by time HH-MM-SS created__time=21:00:51

Related Filters

This API supports filters that traverse the relational schema:

<related_filter>__<related_field>=<query>

Authentication

Basic

Security Scheme Type HTTP
HTTP Authorization Scheme basic

aliquots

aliquots_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

id
number

Filter by id.

identifier
string

Filter by identifier.

modified
string

Modified datetime filter.

notes
string

Filter by notes.

pk
number

Filter by id.

sample
storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

submission
system_id
string

Filter by system_id.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
identifier
required
string (Identifier) <= 100 characters

Instance Identifier.

notes
string (Notes) Nullable

Free text field to keep notes on object.

required
object (Sample)
storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

submission
integer (Submission) Nullable
Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

aliquots_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

aliquots_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
identifier
required
string (Identifier) <= 100 characters

Instance Identifier.

notes
string (Notes) Nullable

Free text field to keep notes on object.

required
object (Sample)
storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

aliquots_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
identifier
required
string (Identifier) <= 100 characters

Instance Identifier.

notes
string (Notes) Nullable

Free text field to keep notes on object.

required
object (Sample)
storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

aliquots_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

analyses

analyses_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

analyses
application
cached_fields
string

Filter by cached_fields.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

description
string

Filter by application__description.

finished
string

Finished datetime filter.

id
number

Filter by id.

individual_level_analysis
indivpkual_level_analysis
modified
string

Modified datetime filter.

name
string

Filter by application__name.

notes
string

Filter by notes.

pk
number

Filter by id.

previous_status
string

Filter by previous_status.

project_level_analysis
projects
ran_by
string

Filter by ran_by.

references
results
string

Filter by results.

run_time
number

Filter by run_time.

started
string

Started datetime filter.

status
string

Filter by status.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

submitted
string

Submitted datetime filter.

tags
string

Filter by tags__name.

targets
uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

version
string

Filter by application__version.

wait_time
number

Filter by wait_time.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
analyses
Array of integers Nullable

Linked analyses. GET value limited to 50 analyses, POST unlimited.

required
object (Application)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
object (Individual)
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Project level analysis) Nullable
ran_by
string (Ran by) Nullable ^[\w.@+-]+$
Array of objects (Experiment) Nullable
Default: []
results
string (Analysis results as reported by application.) Nullable
status
string (Status)
Default: "CREATED"
Enum: "CREATED" "FAILED" "FINISHED" "IN_PROGRESS" "STAGED" "STARTED" "SUBMITTED" "SUCCEEDED"

Analysis current status.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
Array of objects (Experiment) Nullable
Default: []

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Efficiently bulk update the status of many analyses.

If status is SUBMITTED, time fields will be reset.

Authorizations:
Basic
Request Body schema: application/json
status
required
string (Status)
Enum: "STAGED" "SUBMITTED"
ids
required
Array of strings

A list of analyses keys.

ran_by
required
string (Ran by) non-empty

Linux user who ran the analysis.

Responses

Request samples

Content type
application/json
{
}

analyses_download_read

Render file given path relative to analysis output directory.

Authorizations:
Basic
path Parameters
id
required
string
query Parameters
result
required
string

Key of the result.

Responses

Response samples

Content type
application/json
"string"

analyses_igv_read

View Experiment in IGV.

Authorizations:
Basic
path Parameters
id
required
string
query Parameters
result
required
string

Result name of the bam path.

result_index
required
string

Result name of the bam index path.

locus
string

Locus to focus on

Responses

analyses_raw_read

cat-like render file given path relative to analysis output directory.

Authorizations:
Basic
path Parameters
id
required
string
query Parameters
result
required
string

Key of the result.

lines
string
Default: "5000"

Number of lines to read.

offset
string
Default: "0"

Number of lines to start from.

reverse
boolean

Read from bottom.

Responses

Response samples

Content type
application/json
"string"

analyses_stream_read

Render file given path relative to analysis output directory.

Authorizations:
Basic
path Parameters
id
required
string
query Parameters
result
required
string

Key of the result.

bytes
string

Byte range to retrieve

Responses

Response samples

Content type
application/json
"string"

analyses_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

analyses_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
analyses
Array of integers Nullable

Linked analyses. GET value limited to 50 analyses, POST unlimited.

required
object (Application)
object (Custom fields) Nullable
Default: {}
data
string (Data)
object (Individual)
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Project level analysis) Nullable
ran_by
string (Ran by) Nullable ^[\w.@+-]+$
Array of objects (Experiment) Nullable
Default: []
results
string (Analysis results as reported by application.) Nullable
status
string (Status)
Default: "CREATED"
Enum: "CREATED" "FAILED" "FINISHED" "IN_PROGRESS" "STAGED" "STARTED" "SUBMITTED" "SUCCEEDED"

Analysis current status.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
Array of objects (Experiment) Nullable
Default: []

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

analyses_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
analyses
Array of integers Nullable

Linked analyses. GET value limited to 50 analyses, POST unlimited.

required
object (Application)
object (Custom fields) Nullable
Default: {}
data
string (Data)
object (Individual)
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Project level analysis) Nullable
ran_by
string (Ran by) Nullable ^[\w.@+-]+$
Array of objects (Experiment) Nullable
Default: []
results
string (Analysis results as reported by application.) Nullable
status
string (Status)
Default: "CREATED"
Enum: "CREATED" "FAILED" "FINISHED" "IN_PROGRESS" "STAGED" "STARTED" "SUBMITTED" "SUCCEEDED"

Analysis current status.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
Array of objects (Experiment) Nullable
Default: []

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

analyses_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

applications

applications_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

application_class
string

Filter by application_class.

assembly
string

Filter by assembly.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

description
string

Filter by description.

id
number

Filter by id.

modified
string

Modified datetime filter.

name
string

Filter by name.

notes
string

Filter by notes.

pk
number

Filter by id.

results
string

Filter by results.

settings
string

Filter by settings.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

tags
string

Filter by tags__name.

url
string

Filter by url.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

version
string

Filter by version.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
application_class
string (Application Class) [ 1 .. 100 ] characters Nullable

Class used to execute the application.

required
object (Assembly)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
description
string (Application Description) Nullable
name
required
string (Application Name) [ 1 .. 100 ] characters
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Results) Nullable
Default: {}

Results specification.

settings
string (Application configuration.) Nullable
storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
url
string (Application URL) [ 1 .. 300 ] characters Nullable
version
required
string (Application Version) [ 1 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

applications_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

applications_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
application_class
string (Application Class) [ 1 .. 100 ] characters Nullable

Class used to execute the application.

required
object (Assembly)
object (Custom fields) Nullable
Default: {}
data
string (Data)
description
string (Application Description) Nullable
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Results) Nullable
Default: {}

Results specification.

settings
string (Application configuration.) Nullable
storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
url
string (Application URL) [ 1 .. 300 ] characters Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

applications_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
application_class
string (Application Class) [ 1 .. 100 ] characters Nullable

Class used to execute the application.

required
object (Assembly)
object (Custom fields) Nullable
Default: {}
data
string (Data)
description
string (Application Description) Nullable
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Results) Nullable
Default: {}

Results specification.

settings
string (Application configuration.) Nullable
storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
url
string (Application URL) [ 1 .. 300 ] characters Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

applications_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

assemblies

assemblies_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

id
number

Filter by id.

modified
string

Modified datetime filter.

name
string

Filter by name.

notes
string

Filter by notes.

pk
number

Filter by id.

reference_data
string

Filter by reference_data.

species
string

Filter by species.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
name
required
string (Name) [ 1 .. 100 ] characters
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Reference data) Nullable
Default: {}

Assembly reference assets, each element is a dictionary.

species
required
string (Species)
Enum: "HUMAN" "MOUSE"

Assembly species.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

assemblies_stream_read

Render file from assembly reference files.

Authorizations:
Basic
path Parameters
id
required
string
query Parameters
reference
required
string

Key of the reference.

bytes
string

Byte range to retrieve

Responses

Response samples

Content type
application/json
"string"

assemblies_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

assemblies_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Reference data) Nullable
Default: {}

Assembly reference assets, each element is a dictionary.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

assemblies_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Reference data) Nullable
Default: {}

Assembly reference assets, each element is a dictionary.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

assemblies_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

auth

auth_list

Authenticate user.

Authorizations:
Basic

Responses

centers

centers_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

acronym
string

Filter by acronym.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

id
number

Filter by id.

modified
string

Modified datetime filter.

name
string

Filter by name.

notes
string

Filter by notes.

pk
number

Filter by id.

slug
string

Filter by slug.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
acronym
required
string (Center Acronym) [ 1 .. 10 ] characters

Abbreviation formed from the initial letters (e.g. NASA ).

created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
name
required
string (Center Name) [ 1 .. 100 ] characters

Center name without acronym.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

centers_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

centers_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

centers_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

centers_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

clients

clients_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
settings
string (Settings)
Default: {}
slug
required
string <slug> (Slug) non-empty ^[-a-zA-Z0-9_]+$

Uniquely identify this client instance.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

clients_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

clients_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
settings
string (Settings)
Default: {}

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

clients_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
settings
string (Settings)
Default: {}

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

clients_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

custom_fields

custom_fields_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

configuration
string

Filter by configuration.

created
string

Created datetime filter.

created_by
string

Filter by created_by.

field_name
string

Filter by field_name.

id
number

Filter by id.

model
string

Filter by model.

modified
string

Modified datetime filter.

pk
number

Filter by id.

verbose_name
string

Filter by verbose_name.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
required
object (Configuration)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
field_name
required
string (Field name) [ 1 .. 100 ] characters ^(\_?[a-z0-9]+)+$

Only lower case and under scores (e.g. field_name).

model
required
string (Model) [ 1 .. 100 ] characters

Model e.g. isabl_api.Individual. It must support custom fields.

verbose_name
string (Verbose name) <= 200 characters Nullable

Verbose name for field.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

custom_fields_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

custom_fields_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (Configuration)
verbose_name
string (Verbose name) <= 200 characters Nullable

Verbose name for field.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

custom_fields_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
required
object (Configuration)
verbose_name
string (Verbose name) <= 200 characters Nullable

Verbose name for field.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

custom_fields_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

diseases

diseases_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

acronym
string

Filter by acronym.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

id
number

Filter by id.

modified
string

Modified datetime filter.

name
string

Filter by name.

notes
string

Filter by notes.

pk
number

Filter by id.

slug
string

Filter by slug.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
acronym
required
string (Disease Acronym) [ 1 .. 20 ] characters

Abbreviation formed from the initial letters (e.g. MDS ).

created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
name
required
string (Name) [ 1 .. 1000 ] characters

Disease name without acronym.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

diseases_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

diseases_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
acronym
required
string (Disease Acronym) [ 1 .. 20 ] characters

Abbreviation formed from the initial letters (e.g. MDS ).

object (Custom fields) Nullable
Default: {}
data
string (Data)
name
required
string (Name) [ 1 .. 1000 ] characters

Disease name without acronym.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

diseases_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
acronym
required
string (Disease Acronym) [ 1 .. 20 ] characters

Abbreviation formed from the initial letters (e.g. MDS ).

object (Custom fields) Nullable
Default: {}
data
string (Data)
name
required
string (Name) [ 1 .. 1000 ] characters

Disease name without acronym.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

diseases_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

experiments

experiments_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

aliquot
aliquot_id
string

Filter by aliquot__identifier.

analyses_as_reference
analyses_as_target
bam_files
string

Filter by bam_files.

center
created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

has_bam_for
string

Filter by bam_files.

id
number

Filter by id.

identifier
string

Filter by identifier.

individual
modified
string

Modified datetime filter.

notes
string

Filter by notes.

pk
number

Filter by id.

platform
projects
raw_data
string

Filter by raw_data.

results
string

Filter by results.

sample
storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

submission
system_id
string

Filter by system_id.

tags
string

Filter by tags__name.

technique
uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
aliquot_id
string (Aliquot id) non-empty Nullable
object (Bam files) Nullable
Default: {}

Default bams are a function of Assembly.

required
object (Center)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
identifier
string (Identifier) <= 100 characters Nullable

Instance Identifier.

notes
string (Notes) Nullable

Free text field to keep notes on object.

required
object (Platform)
required
Array of objects (Project level analysis)
Array of objects (RawData) Nullable
required
object (Sample)
storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

submission
integer (Submission) Nullable
Array of objects (Tag) Nullable
required
object (Technique)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

experiments_igv_read

View Experiment in IGV.

Authorizations:
Basic
path Parameters
system_id
required
string
query Parameters
locus
string

Locus to focus on

assembly
string

View analysis to a specific assembly

Responses

experiments_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

experiments_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
aliquot_id
string (Aliquot id) non-empty Nullable
object (Bam files) Nullable
Default: {}

Default bams are a function of Assembly.

required
object (Center)
object (Custom fields) Nullable
Default: {}
data
string (Data)
identifier
string (Identifier) <= 100 characters Nullable

Instance Identifier.

notes
string (Notes) Nullable

Free text field to keep notes on object.

required
object (Platform)
required
Array of objects (Project level analysis)
Array of objects (RawData) Nullable
required
object (Sample)
storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
required
object (Technique)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

experiments_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
aliquot_id
string (Aliquot id) non-empty Nullable
object (Bam files) Nullable
Default: {}

Default bams are a function of Assembly.

required
object (Center)
object (Custom fields) Nullable
Default: {}
data
string (Data)
identifier
string (Identifier) <= 100 characters Nullable

Instance Identifier.

notes
string (Notes) Nullable

Free text field to keep notes on object.

required
object (Platform)
required
Array of objects (Project level analysis)
Array of objects (RawData) Nullable
required
object (Sample)
storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
required
object (Technique)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

experiments_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

groups

groups_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

acronym
string

Filter by acronym.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

id
number

Filter by id.

modified
string

Modified datetime filter.

name
string

Filter by name.

notes
string

Filter by notes.

pk
number

Filter by id.

slug
string

Filter by slug.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
acronym
required
string (Group Acronym) [ 1 .. 20 ] characters

Abbreviation formed from the initial letters (e.g. PEDS).

created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
name
required
string (Name) [ 1 .. 100 ] characters

Group name without acronym.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

groups_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

groups_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

groups_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

groups_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

individuals

individuals_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

birth_year
number

Filter by birth_year.

center
created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

experiments
gender
string

Filter by gender.

id
number

Filter by id.

identifier
string

Filter by identifier.

modified
string

Modified datetime filter.

notes
string

Filter by notes.

pk
number

Filter by id.

projects
samples
sampless
species
string

Filter by species.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

submission
system_id
string

Filter by system_id.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
birth_year
integer (Year of Birth) [ 1800 .. 2100 ] Nullable

Date of birth is not stored given that is PHI.

required
object (Center)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
gender
string (Gender)
Default: "UNKNOWN"
Enum: "FEMALE" "MALE" "UNKNOWN"

Individual species.

identifier
required
string (Identifier) <= 100 characters

Instance Identifier.

notes
string (Notes) Nullable

Free text field to keep notes on object.

species
required
string (Species)
Enum: "HUMAN" "MOUSE"

Individual species.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

submission
integer (Submission) Nullable
Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

individuals_tree_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

birth_year
number

Filter by birth_year.

center
created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

experiments
gender
string

Filter by gender.

id
number

Filter by id.

identifier
string

Filter by identifier.

modified
string

Modified datetime filter.

notes
string

Filter by notes.

pk
number

Filter by id.

projects
samples
sampless
species
string

Filter by species.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

submission
system_id
string

Filter by system_id.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

individuals_tree_read

Read only retrieve view.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

individuals_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

individuals_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
birth_year
integer (Year of Birth) [ 1800 .. 2100 ] Nullable

Date of birth is not stored given that is PHI.

required
object (Center)
object (Custom fields) Nullable
Default: {}
data
string (Data)
gender
string (Gender)
Default: "UNKNOWN"
Enum: "FEMALE" "MALE" "UNKNOWN"

Individual species.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

individuals_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
birth_year
integer (Year of Birth) [ 1800 .. 2100 ] Nullable

Date of birth is not stored given that is PHI.

required
object (Center)
object (Custom fields) Nullable
Default: {}
data
string (Data)
gender
string (Gender)
Default: "UNKNOWN"
Enum: "FEMALE" "MALE" "UNKNOWN"

Individual species.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

individuals_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

platforms

platforms_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

id
number

Filter by id.

manufacturer
string

Filter by manufacturer.

modified
string

Modified datetime filter.

notes
string

Filter by notes.

pk
number

Filter by id.

slug
string

Filter by slug.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

system
string

Filter by system.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

version
string

Filter by version.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
manufacturer
required
string (Platform Manufacturer) [ 1 .. 100 ] characters

Platform manufacturer (e.g. ILLUMINA).

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

system
required
string (Platform System) [ 1 .. 100 ] characters

Platform system (e.g. HISEQ).

Array of objects (Tag) Nullable
version
required
string (Platform Version) [ 1 .. 100 ] characters

Platform version (e.g. 2500)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

platforms_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

platforms_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

platforms_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

platforms_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

preferences

preferences_read

Authorizations:
Basic

Responses

Response samples

Content type
application/json
{
}

preferences_update

Authorizations:
Basic
Request Body schema: application/json
preferences
string (Preferences)
Default: {}
permissions
required
Array of strings
groups
required
Array of strings
is_superuser
required
boolean (Is superuser)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

preferences_partial_update

Authorizations:
Basic
Request Body schema: application/json
preferences
string (Preferences)
Default: {}
permissions
required
Array of strings
groups
required
Array of strings
is_superuser
required
boolean (Is superuser)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

projects

projects_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

analyst
string

Filter by analyst.

coordinator
string

Filter by coordinator.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

description
string

Filter by description.

experiments
experimentss
group
string
id
number

Filter by id.

modified
string

Modified datetime filter.

notes
string

Filter by notes.

owner
string

Filter by owner.

pk
number

Filter by id.

principal_investigator
string

Filter by principal_investigator.

project_level_analyses
short_title
string

Filter by short_title.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

submissions
submissionss
tags
string

Filter by tags__name.

title
string

Filter by title.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
analyst
string <email> (Data Analyst Email) <= 254 characters Nullable

Person responsible for the data analysis.

coordinator
string <email> (Project Coordinator Email) [ 1 .. 254 ] characters Nullable

Project manager or coordinator

created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
description
string (Project Description) [ 1 .. 1000 ] characters Nullable
object (Group)
notes
string (Notes) Nullable

Free text field to keep notes on object.

owner
string <email> (Project Owner Email) <= 254 characters Nullable

Person who deals with the nitty-gritty of the project.

principal_investigator
string <email> (Principal Investigator Email) <= 254 characters Nullable

Laboratory head or principal investigator.

short_title
string (Project Short Title) [ 10 .. 30 ] characters Nullable ^[-\w]+$

A 30 character title that describes the project.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
title
string (Project Title) [ 1 .. 100 ] characters Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

projects_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

projects_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
analyst
string <email> (Data Analyst Email) <= 254 characters Nullable

Person responsible for the data analysis.

coordinator
string <email> (Project Coordinator Email) [ 1 .. 254 ] characters Nullable

Project manager or coordinator

object (Custom fields) Nullable
Default: {}
data
string (Data)
description
string (Project Description) [ 1 .. 1000 ] characters Nullable
object (Group)
notes
string (Notes) Nullable

Free text field to keep notes on object.

owner
string <email> (Project Owner Email) <= 254 characters Nullable

Person who deals with the nitty-gritty of the project.

principal_investigator
string <email> (Principal Investigator Email) <= 254 characters Nullable

Laboratory head or principal investigator.

short_title
string (Project Short Title) [ 10 .. 30 ] characters Nullable ^[-\w]+$

A 30 character title that describes the project.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
title
string (Project Title) [ 1 .. 100 ] characters Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

projects_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
analyst
string <email> (Data Analyst Email) <= 254 characters Nullable

Person responsible for the data analysis.

coordinator
string <email> (Project Coordinator Email) [ 1 .. 254 ] characters Nullable

Project manager or coordinator

object (Custom fields) Nullable
Default: {}
data
string (Data)
description
string (Project Description) [ 1 .. 1000 ] characters Nullable
object (Group)
notes
string (Notes) Nullable

Free text field to keep notes on object.

owner
string <email> (Project Owner Email) <= 254 characters Nullable

Person who deals with the nitty-gritty of the project.

principal_investigator
string <email> (Principal Investigator Email) <= 254 characters Nullable

Laboratory head or principal investigator.

short_title
string (Project Short Title) [ 10 .. 30 ] characters Nullable ^[-\w]+$

A 30 character title that describes the project.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
title
string (Project Title) [ 1 .. 100 ] characters Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

projects_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

rest-auth

rest-auth_login_create

Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework

Accept the following POST parameters: username, password Return the REST Framework Token Object's key.

Authorizations:
Basic
Request Body schema: application/json
username
string (Username)
email
string <email> (Email)
password
required
string (Password) non-empty

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Calls Django logout method and delete the Token object assigned to the current User object.

Accepts/Returns nothing.

Authorizations:
Basic

Responses

Calls Django logout method and delete the Token object assigned to the current User object.

Accepts/Returns nothing.

Authorizations:
Basic

Responses

Calls Django Auth SetPasswordForm save method.

Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.

Authorizations:
Basic
Request Body schema: application/json
new_password1
required
string (New password1) [ 1 .. 128 ] characters
new_password2
required
string (New password2) [ 1 .. 128 ] characters

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Calls Django Auth PasswordResetForm save method.

Accepts the following POST parameters: email Returns the success/fail message.

Authorizations:
Basic
Request Body schema: application/json
email
required
string <email> (Email) non-empty

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Password reset e-mail link is confirmed, therefore this resets the user's password.

Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.

Authorizations:
Basic
Request Body schema: application/json
new_password1
required
string (New password1) [ 1 .. 128 ] characters
new_password2
required
string (New password2) [ 1 .. 128 ] characters
uid
required
string (Uid) non-empty
token
required
string (Token) non-empty

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

rest-auth_registration_create

Authorizations:
Basic
Request Body schema: application/json
username
required
string (Username) [ 1 .. 150 ] characters
email
required
string <email> (Email) non-empty
password1
required
string (Password1) non-empty
password2
required
string (Password2) non-empty
first_name
required
string (First name) [ 1 .. 100 ] characters
last_name
required
string (Last name) [ 1 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

rest-auth_registration_account-confirm-email_read

Authorizations:
Basic
path Parameters
key
required
string

Responses

rest-auth_registration_settings_list

Authorizations:
Basic

Responses

rest-auth_registration_verify-email_create

Authorizations:
Basic
Request Body schema: application/json
key
required
string (Key) non-empty

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reads and updates UserModel fields Accepts GET, PUT, PATCH methods.

Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email

Returns UserModel fields.

Authorizations:
Basic

Responses

Response samples

Content type
application/json
{
}

Reads and updates UserModel fields Accepts GET, PUT, PATCH methods.

Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email

Returns UserModel fields.

Authorizations:
Basic
Request Body schema: application/json
username
required
string (Username) [ 1 .. 150 ] characters ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_name
string (First name) <= 30 characters
last_name
string (Last name) <= 150 characters
object (Preferences)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reads and updates UserModel fields Accepts GET, PUT, PATCH methods.

Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email

Returns UserModel fields.

Authorizations:
Basic
Request Body schema: application/json
username
required
string (Username) [ 1 .. 150 ] characters ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_name
string (First name) <= 30 characters
last_name
string (Last name) <= 150 characters
object (Preferences)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

samples

samples_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

category
string

Filter by category.

collection_days
number

Filter by collection_days.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

disease
experiments
experimentss
id
number

Filter by id.

identifier
string

Filter by identifier.

individual
modified
string

Modified datetime filter.

notes
string

Filter by notes.

pk
number

Filter by id.

projects
storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

submission
system_id
string

Filter by system_id.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
category
required
string (Category)
Enum: "TUMOR" "NORMAL"

Sample category.

collection_days
integer (Days of Collection) [ 0 .. 70000 ] Nullable

Days since birth at collection time.

created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
required
object (Disease)
identifier
required
string (Identifier) <= 100 characters

Instance Identifier.

required
object (Individual)
notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

submission
integer (Submission) Nullable
Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

samples_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

samples_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
collection_days
integer (Days of Collection) [ 0 .. 70000 ] Nullable

Days since birth at collection time.

object (Custom fields) Nullable
Default: {}
data
string (Data)
required
object (Disease)
identifier
required
string (Identifier) <= 100 characters

Instance Identifier.

required
object (Individual)
notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

samples_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
collection_days
integer (Days of Collection) [ 0 .. 70000 ] Nullable

Days since birth at collection time.

object (Custom fields) Nullable
Default: {}
data
string (Data)
required
object (Disease)
identifier
required
string (Identifier) <= 100 characters

Instance Identifier.

required
object (Individual)
notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

samples_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

signals

signals_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

id
number

Filter by id.

import_string
string

Filter by import_string.

modified
string

Modified datetime filter.

notes
string

Filter by notes.

pk
number

Filter by id.

slug
string

Filter by slug.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

tags
string

Filter by tags__name.

target_endpoint
string

Filter by target_endpoint, choices include: analyses, experiments.

target_id
number

Filter by target_id.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
import_string
required
string (Import String) [ 1 .. 1000 ] characters

Signal import string.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable
target_endpoint
required
string (Related Endpoint)
Enum: "analyses" "experiments"

Database schema the signal is related to.

target_id
required
integer (Target Instance Identifier) [ 0 .. 2147483647 ]

Related instance identifier.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

signals_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

signals_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
import_string
required
string (Import String) [ 1 .. 1000 ] characters

Signal import string.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

signals_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
import_string
required
string (Import String) [ 1 .. 1000 ] characters

Signal import string.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

signals_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

slideviewer

slideviewer_read

Create Slide Viewer custom URL given an image ID (image ID must already be in slideviewer to load)

Authorizations:
Basic
path Parameters
image_ids
required
string

Responses

submissions

submissions_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

description
string

Filter by description.

experiments
id
number

Filter by id.

individuals
modified
string

Modified datetime filter.

notes
string

Filter by notes.

pk
number

Filter by id.

processed
string

Processed datetime filter.

projects
samples
storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
description
string (Description) [ 1 .. 140 ] characters Nullable

A description of samples created for future reference.

notes
string (Notes) Nullable

Free text field to keep notes on object.

projects
required
Array of integers (Projects Linked To Submission) unique

Created Sequencing Experiments will be added to projects.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

submissions_download_list

Download submission_form excel template.

Authorizations:
Basic

Responses

Response samples

Content type
application/json
"string"

Create objects using `submission_form` excel file.

This endpoint returns the submission object, see the data field for reported errors.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
commit
boolean (Commit)
Default: false

Whether to commit actions produced by submission_form.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

submissions_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

submissions_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
description
string (Description) [ 1 .. 140 ] characters Nullable

A description of samples created for future reference.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

submissions_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
description
string (Description) [ 1 .. 140 ] characters Nullable

A description of samples created for future reference.

notes
string (Notes) Nullable

Free text field to keep notes on object.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

submissions_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

system_id

system_id_read

Redirect to Experiment, Sample, or Individual detail given a System ID.

Authorizations:
Basic
path Parameters
system_id
required
string

Responses

tags

tags_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

id
number

Filter by id.

name
string

Filter by name.

pk
number

Filter by id.

slug
string

Filter by slug.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
name
required
string (Name) [ 1 .. 100 ] characters
pk
integer (Pk)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

tags_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

tags_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
name
required
string (Name) [ 1 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

tags_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
name
required
string (Name) [ 1 .. 100 ] characters

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

tags_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

techniques

techniques_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

category
string

Filter by category.

created
string

Created datetime filter.

created_by
string

Filter by created_by__username.

custom_fields
string

Filter by custom_fields.

data
string

Filter by data.

id
number

Filter by id.

method
string

Filter by method.

modified
string

Modified datetime filter.

name
string

Filter by name.

notes
string

Filter by notes.

pk
number

Filter by id.

reference_data
string

Filter by reference_data.

slug
string

Filter by slug.

storage_url
string

Filter by storage_url.

storage_usage
number

Filter by storage_usage.

tags
string

Filter by tags__name.

uuid
string

Filter by uuid.

uupk
string

Filter by uuid.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
pk
integer (Pk)
created_by
string (Created by) Nullable ^[\w.@+-]+$
Default: ""
object (Custom fields) Nullable
Default: {}
data
string (Data)
method
required
string (Method)
Enum: "RS" "CS" "AT" "TR" "TD" "WE" "WG" "WT" "MD" "HE" "IH" "IF"

Experimental technique method (e.g. WHOLE GENOME SEQUENCING).

name
required
string (Name) <= 100 characters
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Reference data) Nullable
Default: {}

Technique reference assets, each element is a dictionary.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

techniques_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

techniques_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Reference data) Nullable
Default: {}

Technique reference assets, each element is a dictionary.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

techniques_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
object (Custom fields) Nullable
Default: {}
data
string (Data)
notes
string (Notes) Nullable

Free text field to keep notes on object.

object (Reference data) Nullable
Default: {}

Technique reference assets, each element is a dictionary.

storage_url
string (Storage URL) <= 1000 characters Nullable

Address to the storage bucket.

storage_usage
integer (Storage Usage) [ -9223372036854776000 .. 9223372036854776000 ] Nullable

Storage usage in bytes

Array of objects (Tag) Nullable

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

techniques_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

users

users_list

List objects.

Authorizations:
Basic
query Parameters
search
string

A search term.

email
string

Filter by email.

first_name
string

Filter by first_name.

group
string

Filter by groups__name.

id
number

Filter by id.

last_name
string

Filter by last_name.

pk
number

Filter by id.

username
string

Filter by username.

count_limit
integer

Limit total instances to be retrieved.

ordering
string

Which field to use when ordering the results.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

Response samples

Content type
application/json
{
}

Get or create objects.

Existing objects are retrieved using either the pk field or unique together constraints. If the view supports nested objects, these will also be retrieved or created using the same criteria.

⚠️ IMPORTANT: If an existing object is retrieved, its fields won't be updated with the posted data.

Authorizations:
Basic
Request Body schema: application/json
first_name
string (First name) <= 30 characters
last_name
string (Last name) <= 150 characters
username
required
string (Username) [ 1 .. 150 ] characters ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

email
string <email> (Email address) <= 254 characters
pk
integer (Pk)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

users_read

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
}

users_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
first_name
string (First name) <= 30 characters
last_name
string (Last name) <= 150 characters
username
required
string (Username) [ 1 .. 150 ] characters ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

email
string <email> (Email address) <= 254 characters

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

users_partial_update

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string
Request Body schema: application/json
first_name
string (First name) <= 30 characters
last_name
string (Last name) <= 150 characters
username
required
string (Username) [ 1 .. 150 ] characters ^[\w.@+-]+$

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

email
string <email> (Email address) <= 254 characters

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

users_delete

Retrieve and update objects.

Authorizations:
Basic
path Parameters
id
required
string

Responses

warmup

Warm up request inspired by Google's App Engine.

The first request to Isabl after startup is slow because libraries are loaded in memory and perhaps other reasons. When Isabl instances are hosted in the cloud, they are constantly restarted due to server updates and changes. By hitting this endpoint right after startup, users don't experience any delay.

See how it used here:

Authorizations:
Basic

Responses