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`

Authentication

Basic

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

aliquots

aliquots_list

List objects.

Authorizations:

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	string Related filter to Sample.
storage_url	string Filter by `storage_url`.
storage_usage	number Filter by `storage_usage`.
submission	string Related filter to Submission.
system_id	string Filter by `system_id`.
tags	string Filter by `tags__name`.
uuid	string Filter by `uuid`.
uupk