Alyx REST API documentation
auth-token
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
username required | Valid username for authentication |
password required | Valid password for authentication |
brain-regions
list
FILTERS
- id: Allen primary key:
/brain-regions?id=687
- acronym: iexact on acronym
/brain-regions?acronym=RSPv5
- name: icontains on name
/brain-regions?name=retrosplenial
- description: icontains on description
/brain-regions?description=RSPv5
- parent: get child nodes
/brain-regions?parent=315
- ancestors: get all ancestors for a given ID
- descendants: get all descendants for a given ID
===> brain region model reference
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
acronym | |
description | |
name | |
parent | |
django | |
ancestors | |
descendants |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique value identifying this brain region. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique value identifying this brain region. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
description |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique value identifying this brain region. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
description |
cache
cache.zip
channels
list
FILTERS
- subject: subject nickname:
/channels?subject=Algernon
- session: UUID
/channels?session=aad23144-0e52-4eac-80c5-c4ee2decb198
- lab: lab name
/channels?lab=wittenlab
- probe_insertion: UUID
/channels?probe_insertion=aad23144-0e52-4eac-80c5-c4ee2decb198
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
axial | |
lateral | |
x | |
y | |
z | |
brain_region | |
trajectory_estimate | |
django | |
session | |
probe_insertion | |
subject | |
lab |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
trajectory_estimate | |
brain_region | |
name | Long name |
json | Structured data, formatted in a user-defined way |
axial required | Distance in micrometers along the probe from the tip. 0 means the tip. |
lateral required | Distance in micrometers across the probe |
x | brain surface medio-lateral coordinate (um) ofthe insertion, right +, relative to Bregma |
y | brain surface antero-posterior coordinate (um) of the insertion, front +, relative to Bregma |
z | brain surface dorso-ventral coordinate (um) of the insertion, up +, relative to Bregma |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this channel. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this channel. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
trajectory_estimate | |
brain_region | |
name | Long name |
json | Structured data, formatted in a user-defined way |
axial required | Distance in micrometers along the probe from the tip. 0 means the tip. |
lateral required | Distance in micrometers across the probe |
x | brain surface medio-lateral coordinate (um) ofthe insertion, right +, relative to Bregma |
y | brain surface antero-posterior coordinate (um) of the insertion, front +, relative to Bregma |
z | brain surface dorso-ventral coordinate (um) of the insertion, up +, relative to Bregma |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this channel. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
trajectory_estimate | |
brain_region | |
name | Long name |
json | Structured data, formatted in a user-defined way |
axial | Distance in micrometers along the probe from the tip. 0 means the tip. |
lateral | Distance in micrometers across the probe |
x | brain surface medio-lateral coordinate (um) ofthe insertion, right +, relative to Bregma |
y | brain surface antero-posterior coordinate (um) of the insertion, front +, relative to Bregma |
z | brain surface dorso-ventral coordinate (um) of the insertion, up +, relative to Bregma |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this channel. |
check-protected
list
Endpoint to check if set of files are protected or not
The session is retrieved by the ALF convention in the relative path, so this field has to match the format Subject/Date/Number as shown below.
The client side REST query should look like this:
python
r_ = {'created_by': 'user_name_alyx',
'path': 'ZM_1085/2019-02-12/002/alf', # relative path to repo path
'filenames': ['file1', 'file2'],
}
Returns a response indicating if any of the datasets are protected or not - Status 403 if a dataset is protected, details contains a list of protected datasets - Status 200 is none of the datasets are protected
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
chronic-insertions
list
FILTERS
- name: chronic insertion name
/chronic-insertions?name=probe00
- subject: subject nickname:
/chronic-insertions?subject=Algernon
- lab: lab name
/chronic-insertions?lab=UCLA
- model: probe model name
/insertions?model=3A
- probe: probe UUID
/chronic-insertions?probe=aad23144-0e52-4eac-80c5-c4ee2decb198
- session: session UUID
/chronic-insertions?session=aad23144-0e52-4eac-80c5-c4ee2decb198
- serial: serial no. of probe
/chronic-insertions?serial=101010
- atlas_name: returns a session if any channel name icontains
the value:
/chronic-insertions?brain_region=visual cortex
- atlas_acronym: returns a session if any of its channels name exactly
matches the value
/chronic-insertions?atlas_acronym=SSp-m4
, cf Allen CCFv2017 - atlas_id: returns a session if any of its channels id matches the
provided value:
/chronic-insertions?atlas_id=950
, cf Allen CCFv2017
===> chronic insertion model reference
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
users | |
subject | |
location | |
lab | |
procedures | |
narrative | |
start_time | |
end_time | |
serial | |
model | |
django | |
probe | |
session | |
atlas_name | |
atlas_acronym | |
atlas_id |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Long name |
subject | |
lab | |
model | |
start_time | |
serial | Probe serial number |
json | Structured data, formatted in a user-defined way |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this chronic insertion. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this chronic insertion. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Long name |
subject | |
lab | |
model | |
start_time | |
serial | Probe serial number |
json | Structured data, formatted in a user-defined way |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this chronic insertion. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Long name |
subject | |
lab | |
model | |
start_time | |
serial | Probe serial number |
json | Structured data, formatted in a user-defined way |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this chronic insertion. |
data-formats
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name required | short identifying name, e.g. 'npy' |
description | Human-readable description of the file format e.g. 'npy-formatted square numerical array'. |
file_extension required | file extension, starting with a dot. |
matlab_loader_function | Name of MATLAB loader function'. |
python_loader_function | Name of Python loader function'. |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | short identifying name, e.g. 'npy' |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | short identifying name, e.g. 'npy' |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name required | short identifying name, e.g. 'npy' |
description | Human-readable description of the file format e.g. 'npy-formatted square numerical array'. |
file_extension required | file extension, starting with a dot. |
matlab_loader_function | Name of MATLAB loader function'. |
python_loader_function | Name of Python loader function'. |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | short identifying name, e.g. 'npy' |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name | short identifying name, e.g. 'npy' |
description | Human-readable description of the file format e.g. 'npy-formatted square numerical array'. |
file_extension | file extension, starting with a dot. |
matlab_loader_function | Name of MATLAB loader function'. |
python_loader_function | Name of Python loader function'. |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | short identifying name, e.g. 'npy' |
data-repository
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
name | |
globus_is_personal | |
globus_endpoint_id |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
timezone | Timezone of the server (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
globus_path | absolute path to the repository on the server e.g. /mnt/something/ |
hostname | Host name of the network drive |
data_url | URL of the data repository, if it is accessible via HTTP |
repository_type | |
globus_endpoint_id | UUID of the globus endpoint |
globus_is_personal | whether the Globus endpoint is personal or not. By default, Globus cannot transfer a file between two personal endpoints. |
json | Structured data, formatted in a user-defined way |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
timezone | Timezone of the server (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
globus_path | absolute path to the repository on the server e.g. /mnt/something/ |
hostname | Host name of the network drive |
data_url | URL of the data repository, if it is accessible via HTTP |
repository_type | |
globus_endpoint_id | UUID of the globus endpoint |
globus_is_personal | whether the Globus endpoint is personal or not. By default, Globus cannot transfer a file between two personal endpoints. |
json | Structured data, formatted in a user-defined way |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | |
timezone | Timezone of the server (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
globus_path | absolute path to the repository on the server e.g. /mnt/something/ |
hostname | Host name of the network drive |
data_url | URL of the data repository, if it is accessible via HTTP |
repository_type | |
globus_endpoint_id | UUID of the globus endpoint |
globus_is_personal | whether the Globus endpoint is personal or not. By default, Globus cannot transfer a file between two personal endpoints. |
json | Structured data, formatted in a user-defined way |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
data-repository-type
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name required |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name required |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
dataset-types
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Short identifying nickname, e.g. 'spikes.times' |
created_by | |
description | Human-readable description of data type. Should say what is in the file, and how to read it. For DataCollections, it should list what Datasets are expected in the the collection. E.g. 'Files related to spike events, including spikes.times.npy, spikes.clusters.npy, spikes.amps.npy, spikes.depths.npy |
filename_pattern | File name pattern (with wildcards) for this file in ALF naming convention. E.g. 'spikes.times.*' or '*.timestamps.*', or 'spikes.*.*' for a DataCollection, which would include all files starting with the word 'spikes'. NB: Case-insensitive matching.If null, the name field must match the object.attribute part of the filename. |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Short identifying nickname, e.g. 'spikes.times' |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Short identifying nickname, e.g. 'spikes.times' |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Short identifying nickname, e.g. 'spikes.times' |
created_by | |
description | Human-readable description of data type. Should say what is in the file, and how to read it. For DataCollections, it should list what Datasets are expected in the the collection. E.g. 'Files related to spike events, including spikes.times.npy, spikes.clusters.npy, spikes.amps.npy, spikes.depths.npy |
filename_pattern | File name pattern (with wildcards) for this file in ALF naming convention. E.g. 'spikes.times.*' or '*.timestamps.*', or 'spikes.*.*' for a DataCollection, which would include all files starting with the word 'spikes'. NB: Case-insensitive matching.If null, the name field must match the object.attribute part of the filename. |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Short identifying nickname, e.g. 'spikes.times' |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Short identifying nickname, e.g. 'spikes.times' |
created_by | |
description | Human-readable description of data type. Should say what is in the file, and how to read it. For DataCollections, it should list what Datasets are expected in the the collection. E.g. 'Files related to spike events, including spikes.times.npy, spikes.clusters.npy, spikes.amps.npy, spikes.depths.npy |
filename_pattern | File name pattern (with wildcards) for this file in ALF naming convention. E.g. 'spikes.times.*' or '*.timestamps.*', or 'spikes.*.*' for a DataCollection, which would include all files starting with the word 'spikes'. NB: Case-insensitive matching.If null, the name field must match the object.attribute part of the filename. |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Short identifying nickname, e.g. 'spikes.times' |
datasets
list
FILTERS
- subject: subject nickname: /datasets?subject=Algernon
- lab: lab name /datsets?lab=wittenlab
- created_date: dataset registration date /datasets?created_date=2020-02-16
- date: session start time date /datasets?date=2020-02-16
- created_by: lab member creation /datasets?created_by=root
- experiment_number: session number /datasets?experiment_number=1
- created_date_gte: greater/equal creation date /datasets?created_date_gte=2020-02-16
- created_date_lte: lower/equal creation date /datasets?created_date_lte=2020-02-16
- exists: only returns datasets for which a file record exists or doesn't exit on a
server repo (boolean) /datasets?exists=True
- probe_insertions: probe insertion id '/datasets?probe_insertion=uuid
- tag: tag name '/datasets?tag=repeated_site
- public: only returns datasets that are public or not public
- protected: only returns datasets that are protected or not protected
- qc: only returns datasets with this QC value /datasets?qc=PASS
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
session | |
created_by | |
created_datetime | |
generating_software | |
provenance_directory | |
content_type | |
object_id | |
file_size | |
md5 | |
hash | |
version | |
collection | |
dataset_type | |
data_format | |
revision | |
tags | |
auto_datetime | |
default_dataset | |
qc | |
django | |
subject | |
lab | |
created_date | |
date | |
experiment_number | |
created_date_gte | |
created_date_lte | |
exists | |
probe_insertion | |
public | |
protected | |
tag |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Long name |
created_by | |
created_datetime | The creation datetime. |
dataset_type required | |
data_format | |
collection | |
session | |
file_size | |
hash | |
version | |
subject | |
date | |
number | |
revision | |
default_dataset | |
tags | |
qc | |
json | Structured data, formatted in a user-defined way |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this dataset. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this dataset. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Long name |
created_by | |
created_datetime | The creation datetime. |
dataset_type required | |
data_format | |
collection | |
session | |
file_size | |
hash | |
version | |
subject | |
date | |
number | |
revision | |
default_dataset | |
tags | |
qc | |
json | Structured data, formatted in a user-defined way |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this dataset. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Long name |
created_by | |
created_datetime | The creation datetime. |
dataset_type | |
data_format | |
collection | |
session | |
file_size | |
hash | |
version | |
subject | |
date | |
number | |
revision | |
default_dataset | |
tags | |
qc | |
json | Structured data, formatted in a user-defined way |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this dataset. |
downloads
list
FILTERS
- user: Labmember name:
/downloads?user=jimmyjazz
- json: icontains on json:
/downloads?json=processing
- count: count number:
/downloads?count=5
- dataset_type: icontains on dataset type
/downloads?dataset_type=camera
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
count | |
django | |
json | |
dataset | |
user | |
dataset_type |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this download. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this download. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user required | |
count | |
json | Structured data, formatted in a user-defined way |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this download. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user | |
count | |
json | Structured data, formatted in a user-defined way |
fields-of-view
list
FILTERS
- provenance: field of view provenance
must one of the strings among those choices:
'Estimate', 'Functional', 'Landmark', 'Histology'.
/fields-of-view?provenance=Estimate
- atlas: One or more brain regions covered by a field of view
- subject: subject nickname:
/fields-of-view?subject=Algernon
- project: the project name
- date: session date:
/fields-of-view?date=2020-01-15
- experiment_number: session number
/fields-of-view?experiment_number=1
- session:
/fields-of-view?session=aad23144-0e52-4eac-80c5-c4ee2decb198
- name: field of view name
/trajectories?name=FOV_01
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
session | |
imaging_type | |
datasets | |
stack | |
django | |
subject | |
lab | |
project | |
date | |
experiment_number | |
dataset_types | |
atlas_name | |
atlas_acronym | |
atlas_id |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
imaging_type | |
name required | Long name |
session required | |
stack | |
datasets |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this field of view. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this field of view. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
imaging_type | |
name required | Long name |
session required | |
stack | |
datasets |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this field of view. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
imaging_type | |
name | Long name |
session | |
stack | |
datasets |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this field of view. |
files
list
FILTERS
- dataset: dataset UUID:
/files?dataset=aad23144-0e52-4eac-80c5-c4ee2decb198
- exists: Bool
/files?exists=False
- lab: lab name
/files?lab=wittenlab
- data_repository: data repository name
/files?data_repository=mainen_lab_SR
- globus_is_personal: bool type of Globus endpoint
/files?globus_is_personal=True
===> file record model reference
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
dataset | |
data_repository | |
relative_path | |
exists | |
django | |
lab | |
globus_is_personal |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
dataset required | |
data_repository required | |
name | Long name |
json | Structured data, formatted in a user-defined way |
relative_path required | path name within repository |
exists | Whether the file exists in the data repository |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this file record. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this file record. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
dataset required | |
data_repository required | |
name | Long name |
json | Structured data, formatted in a user-defined way |
relative_path required | path name within repository |
exists | Whether the file exists in the data repository |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this file record. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
dataset | |
data_repository | |
name | Long name |
json | Structured data, formatted in a user-defined way |
relative_path | path name within repository |
exists | Whether the file exists in the data repository |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this file record. |
fov-location
list
FILTERS
- provenance: field of view provenance
must one of the strings among those choices:
'Estimate', 'Functional', 'Landmark', 'Histology'
/fov-location?provenance=Estimate
- **fov: field of view:
/fov-location?fov=aad23144-0e52-4eac-80c5-c4ee2decb198
- default_provenance: default provenance:
/fov-location?default_provenance=True
- brain_location: one or more brain location IDs:
/fov-location?brain_location=[10, 263]
===> FOVLocation model reference
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
field_of_view | |
provenance | |
default_provenance | |
coordinate_system | |
auto_datetime | |
x | |
y | |
z | |
n_xyz | |
brain_region | |
django |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
brain_region | |
coordinate_system | |
provenance required | |
x required | |
y required | |
z required | |
n_xyz required | |
default_provenance |
imaging-stack
list
FILTERS
- atlas: One or more brain regions covered by a stack
- name: The image stack name
===> ImagingStack model reference
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
django | |
atlas_name | |
atlas_acronym | |
atlas_id |
read
===> ImagingStack model reference
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this imaging stack. |
insertions
list
FILTERS
- name: probe insertion name
/trajectories?name=probe00
- subject: subject nickname:
/insertions?subject=Algernon
- date: session date:
/inssertions?date=2020-01-15
- experiment_number: session number
/insertions?experiment_number=1
- session: session UUID
/insertions?session=aad23144-0e52-4eac-80c5-c4ee2decb198
- task_protocol (icontains)
- location: location name (icontains)
- project: project name (icontains)
- model: probe model name
/insertions?model=3A
- lab: lab name (exact)
- tag: tag name (icontains)
- dataset_types: dataset type(s)
- datasets: datasets name(s)
- dataset_qc_lte: dataset QC value, e.g. PASS, WARNING, FAIL, CRITICAL
- atlas_name: returns a session if any channel name icontains
the value:
/insertions?brain_region=visual cortex
- atlas_acronym: returns a session if any of its channels name exactly
matches the value
/insertions?atlas_acronym=SSp-m4
, cf Allen CCFv2017 - atlas_id: returns a session if any of its channels id matches the
provided value:
/insertions?atlas_id=950
, cf Allen CCFv2017
===> probe insertion model reference
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
session | |
model | |
serial | |
auto_datetime | |
datasets | |
chronic_insertion | |
django | |
subject | |
date | |
experiment_number | |
dataset_types | |
dataset_qc_lte | |
lab | |
project | |
task_protocol | |
tag | |
atlas_name | |
atlas_acronym | |
atlas_id |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
session | |
model | |
name required | Long name |
json | Structured data, formatted in a user-defined way |
serial | Probe serial number |
chronic_insertion | |
datasets |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this probe insertion. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this probe insertion. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
session | |
model | |
name required | Long name |
json | Structured data, formatted in a user-defined way |
serial | Probe serial number |
chronic_insertion |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this probe insertion. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
session | |
model | |
name | Long name |
json | Structured data, formatted in a user-defined way |
serial | Probe serial number |
chronic_insertion |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this probe insertion. |
labs
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
institution | |
address | |
timezone | |
reference_weight_pct | |
zscore_weight_pct | |
cage_type | |
enrichment | |
food | |
cage_cleaning_frequency_days | |
light_cycle | |
repositories | |
django |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
institution | |
address | |
timezone | Timezone of the server (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
repositories | |
reference_weight_pct | The minimum mouse weight is a linear combination of the reference weight and the zscore weight. |
zscore_weight_pct | The minimum mouse weight is a linear combination of the reference weight and the zscore weight. |
json | Structured data, formatted in a user-defined way |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
institution | |
address | |
timezone | Timezone of the server (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
repositories | |
reference_weight_pct | The minimum mouse weight is a linear combination of the reference weight and the zscore weight. |
zscore_weight_pct | The minimum mouse weight is a linear combination of the reference weight and the zscore weight. |
json | Structured data, formatted in a user-defined way |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | |
institution | |
address | |
timezone | Timezone of the server (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
repositories | |
reference_weight_pct | The minimum mouse weight is a linear combination of the reference weight and the zscore weight. |
zscore_weight_pct | The minimum mouse weight is a linear combination of the reference weight and the zscore weight. |
json | Structured data, formatted in a user-defined way |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
locations
list
Lists Lab Location
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
read
Allows viewing of full detail and deleting a water administration.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Long name |
update
Allows viewing of full detail and deleting a water administration.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Long name |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Long name |
lab | |
json | Structured data, formatted in a user-defined way |
partial_update
Allows viewing of full detail and deleting a water administration.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Long name |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | Long name |
lab | |
json | Structured data, formatted in a user-defined way |
new-download
create
REST query data field to log a download:
data = {'user': 'labmember_name',
'datasets': 'pk1', # supports multiple pks as a list
'projects': 'project_name') # supports multiple projects as a list
If there are multiple projects and multiple datasets, each datasets will be logged as downloaded for all projects.
notes
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
django |
create
If an image is provided, the request body can contain an additional item
width
: desired width to resize the image for storage. Aspect ratio will be maintained.
Options are
- None to use the UPLOADED_IMAGE_WIDTH specified in settings (default)
- 'orig' to keep original image size
- any integer to specify the image width
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user required | |
date_time | |
content_type required | |
object_id required | UUID, an object of content_type with this ID must already exist to attach a note. |
text | String, content of the note or description of the image. |
image | |
json | Structured data, formatted in a user-defined way |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this note. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this note. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user required | |
date_time | |
content_type required | |
object_id required | UUID, an object of content_type with this ID must already exist to attach a note. |
text | String, content of the note or description of the image. |
image | |
json | Structured data, formatted in a user-defined way |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this note. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user | |
date_time | |
content_type | |
object_id | UUID, an object of content_type with this ID must already exist to attach a note. |
text | String, content of the note or description of the image. |
image | |
json | Structured data, formatted in a user-defined way |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this note. |
procedures
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | Long name |
json | Structured data, formatted in a user-defined way |
description | Detailed description of the procedure |
projects
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
description | Description of the project |
users |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name required | |
description | Description of the project |
users |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
name | |
description | Description of the project |
users |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required |
register-file
create
Endpoint to create a register a dataset record through the REST API.
The session is retrieved by the ALF convention in the relative path, so this field has to match the format Subject/Date/Number as shown below.
The set of repositories are given through the labs. The lab is by default the subject lab, but if it is specified, it overrides the subject lab entirely.
One repository or lab is mandatory, as this is the repository where the files currently exist It can be identified either by name (recommended) or hostname (compatibility). The client side REST query should look like this:
python
r_ = {'created_by': 'user_name_alyx',
'name': 'repository_name_alyx', # optional, will be added if doesn't match lab
'path': 'ZM_1085/2019-02-12/002/alf', # relative path to repo path
'filenames': ['file1', 'file2'],
'labs': 'alyxlabname1', # optional, will get the subjects lab if not used
'hashes': ['f9c26e42-8f22-4f07-8fdd-bb51a63bedaa',
'f9c26e42-8f22-4f07-8fdd-bb51a63bedad'] # optional
'filesizes': [145684, 354213], # optional
'qc': ['NOT_SET', 'PASS'], # optional
'server_only': True, # optional, defaults to False. Will only create file
# records in the server repositories and skips local repositories
'versions': ['1.4.4', '1.4.4'], # optional, usually refers to the software version
# used to generate the file
'default': False #optional , defaults to True, if more than one revision of dataset,
whether to set current one as the default
'check_protected: False # optional, defaults to False, before attempting to register
datasets checks if any are protected
}
For backward compatibility the following is allowed (projects are labs the repo lookup
is done on the hostname instead of the repository name):
python
r_ = {'hostname': 'repo_hostname_alyx', # optional, will be added if doesn't match lab
'projects': 'alyx_lab_name', # optional, alias of lab field above
}
If the dataset already exists, it will use the file hash to deduce if the file has been patched or not (i.e. the filerecords will be created as not existing)
revisions
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name | Long name |
description | |
created_datetime | created date |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Long name |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Long name |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name | Long name |
description | |
created_datetime | created date |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Long name |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name | Long name |
description | |
created_datetime | created date |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
name required | Long name |
sessions
list
FILTERS
- subject: subject nickname
/sessions?subject=Algernon
- dataset_types: dataset type(s)
/sessions?dataset_types=trials.table,camera.times
- datasets: dataset name(s)
/sessions?datasets=_ibl_leftCamera.times.npy
- dataset_qc_lte: dataset QC values less than or equal to this
/sessions?dataset_qc_lte=WARNING
- number: session number
- users: experimenters (exact)
- date_range: date
/sessions?date_range=2020-01-12,2020-01-16
- lab: lab name (exact)
- task_protocol (icontains)
- location: location name (icontains)
- projects: project name (icontains)
- json: queries on json fields, for example here
tutu
- exact/equal lookup:
/sessions?extended_qc=tutu,True
, - gte lookup:
/sessions/?extended_qc=tutu__gte,0.5
,
- exact/equal lookup:
- extended_qc queries on json fields, for example here
qc_bool
andqc_pct
, values and fields come by pairs, using semi-colon as a separator- exact/equal lookup:
/sessions?extended_qc=qc_bool;True
, - gte lookup:
/sessions/?extended_qc=qc_pct__gte;0.5
, - chained lookups:
/sessions/?extended_qc=qc_pct__gte;0.5;qc_bool;True
,
- exact/equal lookup:
- performance_gte, performance_lte: percentage of successful trials gte/lte
- brain_region: returns a session if any channel name icontains the value:
/sessions?brain_region=visual cortex
- atlas_acronym: returns a session if any of its channels name exactly matches the value
/sessions?atlas_acronym=SSp-m4
, cf Allen CCFv2017 - atlas_id: returns a session if any of its channels id matches the provided value:
/sessions?atlas_id=950
, cf Allen CCFv2017 - qc: returns sessions for which the qc statuses matches provided string. Should be
one of CRITICAL, ERROR, WARNING, NOT_SET, PASS
/sessions?qc=CRITICAL
- histology: returns sessions for which the subject has an histology session:
/sessions?histology=True
- django: generic filter allowing lookups (same syntax as json filter)
/sessions?django=projects__name__icontains,matlab
filters sessions that have matlab in the project names/sessions?django=~projects__name__icontains,matlab
does the exclusive set: filters sessions that do not have matlab in the project names
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
json | |
users | |
subject | |
location | |
lab | |
procedures | |
narrative | |
start_time | |
end_time | |
parent_session | |
projects | |
type | |
number | |
task_protocol | |
n_trials | |
n_correct_trials | |
qc | |
extended_qc | |
auto_datetime | |
django | |
nickname | |
date_range | |
dataset_types | |
datasets | |
dataset_qc_lte | |
performance_gte | |
performance_lte | |
project | |
atlas_name | |
atlas_acronym | |
atlas_id | |
histology | |
tag |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
subject required | |
start_time | |
number | Optional session number for this level |
lab | |
projects required | |
task_protocol |
read
Detail of one session
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this session. |
update
Detail of one session
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this session. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
subject required | |
users | |
location | |
procedures | |
lab | |
projects | |
type | User-defined session type (e.g. Base, Experiment) |
task_protocol | |
number | Optional session number for this level |
start_time | |
end_time | |
narrative | |
parent_session | Hierarchical parent to this session |
n_correct_trials | |
n_trials | |
extended_qc | Structured data about session QC, formatted in a user-defined way |
qc | |
json | Structured data, formatted in a user-defined way |
partial_update
Detail of one session
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this session. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
subject | |
users | |
location | |
procedures | |
lab | |
projects | |
type | User-defined session type (e.g. Base, Experiment) |
task_protocol | |
number | Optional session number for this level |
start_time | |
end_time | |
narrative | |
parent_session | Hierarchical parent to this session |
n_correct_trials | |
n_trials | |
extended_qc | Structured data about session QC, formatted in a user-defined way |
qc | |
json | Structured data, formatted in a user-defined way |
delete
Detail of one session
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this session. |
subjects
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
json | |
nickname | |
species | |
litter | |
sex | |
strain | |
genotype | |
genotype_test | |
source | |
line | |
birth_date | |
death_date | |
wean_date | |
genotype_date | |
responsible_user | |
lab | |
projects | |
cage | |
request | |
ear_mark | |
protocol_number | |
description | |
cull_method | |
adverse_effects | |
actual_severity | |
to_be_genotyped | |
to_be_culled | |
reduced | |
reduced_date | |
django | |
alive | |
stock | |
water_restricted | |
project |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
nickname | Easy-to-remember name (e.g. 'Hercules'). |
responsible_user | |
birth_date | |
death_date | |
species | |
sex | |
litter | |
strain | |
source | |
line | |
projects | |
lab required | |
genotype | |
description | |
json | Structured data, formatted in a user-defined way |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
nickname required | Easy-to-remember name (e.g. 'Hercules'). |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
nickname required | Easy-to-remember name (e.g. 'Hercules'). |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
nickname | Easy-to-remember name (e.g. 'Hercules'). |
responsible_user | |
birth_date | |
death_date | |
species | |
sex | |
litter | |
strain | |
source | |
line | |
projects | |
lab required | |
description | |
json | Structured data, formatted in a user-defined way |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
nickname required | Easy-to-remember name (e.g. 'Hercules'). |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
nickname | Easy-to-remember name (e.g. 'Hercules'). |
responsible_user | |
birth_date | |
death_date | |
species | |
sex | |
litter | |
strain | |
source | |
line | |
projects | |
lab | |
description | |
json | Structured data, formatted in a user-defined way |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
nickname required | Easy-to-remember name (e.g. 'Hercules'). |
surgeries
list
FILTERS
- subject: subject nickname
/sessions?subject=Algernon
===> session model reference
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
json | |
users | |
subject | |
lab | |
procedures | |
narrative | |
start_time | |
end_time | |
outcome_type | |
location | |
implant_weight | |
django | |
nickname | |
date_range | |
procedure |
read
Allows viewing of full detail and update of a surgery.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this surgery. |
update
Allows viewing of full detail and update of a surgery.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this surgery. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
subject required | |
name | Long name |
json | Structured data, formatted in a user-defined way |
narrative | |
start_time | |
end_time | |
outcome_type | |
implant_weight | Implant weight in grams |
lab | |
location | The physical location at which the surgery was performed |
users | The user(s) involved in this action |
procedures | The procedure(s) performed |
partial_update
Allows viewing of full detail and update of a surgery.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this surgery. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
subject | |
name | Long name |
json | Structured data, formatted in a user-defined way |
narrative | |
start_time | |
end_time | |
outcome_type | |
implant_weight | Implant weight in grams |
lab | |
location | The physical location at which the surgery was performed |
users | The user(s) involved in this action |
procedures | The procedure(s) performed |
sync-file-status
tags
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name | Long name |
description | |
protected | |
public | |
hash | Hash of the data buffer, SHA-1 is 40 hex chars, while md5is 32 hex chars |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this tag. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this tag. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name | Long name |
description | |
protected | |
public | |
hash | Hash of the data buffer, SHA-1 is 40 hex chars, while md5is 32 hex chars |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this tag. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
json | Structured data, formatted in a user-defined way |
name | Long name |
description | |
protected | |
public | |
hash | Hash of the data buffer, SHA-1 is 40 hex chars, while md5is 32 hex chars |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this tag. |
tasks
list
FILTERS
- task: task name /jobs?task=EphysSyncPulses
- session: uuid /jobs?session=aad23144-0e52-4eac-80c5-c4ee2decb198
- lab: lab name from session table /jobs?lab=churchlandlab
- pipeline: pipeline field from task /jobs?pipeline=ephys
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
name | |
priority | |
io_charge | |
level | |
gpu | |
cpu | |
ram | |
time_out_secs | |
time_elapsed_secs | |
executable | |
graph | |
status | |
log | |
session | |
version | |
parents | |
datetime | |
arguments | |
data_repository | |
django | |
lab |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parents | |
session | |
data_repository | |
status | |
name required | |
priority | |
io_charge | |
level | |
gpu | |
cpu | |
ram | |
time_out_secs | |
time_elapsed_secs | |
executable | Usually the Python class name on the workers |
graph | The name of the graph containing a set of related and possibly dependent tasks |
log | |
version | version of the algorithm generating the file |
arguments required | dictionary of input arguments |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this task. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this task. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parents | |
session | |
data_repository | |
status | |
name required | |
priority | |
io_charge | |
level | |
gpu | |
cpu | |
ram | |
time_out_secs | |
time_elapsed_secs | |
executable | Usually the Python class name on the workers |
graph | The name of the graph containing a set of related and possibly dependent tasks |
log | |
version | version of the algorithm generating the file |
arguments required | dictionary of input arguments |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this task. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
parents | |
session | |
data_repository | |
status | |
name | |
priority | |
io_charge | |
level | |
gpu | |
cpu | |
ram | |
time_out_secs | |
time_elapsed_secs | |
executable | Usually the Python class name on the workers |
graph | The name of the graph containing a set of related and possibly dependent tasks |
log | |
version | version of the algorithm generating the file |
arguments | dictionary of input arguments |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this task. |
trajectories
list
FILTERS
- provenance: probe insertion provenance
must one of the strings among those choices:
'Ephys aligned histology track', 'Histology track', 'Micro-manipulator', 'Planned'
/trajectories?provenance=Planned
- **subject: subject nickname:
/trajectories?subject=Algernon
- date: session date:
/trajectories?date=2020-01-15
- experiment_number: session number
/trajectories?experiment_number=1
- session:
/trajectories?session=aad23144-0e52-4eac-80c5-c4ee2decb198
- probe: probe_insertion name
/trajectories?probe=probe01
===> trajectory model reference
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
probe_insertion | |
chronic_insertion | |
x | |
y | |
z | |
depth | |
theta | |
phi | |
roll | |
provenance | |
coordinate_system | |
datetime | |
django | |
subject | |
project | |
date | |
experiment_number | |
session | |
probe |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
probe_insertion | |
x required | |
y required | |
z | |
depth required | |
theta required | |
phi required | |
roll | |
provenance required | |
coordinate_system | |
json | Structured data, formatted in a user-defined way |
chronic_insertion required |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this trajectory estimate. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this trajectory estimate. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
probe_insertion | |
x required | |
y required | |
z | |
depth required | |
theta required | |
phi required | |
roll | |
provenance required | |
coordinate_system | |
json | Structured data, formatted in a user-defined way |
chronic_insertion required |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A UUID string identifying this trajectory estimate. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
probe_insertion | |
x | |
y | |
z | |
depth | |
theta | |
phi | |
roll | |
provenance | |
coordinate_system | |
json | Structured data, formatted in a user-defined way |
chronic_insertion |