Alyx REST API documentation

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

auth-token

create

POST /auth-token

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action auth-token create -p username=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth-token", "create"]
var params = {
    username: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["auth-token", "create"]
params = {
    "username": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

brain-regions

list

GET /brain-regions

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action brain-regions list -p limit=... -p offset=... -p id=... -p acronym=... -p description=... -p name=... -p parent=... -p django=... -p ancestors=... -p descendants=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["brain-regions", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    acronym: ...,
    description: ...,
    name: ...,
    parent: ...,
    django: ...,
    ancestors: ...,
    descendants: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["brain-regions", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "acronym": ...,
    "description": ...,
    "name": ...,
    "parent": ...,
    "django": ...,
    "ancestors": ...,
    "descendants": ...,
}
result = client.action(schema, action, params=params)

read

GET /brain-regions/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique value identifying this brain region.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action brain-regions read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["brain-regions", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["brain-regions", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /brain-regions/{id}

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action brain-regions update -p id=... -p description=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["brain-regions", "update"]
var params = {
    id: ...,
    description: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["brain-regions", "update"]
params = {
    "id": ...,
    "description": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /brain-regions/{id}

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action brain-regions partial_update -p id=... -p description=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["brain-regions", "partial_update"]
var params = {
    id: ...,
    description: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["brain-regions", "partial_update"]
params = {
    "id": ...,
    "description": ...,
}
result = client.action(schema, action, params=params)

cache

info > list

GET /cache/info/

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action cache info list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["cache", "info > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["cache", "info > list"]
result = client.action(schema, action)

cache.zip

list

GET /cache.zip

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action cache.zip list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["cache.zip", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["cache.zip", "list"]
result = client.action(schema, action)

channels

list

GET /channels

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

===> channel 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`
`axial`
`lateral`
`x`
`y`
`z`
`brain_region`
`trajectory_estimate`
`django`
`session`
`probe_insertion`
`subject`
`lab`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action channels list -p limit=... -p offset=... -p id=... -p name=... -p axial=... -p lateral=... -p x=... -p y=... -p z=... -p brain_region=... -p trajectory_estimate=... -p django=... -p session=... -p probe_insertion=... -p subject=... -p lab=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["channels", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    axial: ...,
    lateral: ...,
    x: ...,
    y: ...,
    z: ...,
    brain_region: ...,
    trajectory_estimate: ...,
    django: ...,
    session: ...,
    probe_insertion: ...,
    subject: ...,
    lab: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["channels", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "axial": ...,
    "lateral": ...,
    "x": ...,
    "y": ...,
    "z": ...,
    "brain_region": ...,
    "trajectory_estimate": ...,
    "django": ...,
    "session": ...,
    "probe_insertion": ...,
    "subject": ...,
    "lab": ...,
}
result = client.action(schema, action, params=params)

create

POST /channels

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action channels create -p trajectory_estimate=... -p brain_region=... -p name=... -p json=... -p axial=... -p lateral=... -p x=... -p y=... -p z=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["channels", "create"]
var params = {
    trajectory_estimate: ...,
    brain_region: ...,
    name: ...,
    json: ...,
    axial: ...,
    lateral: ...,
    x: ...,
    y: ...,
    z: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["channels", "create"]
params = {
    "trajectory_estimate": ...,
    "brain_region": ...,
    "name": ...,
    "json": ...,
    "axial": ...,
    "lateral": ...,
    "x": ...,
    "y": ...,
    "z": ...,
}
result = client.action(schema, action, params=params)

read

GET /channels/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this channel.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action channels read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["channels", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["channels", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /channels/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action channels update -p id=... -p trajectory_estimate=... -p brain_region=... -p name=... -p json=... -p axial=... -p lateral=... -p x=... -p y=... -p z=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["channels", "update"]
var params = {
    id: ...,
    trajectory_estimate: ...,
    brain_region: ...,
    name: ...,
    json: ...,
    axial: ...,
    lateral: ...,
    x: ...,
    y: ...,
    z: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["channels", "update"]
params = {
    "id": ...,
    "trajectory_estimate": ...,
    "brain_region": ...,
    "name": ...,
    "json": ...,
    "axial": ...,
    "lateral": ...,
    "x": ...,
    "y": ...,
    "z": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /channels/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action channels partial_update -p id=... -p trajectory_estimate=... -p brain_region=... -p name=... -p json=... -p axial=... -p lateral=... -p x=... -p y=... -p z=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["channels", "partial_update"]
var params = {
    id: ...,
    trajectory_estimate: ...,
    brain_region: ...,
    name: ...,
    json: ...,
    axial: ...,
    lateral: ...,
    x: ...,
    y: ...,
    z: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["channels", "partial_update"]
params = {
    "id": ...,
    "trajectory_estimate": ...,
    "brain_region": ...,
    "name": ...,
    "json": ...,
    "axial": ...,
    "lateral": ...,
    "x": ...,
    "y": ...,
    "z": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /channels/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this channel.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action channels delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["channels", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["channels", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

check-protected

list

GET /check-protected

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action check-protected list -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["check-protected", "list"]
var params = {
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["check-protected", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

chronic-insertions

list

GET /chronic-insertions

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action chronic-insertions list -p limit=... -p offset=... -p id=... -p name=... -p users=... -p subject=... -p location=... -p lab=... -p procedures=... -p narrative=... -p start_time=... -p end_time=... -p serial=... -p model=... -p django=... -p probe=... -p session=... -p atlas_name=... -p atlas_acronym=... -p atlas_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["chronic-insertions", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    users: ...,
    subject: ...,
    location: ...,
    lab: ...,
    procedures: ...,
    narrative: ...,
    start_time: ...,
    end_time: ...,
    serial: ...,
    model: ...,
    django: ...,
    probe: ...,
    session: ...,
    atlas_name: ...,
    atlas_acronym: ...,
    atlas_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["chronic-insertions", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "users": ...,
    "subject": ...,
    "location": ...,
    "lab": ...,
    "procedures": ...,
    "narrative": ...,
    "start_time": ...,
    "end_time": ...,
    "serial": ...,
    "model": ...,
    "django": ...,
    "probe": ...,
    "session": ...,
    "atlas_name": ...,
    "atlas_acronym": ...,
    "atlas_id": ...,
}
result = client.action(schema, action, params=params)

create

POST /chronic-insertions

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action chronic-insertions create -p name=... -p subject=... -p lab=... -p model=... -p start_time=... -p serial=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["chronic-insertions", "create"]
var params = {
    name: ...,
    subject: ...,
    lab: ...,
    model: ...,
    start_time: ...,
    serial: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["chronic-insertions", "create"]
params = {
    "name": ...,
    "subject": ...,
    "lab": ...,
    "model": ...,
    "start_time": ...,
    "serial": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

read

GET /chronic-insertions/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this chronic insertion.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action chronic-insertions read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["chronic-insertions", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["chronic-insertions", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /chronic-insertions/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action chronic-insertions update -p id=... -p name=... -p subject=... -p lab=... -p model=... -p start_time=... -p serial=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["chronic-insertions", "update"]
var params = {
    id: ...,
    name: ...,
    subject: ...,
    lab: ...,
    model: ...,
    start_time: ...,
    serial: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["chronic-insertions", "update"]
params = {
    "id": ...,
    "name": ...,
    "subject": ...,
    "lab": ...,
    "model": ...,
    "start_time": ...,
    "serial": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /chronic-insertions/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action chronic-insertions partial_update -p id=... -p name=... -p subject=... -p lab=... -p model=... -p start_time=... -p serial=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["chronic-insertions", "partial_update"]
var params = {
    id: ...,
    name: ...,
    subject: ...,
    lab: ...,
    model: ...,
    start_time: ...,
    serial: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["chronic-insertions", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "subject": ...,
    "lab": ...,
    "model": ...,
    "start_time": ...,
    "serial": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /chronic-insertions/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this chronic insertion.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action chronic-insertions delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["chronic-insertions", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["chronic-insertions", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

data-formats

list

GET /data-formats

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-formats list -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-formats", "list"]
var params = {
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-formats", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

create

POST /data-formats

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'.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-formats create -p json=... -p name=... -p description=... -p file_extension=... -p matlab_loader_function=... -p python_loader_function=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-formats", "create"]
var params = {
    json: ...,
    name: ...,
    description: ...,
    file_extension: ...,
    matlab_loader_function: ...,
    python_loader_function: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-formats", "create"]
params = {
    "json": ...,
    "name": ...,
    "description": ...,
    "file_extension": ...,
    "matlab_loader_function": ...,
    "python_loader_function": ...,
}
result = client.action(schema, action, params=params)

read

GET /data-formats/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required	short identifying name, e.g. 'npy'

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-formats read -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-formats", "read"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-formats", "read"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

update

PUT /data-formats/{name}

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'.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-formats update -p name=... -p json=... -p name=... -p description=... -p file_extension=... -p matlab_loader_function=... -p python_loader_function=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-formats", "update"]
var params = {
    name: ...,
    json: ...,
    name: ...,
    description: ...,
    file_extension: ...,
    matlab_loader_function: ...,
    python_loader_function: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-formats", "update"]
params = {
    "name": ...,
    "json": ...,
    "name": ...,
    "description": ...,
    "file_extension": ...,
    "matlab_loader_function": ...,
    "python_loader_function": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /data-formats/{name}

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'.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-formats partial_update -p name=... -p json=... -p name=... -p description=... -p file_extension=... -p matlab_loader_function=... -p python_loader_function=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-formats", "partial_update"]
var params = {
    name: ...,
    json: ...,
    name: ...,
    description: ...,
    file_extension: ...,
    matlab_loader_function: ...,
    python_loader_function: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-formats", "partial_update"]
params = {
    "name": ...,
    "json": ...,
    "name": ...,
    "description": ...,
    "file_extension": ...,
    "matlab_loader_function": ...,
    "python_loader_function": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /data-formats/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required	short identifying name, e.g. 'npy'

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-formats delete -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-formats", "delete"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-formats", "delete"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

data-repository

list

GET /data-repository

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository list -p limit=... -p offset=... -p name=... -p globus_is_personal=... -p globus_endpoint_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository", "list"]
var params = {
    limit: ...,
    offset: ...,
    name: ...,
    globus_is_personal: ...,
    globus_endpoint_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "name": ...,
    "globus_is_personal": ...,
    "globus_endpoint_id": ...,
}
result = client.action(schema, action, params=params)

create

POST /data-repository

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository create -p name=... -p timezone=... -p globus_path=... -p hostname=... -p data_url=... -p repository_type=... -p globus_endpoint_id=... -p globus_is_personal=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository", "create"]
var params = {
    name: ...,
    timezone: ...,
    globus_path: ...,
    hostname: ...,
    data_url: ...,
    repository_type: ...,
    globus_endpoint_id: ...,
    globus_is_personal: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository", "create"]
params = {
    "name": ...,
    "timezone": ...,
    "globus_path": ...,
    "hostname": ...,
    "data_url": ...,
    "repository_type": ...,
    "globus_endpoint_id": ...,
    "globus_is_personal": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

read

GET /data-repository/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository read -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository", "read"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository", "read"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

update

PUT /data-repository/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository update -p name=... -p name=... -p timezone=... -p globus_path=... -p hostname=... -p data_url=... -p repository_type=... -p globus_endpoint_id=... -p globus_is_personal=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository", "update"]
var params = {
    name: ...,
    name: ...,
    timezone: ...,
    globus_path: ...,
    hostname: ...,
    data_url: ...,
    repository_type: ...,
    globus_endpoint_id: ...,
    globus_is_personal: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository", "update"]
params = {
    "name": ...,
    "name": ...,
    "timezone": ...,
    "globus_path": ...,
    "hostname": ...,
    "data_url": ...,
    "repository_type": ...,
    "globus_endpoint_id": ...,
    "globus_is_personal": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /data-repository/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository partial_update -p name=... -p name=... -p timezone=... -p globus_path=... -p hostname=... -p data_url=... -p repository_type=... -p globus_endpoint_id=... -p globus_is_personal=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository", "partial_update"]
var params = {
    name: ...,
    name: ...,
    timezone: ...,
    globus_path: ...,
    hostname: ...,
    data_url: ...,
    repository_type: ...,
    globus_endpoint_id: ...,
    globus_is_personal: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository", "partial_update"]
params = {
    "name": ...,
    "name": ...,
    "timezone": ...,
    "globus_path": ...,
    "hostname": ...,
    "data_url": ...,
    "repository_type": ...,
    "globus_endpoint_id": ...,
    "globus_is_personal": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /data-repository/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository delete -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository", "delete"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository", "delete"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

data-repository-type

list

GET /data-repository-type

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository-type list -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository-type", "list"]
var params = {
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository-type", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

create

POST /data-repository-type

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository-type create -p json=... -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository-type", "create"]
var params = {
    json: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository-type", "create"]
params = {
    "json": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

read

GET /data-repository-type/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository-type read -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository-type", "read"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository-type", "read"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

update

PUT /data-repository-type/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository-type update -p name=... -p json=... -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository-type", "update"]
var params = {
    name: ...,
    json: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository-type", "update"]
params = {
    "name": ...,
    "json": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /data-repository-type/{name}

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository-type partial_update -p name=... -p json=... -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository-type", "partial_update"]
var params = {
    name: ...,
    json: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository-type", "partial_update"]
params = {
    "name": ...,
    "json": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /data-repository-type/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action data-repository-type delete -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["data-repository-type", "delete"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["data-repository-type", "delete"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

dataset-types

list

GET /dataset-types

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action dataset-types list -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["dataset-types", "list"]
var params = {
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["dataset-types", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

create

POST /dataset-types

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action dataset-types create -p name=... -p created_by=... -p description=... -p filename_pattern=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["dataset-types", "create"]
var params = {
    name: ...,
    created_by: ...,
    description: ...,
    filename_pattern: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["dataset-types", "create"]
params = {
    "name": ...,
    "created_by": ...,
    "description": ...,
    "filename_pattern": ...,
}
result = client.action(schema, action, params=params)

read

GET /dataset-types/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required	Short identifying nickname, e.g. 'spikes.times'

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action dataset-types read -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["dataset-types", "read"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["dataset-types", "read"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

update

PUT /dataset-types/{name}

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action dataset-types update -p name=... -p name=... -p created_by=... -p description=... -p filename_pattern=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["dataset-types", "update"]
var params = {
    name: ...,
    name: ...,
    created_by: ...,
    description: ...,
    filename_pattern: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["dataset-types", "update"]
params = {
    "name": ...,
    "name": ...,
    "created_by": ...,
    "description": ...,
    "filename_pattern": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /dataset-types/{name}

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action dataset-types partial_update -p name=... -p name=... -p created_by=... -p description=... -p filename_pattern=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["dataset-types", "partial_update"]
var params = {
    name: ...,
    name: ...,
    created_by: ...,
    description: ...,
    filename_pattern: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["dataset-types", "partial_update"]
params = {
    "name": ...,
    "name": ...,
    "created_by": ...,
    "description": ...,
    "filename_pattern": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /dataset-types/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required	Short identifying nickname, e.g. 'spikes.times'

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action dataset-types delete -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["dataset-types", "delete"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["dataset-types", "delete"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

datasets

list

GET /datasets

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

===> dataset 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`
`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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action datasets list -p limit=... -p offset=... -p id=... -p name=... -p session=... -p created_by=... -p created_datetime=... -p generating_software=... -p provenance_directory=... -p content_type=... -p object_id=... -p file_size=... -p md5=... -p hash=... -p version=... -p collection=... -p dataset_type=... -p data_format=... -p revision=... -p tags=... -p auto_datetime=... -p default_dataset=... -p qc=... -p django=... -p subject=... -p lab=... -p created_date=... -p date=... -p experiment_number=... -p created_date_gte=... -p created_date_lte=... -p exists=... -p probe_insertion=... -p public=... -p protected=... -p tag=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["datasets", "list"]
var params = {
    limit: ...,
    offset: ...,
    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: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["datasets", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "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": ...,
}
result = client.action(schema, action, params=params)

create

POST /datasets

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action datasets create -p name=... -p created_by=... -p created_datetime=... -p dataset_type=... -p data_format=... -p collection=... -p session=... -p file_size=... -p hash=... -p version=... -p subject=... -p date=... -p number=... -p revision=... -p default_dataset=... -p tags=... -p qc=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["datasets", "create"]
var params = {
    name: ...,
    created_by: ...,
    created_datetime: ...,
    dataset_type: ...,
    data_format: ...,
    collection: ...,
    session: ...,
    file_size: ...,
    hash: ...,
    version: ...,
    subject: ...,
    date: ...,
    number: ...,
    revision: ...,
    default_dataset: ...,
    tags: ...,
    qc: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["datasets", "create"]
params = {
    "name": ...,
    "created_by": ...,
    "created_datetime": ...,
    "dataset_type": ...,
    "data_format": ...,
    "collection": ...,
    "session": ...,
    "file_size": ...,
    "hash": ...,
    "version": ...,
    "subject": ...,
    "date": ...,
    "number": ...,
    "revision": ...,
    "default_dataset": ...,
    "tags": ...,
    "qc": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

read

GET /datasets/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this dataset.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action datasets read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["datasets", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["datasets", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /datasets/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action datasets update -p id=... -p name=... -p created_by=... -p created_datetime=... -p dataset_type=... -p data_format=... -p collection=... -p session=... -p file_size=... -p hash=... -p version=... -p subject=... -p date=... -p number=... -p revision=... -p default_dataset=... -p tags=... -p qc=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["datasets", "update"]
var params = {
    id: ...,
    name: ...,
    created_by: ...,
    created_datetime: ...,
    dataset_type: ...,
    data_format: ...,
    collection: ...,
    session: ...,
    file_size: ...,
    hash: ...,
    version: ...,
    subject: ...,
    date: ...,
    number: ...,
    revision: ...,
    default_dataset: ...,
    tags: ...,
    qc: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["datasets", "update"]
params = {
    "id": ...,
    "name": ...,
    "created_by": ...,
    "created_datetime": ...,
    "dataset_type": ...,
    "data_format": ...,
    "collection": ...,
    "session": ...,
    "file_size": ...,
    "hash": ...,
    "version": ...,
    "subject": ...,
    "date": ...,
    "number": ...,
    "revision": ...,
    "default_dataset": ...,
    "tags": ...,
    "qc": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /datasets/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action datasets partial_update -p id=... -p name=... -p created_by=... -p created_datetime=... -p dataset_type=... -p data_format=... -p collection=... -p session=... -p file_size=... -p hash=... -p version=... -p subject=... -p date=... -p number=... -p revision=... -p default_dataset=... -p tags=... -p qc=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["datasets", "partial_update"]
var params = {
    id: ...,
    name: ...,
    created_by: ...,
    created_datetime: ...,
    dataset_type: ...,
    data_format: ...,
    collection: ...,
    session: ...,
    file_size: ...,
    hash: ...,
    version: ...,
    subject: ...,
    date: ...,
    number: ...,
    revision: ...,
    default_dataset: ...,
    tags: ...,
    qc: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["datasets", "partial_update"]
params = {
    "id": ...,
    "name": ...,
    "created_by": ...,
    "created_datetime": ...,
    "dataset_type": ...,
    "data_format": ...,
    "collection": ...,
    "session": ...,
    "file_size": ...,
    "hash": ...,
    "version": ...,
    "subject": ...,
    "date": ...,
    "number": ...,
    "revision": ...,
    "default_dataset": ...,
    "tags": ...,
    "qc": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /datasets/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this dataset.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action datasets delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["datasets", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["datasets", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

downloads

list

GET /downloads

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action downloads list -p limit=... -p offset=... -p count=... -p django=... -p json=... -p dataset=... -p user=... -p dataset_type=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["downloads", "list"]
var params = {
    limit: ...,
    offset: ...,
    count: ...,
    django: ...,
    json: ...,
    dataset: ...,
    user: ...,
    dataset_type: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["downloads", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "count": ...,
    "django": ...,
    "json": ...,
    "dataset": ...,
    "user": ...,
    "dataset_type": ...,
}
result = client.action(schema, action, params=params)

read

GET /downloads/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this download.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action downloads read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["downloads", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["downloads", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /downloads/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action downloads update -p id=... -p user=... -p count=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["downloads", "update"]
var params = {
    id: ...,
    user: ...,
    count: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["downloads", "update"]
params = {
    "id": ...,
    "user": ...,
    "count": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /downloads/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action downloads partial_update -p id=... -p user=... -p count=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["downloads", "partial_update"]
var params = {
    id: ...,
    user: ...,
    count: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["downloads", "partial_update"]
params = {
    "id": ...,
    "user": ...,
    "count": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

fields-of-view

list

GET /fields-of-view

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

===> FOV 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`
`imaging_type`
`datasets`
`stack`
`django`
`subject`
`lab`
`project`
`date`
`experiment_number`
`dataset_types`
`atlas_name`
`atlas_acronym`
`atlas_id`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action fields-of-view list -p limit=... -p offset=... -p id=... -p name=... -p session=... -p imaging_type=... -p datasets=... -p stack=... -p django=... -p subject=... -p lab=... -p project=... -p date=... -p experiment_number=... -p dataset_types=... -p atlas_name=... -p atlas_acronym=... -p atlas_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["fields-of-view", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    session: ...,
    imaging_type: ...,
    datasets: ...,
    stack: ...,
    django: ...,
    subject: ...,
    lab: ...,
    project: ...,
    date: ...,
    experiment_number: ...,
    dataset_types: ...,
    atlas_name: ...,
    atlas_acronym: ...,
    atlas_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["fields-of-view", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "session": ...,
    "imaging_type": ...,
    "datasets": ...,
    "stack": ...,
    "django": ...,
    "subject": ...,
    "lab": ...,
    "project": ...,
    "date": ...,
    "experiment_number": ...,
    "dataset_types": ...,
    "atlas_name": ...,
    "atlas_acronym": ...,
    "atlas_id": ...,
}
result = client.action(schema, action, params=params)

create

POST /fields-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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action fields-of-view create -p imaging_type=... -p name=... -p session=... -p stack=... -p datasets=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["fields-of-view", "create"]
var params = {
    imaging_type: ...,
    name: ...,
    session: ...,
    stack: ...,
    datasets: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["fields-of-view", "create"]
params = {
    "imaging_type": ...,
    "name": ...,
    "session": ...,
    "stack": ...,
    "datasets": ...,
}
result = client.action(schema, action, params=params)

read

GET /fields-of-view/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this field of view.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action fields-of-view read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["fields-of-view", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["fields-of-view", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /fields-of-view/{id}

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action fields-of-view update -p id=... -p imaging_type=... -p name=... -p session=... -p stack=... -p datasets=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["fields-of-view", "update"]
var params = {
    id: ...,
    imaging_type: ...,
    name: ...,
    session: ...,
    stack: ...,
    datasets: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["fields-of-view", "update"]
params = {
    "id": ...,
    "imaging_type": ...,
    "name": ...,
    "session": ...,
    "stack": ...,
    "datasets": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /fields-of-view/{id}

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action fields-of-view partial_update -p id=... -p imaging_type=... -p name=... -p session=... -p stack=... -p datasets=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["fields-of-view", "partial_update"]
var params = {
    id: ...,
    imaging_type: ...,
    name: ...,
    session: ...,
    stack: ...,
    datasets: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["fields-of-view", "partial_update"]
params = {
    "id": ...,
    "imaging_type": ...,
    "name": ...,
    "session": ...,
    "stack": ...,
    "datasets": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /fields-of-view/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this field of view.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action fields-of-view delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["fields-of-view", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["fields-of-view", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

files

list

GET /files

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action files list -p limit=... -p offset=... -p id=... -p name=... -p dataset=... -p data_repository=... -p relative_path=... -p exists=... -p django=... -p lab=... -p globus_is_personal=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    dataset: ...,
    data_repository: ...,
    relative_path: ...,
    exists: ...,
    django: ...,
    lab: ...,
    globus_is_personal: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["files", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "dataset": ...,
    "data_repository": ...,
    "relative_path": ...,
    "exists": ...,
    "django": ...,
    "lab": ...,
    "globus_is_personal": ...,
}
result = client.action(schema, action, params=params)

create

POST /files

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action files create -p dataset=... -p data_repository=... -p name=... -p json=... -p relative_path=... -p exists=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "create"]
var params = {
    dataset: ...,
    data_repository: ...,
    name: ...,
    json: ...,
    relative_path: ...,
    exists: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["files", "create"]
params = {
    "dataset": ...,
    "data_repository": ...,
    "name": ...,
    "json": ...,
    "relative_path": ...,
    "exists": ...,
}
result = client.action(schema, action, params=params)

read

GET /files/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this file record.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action files read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["files", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /files/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action files update -p id=... -p dataset=... -p data_repository=... -p name=... -p json=... -p relative_path=... -p exists=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "update"]
var params = {
    id: ...,
    dataset: ...,
    data_repository: ...,
    name: ...,
    json: ...,
    relative_path: ...,
    exists: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["files", "update"]
params = {
    "id": ...,
    "dataset": ...,
    "data_repository": ...,
    "name": ...,
    "json": ...,
    "relative_path": ...,
    "exists": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /files/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action files partial_update -p id=... -p dataset=... -p data_repository=... -p name=... -p json=... -p relative_path=... -p exists=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "partial_update"]
var params = {
    id: ...,
    dataset: ...,
    data_repository: ...,
    name: ...,
    json: ...,
    relative_path: ...,
    exists: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["files", "partial_update"]
params = {
    "id": ...,
    "dataset": ...,
    "data_repository": ...,
    "name": ...,
    "json": ...,
    "relative_path": ...,
    "exists": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /files/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this file record.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action files delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["files", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

fov-location

list

GET /fov-location

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action fov-location list -p limit=... -p offset=... -p id=... -p name=... -p field_of_view=... -p provenance=... -p default_provenance=... -p coordinate_system=... -p auto_datetime=... -p x=... -p y=... -p z=... -p n_xyz=... -p brain_region=... -p django=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["fov-location", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    field_of_view: ...,
    provenance: ...,
    default_provenance: ...,
    coordinate_system: ...,
    auto_datetime: ...,
    x: ...,
    y: ...,
    z: ...,
    n_xyz: ...,
    brain_region: ...,
    django: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["fov-location", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "field_of_view": ...,
    "provenance": ...,
    "default_provenance": ...,
    "coordinate_system": ...,
    "auto_datetime": ...,
    "x": ...,
    "y": ...,
    "z": ...,
    "n_xyz": ...,
    "brain_region": ...,
    "django": ...,
}
result = client.action(schema, action, params=params)

create

POST /fov-location

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action fov-location create -p brain_region=... -p coordinate_system=... -p provenance=... -p x=... -p y=... -p z=... -p n_xyz=... -p default_provenance=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["fov-location", "create"]
var params = {
    brain_region: ...,
    coordinate_system: ...,
    provenance: ...,
    x: ...,
    y: ...,
    z: ...,
    n_xyz: ...,
    default_provenance: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["fov-location", "create"]
params = {
    "brain_region": ...,
    "coordinate_system": ...,
    "provenance": ...,
    "x": ...,
    "y": ...,
    "z": ...,
    "n_xyz": ...,
    "default_provenance": ...,
}
result = client.action(schema, action, params=params)

imaging-stack

list

GET /imaging-stack

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action imaging-stack list -p limit=... -p offset=... -p id=... -p name=... -p django=... -p atlas_name=... -p atlas_acronym=... -p atlas_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["imaging-stack", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    django: ...,
    atlas_name: ...,
    atlas_acronym: ...,
    atlas_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["imaging-stack", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "django": ...,
    "atlas_name": ...,
    "atlas_acronym": ...,
    "atlas_id": ...,
}
result = client.action(schema, action, params=params)

create

POST /imaging-stack

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action imaging-stack create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["imaging-stack", "create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["imaging-stack", "create"]
result = client.action(schema, action)

read

GET /imaging-stack/{id}

===> 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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action imaging-stack read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["imaging-stack", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["imaging-stack", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

insertions

list

GET /insertions

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action insertions list -p limit=... -p offset=... -p id=... -p name=... -p session=... -p model=... -p serial=... -p auto_datetime=... -p datasets=... -p chronic_insertion=... -p django=... -p subject=... -p date=... -p experiment_number=... -p dataset_types=... -p dataset_qc_lte=... -p lab=... -p project=... -p task_protocol=... -p tag=... -p atlas_name=... -p atlas_acronym=... -p atlas_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["insertions", "list"]
var params = {
    limit: ...,
    offset: ...,
    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: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["insertions", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "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": ...,
}
result = client.action(schema, action, params=params)

create

POST /insertions

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action insertions create -p session=... -p model=... -p name=... -p json=... -p serial=... -p chronic_insertion=... -p datasets=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["insertions", "create"]
var params = {
    session: ...,
    model: ...,
    name: ...,
    json: ...,
    serial: ...,
    chronic_insertion: ...,
    datasets: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["insertions", "create"]
params = {
    "session": ...,
    "model": ...,
    "name": ...,
    "json": ...,
    "serial": ...,
    "chronic_insertion": ...,
    "datasets": ...,
}
result = client.action(schema, action, params=params)

read

GET /insertions/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this probe insertion.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action insertions read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["insertions", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["insertions", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /insertions/{id}

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action insertions update -p id=... -p session=... -p model=... -p name=... -p json=... -p serial=... -p chronic_insertion=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["insertions", "update"]
var params = {
    id: ...,
    session: ...,
    model: ...,
    name: ...,
    json: ...,
    serial: ...,
    chronic_insertion: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["insertions", "update"]
params = {
    "id": ...,
    "session": ...,
    "model": ...,
    "name": ...,
    "json": ...,
    "serial": ...,
    "chronic_insertion": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /insertions/{id}

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action insertions partial_update -p id=... -p session=... -p model=... -p name=... -p json=... -p serial=... -p chronic_insertion=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["insertions", "partial_update"]
var params = {
    id: ...,
    session: ...,
    model: ...,
    name: ...,
    json: ...,
    serial: ...,
    chronic_insertion: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["insertions", "partial_update"]
params = {
    "id": ...,
    "session": ...,
    "model": ...,
    "name": ...,
    "json": ...,
    "serial": ...,
    "chronic_insertion": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /insertions/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this probe insertion.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action insertions delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["insertions", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["insertions", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

labs

list

GET /labs

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action labs list -p limit=... -p offset=... -p id=... -p name=... -p institution=... -p address=... -p timezone=... -p reference_weight_pct=... -p zscore_weight_pct=... -p cage_type=... -p enrichment=... -p food=... -p cage_cleaning_frequency_days=... -p light_cycle=... -p repositories=... -p django=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labs", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    institution: ...,
    address: ...,
    timezone: ...,
    reference_weight_pct: ...,
    zscore_weight_pct: ...,
    cage_type: ...,
    enrichment: ...,
    food: ...,
    cage_cleaning_frequency_days: ...,
    light_cycle: ...,
    repositories: ...,
    django: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["labs", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "institution": ...,
    "address": ...,
    "timezone": ...,
    "reference_weight_pct": ...,
    "zscore_weight_pct": ...,
    "cage_type": ...,
    "enrichment": ...,
    "food": ...,
    "cage_cleaning_frequency_days": ...,
    "light_cycle": ...,
    "repositories": ...,
    "django": ...,
}
result = client.action(schema, action, params=params)

create

POST /labs

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action labs create -p name=... -p institution=... -p address=... -p timezone=... -p repositories=... -p reference_weight_pct=... -p zscore_weight_pct=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labs", "create"]
var params = {
    name: ...,
    institution: ...,
    address: ...,
    timezone: ...,
    repositories: ...,
    reference_weight_pct: ...,
    zscore_weight_pct: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["labs", "create"]
params = {
    "name": ...,
    "institution": ...,
    "address": ...,
    "timezone": ...,
    "repositories": ...,
    "reference_weight_pct": ...,
    "zscore_weight_pct": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

read

GET /labs/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action labs read -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labs", "read"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["labs", "read"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

update

PUT /labs/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action labs update -p name=... -p name=... -p institution=... -p address=... -p timezone=... -p repositories=... -p reference_weight_pct=... -p zscore_weight_pct=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labs", "update"]
var params = {
    name: ...,
    name: ...,
    institution: ...,
    address: ...,
    timezone: ...,
    repositories: ...,
    reference_weight_pct: ...,
    zscore_weight_pct: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["labs", "update"]
params = {
    "name": ...,
    "name": ...,
    "institution": ...,
    "address": ...,
    "timezone": ...,
    "repositories": ...,
    "reference_weight_pct": ...,
    "zscore_weight_pct": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /labs/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action labs partial_update -p name=... -p name=... -p institution=... -p address=... -p timezone=... -p repositories=... -p reference_weight_pct=... -p zscore_weight_pct=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labs", "partial_update"]
var params = {
    name: ...,
    name: ...,
    institution: ...,
    address: ...,
    timezone: ...,
    repositories: ...,
    reference_weight_pct: ...,
    zscore_weight_pct: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["labs", "partial_update"]
params = {
    "name": ...,
    "name": ...,
    "institution": ...,
    "address": ...,
    "timezone": ...,
    "repositories": ...,
    "reference_weight_pct": ...,
    "zscore_weight_pct": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /labs/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action labs delete -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labs", "delete"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["labs", "delete"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

locations

list

GET /locations

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action locations list -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["locations", "list"]
var params = {
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["locations", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

read

GET /locations/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action locations read -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["locations", "read"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["locations", "read"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

update

PUT /locations/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action locations update -p name=... -p name=... -p lab=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["locations", "update"]
var params = {
    name: ...,
    name: ...,
    lab: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["locations", "update"]
params = {
    "name": ...,
    "name": ...,
    "lab": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /locations/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action locations partial_update -p name=... -p name=... -p lab=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["locations", "partial_update"]
var params = {
    name: ...,
    name: ...,
    lab: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["locations", "partial_update"]
params = {
    "name": ...,
    "name": ...,
    "lab": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

new-download

create

POST /new-download

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action new-download create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["new-download", "create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["new-download", "create"]
result = client.action(schema, action)

notes

list

GET /notes

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action notes list -p limit=... -p offset=... -p django=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["notes", "list"]
var params = {
    limit: ...,
    offset: ...,
    django: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["notes", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "django": ...,
}
result = client.action(schema, action, params=params)

create

POST /notes

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action notes create -p user=... -p date_time=... -p content_type=... -p object_id=... -p text=... -p image=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["notes", "create"]
var params = {
    user: ...,
    date_time: ...,
    content_type: ...,
    object_id: ...,
    text: ...,
    image: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["notes", "create"]
params = {
    "user": ...,
    "date_time": ...,
    "content_type": ...,
    "object_id": ...,
    "text": ...,
    "image": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

read

GET /notes/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this note.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action notes read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["notes", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["notes", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /notes/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action notes update -p id=... -p user=... -p date_time=... -p content_type=... -p object_id=... -p text=... -p image=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["notes", "update"]
var params = {
    id: ...,
    user: ...,
    date_time: ...,
    content_type: ...,
    object_id: ...,
    text: ...,
    image: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["notes", "update"]
params = {
    "id": ...,
    "user": ...,
    "date_time": ...,
    "content_type": ...,
    "object_id": ...,
    "text": ...,
    "image": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /notes/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action notes partial_update -p id=... -p user=... -p date_time=... -p content_type=... -p object_id=... -p text=... -p image=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["notes", "partial_update"]
var params = {
    id: ...,
    user: ...,
    date_time: ...,
    content_type: ...,
    object_id: ...,
    text: ...,
    image: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["notes", "partial_update"]
params = {
    "id": ...,
    "user": ...,
    "date_time": ...,
    "content_type": ...,
    "object_id": ...,
    "text": ...,
    "image": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /notes/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this note.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action notes delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["notes", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["notes", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

procedures

list

GET /procedures

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action procedures list -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["procedures", "list"]
var params = {
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["procedures", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

create

POST /procedures

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action procedures create -p name=... -p json=... -p description=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["procedures", "create"]
var params = {
    name: ...,
    json: ...,
    description: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["procedures", "create"]
params = {
    "name": ...,
    "json": ...,
    "description": ...,
}
result = client.action(schema, action, params=params)

projects

list

GET /projects

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action projects list -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "list"]
var params = {
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["projects", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

create

POST /projects

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action projects create -p name=... -p description=... -p users=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "create"]
var params = {
    name: ...,
    description: ...,
    users: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["projects", "create"]
params = {
    "name": ...,
    "description": ...,
    "users": ...,
}
result = client.action(schema, action, params=params)

read

GET /projects/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action projects read -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "read"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["projects", "read"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

update

PUT /projects/{name}

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action projects update -p name=... -p name=... -p description=... -p users=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "update"]
var params = {
    name: ...,
    name: ...,
    description: ...,
    users: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["projects", "update"]
params = {
    "name": ...,
    "name": ...,
    "description": ...,
    "users": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /projects/{name}

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action projects partial_update -p name=... -p name=... -p description=... -p users=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "partial_update"]
var params = {
    name: ...,
    name: ...,
    description: ...,
    users: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["projects", "partial_update"]
params = {
    "name": ...,
    "name": ...,
    "description": ...,
    "users": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /projects/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action projects delete -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["projects", "delete"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["projects", "delete"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

register-file

create

POST /register-file

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)

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action register-file create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["register-file", "create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["register-file", "create"]
result = client.action(schema, action)

revisions

list

GET /revisions

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action revisions list -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["revisions", "list"]
var params = {
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["revisions", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

create

POST /revisions

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action revisions create -p json=... -p name=... -p description=... -p created_datetime=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["revisions", "create"]
var params = {
    json: ...,
    name: ...,
    description: ...,
    created_datetime: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["revisions", "create"]
params = {
    "json": ...,
    "name": ...,
    "description": ...,
    "created_datetime": ...,
}
result = client.action(schema, action, params=params)

read

GET /revisions/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required	Long name

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action revisions read -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["revisions", "read"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["revisions", "read"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

update

PUT /revisions/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action revisions update -p name=... -p json=... -p name=... -p description=... -p created_datetime=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["revisions", "update"]
var params = {
    name: ...,
    json: ...,
    name: ...,
    description: ...,
    created_datetime: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["revisions", "update"]
params = {
    "name": ...,
    "json": ...,
    "name": ...,
    "description": ...,
    "created_datetime": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /revisions/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action revisions partial_update -p name=... -p json=... -p name=... -p description=... -p created_datetime=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["revisions", "partial_update"]
var params = {
    name: ...,
    json: ...,
    name: ...,
    description: ...,
    created_datetime: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["revisions", "partial_update"]
params = {
    "name": ...,
    "json": ...,
    "name": ...,
    "description": ...,
    "created_datetime": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /revisions/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required	Long name

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action revisions delete -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["revisions", "delete"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["revisions", "delete"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

sessions

list

GET /sessions

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,
extended_qc queries on json fields, for example here qc_bool and qc_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,
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

===> 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`
`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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action sessions list -p limit=... -p offset=... -p id=... -p name=... -p json=... -p users=... -p subject=... -p location=... -p lab=... -p procedures=... -p narrative=... -p start_time=... -p end_time=... -p parent_session=... -p projects=... -p type=... -p number=... -p task_protocol=... -p n_trials=... -p n_correct_trials=... -p qc=... -p extended_qc=... -p auto_datetime=... -p django=... -p nickname=... -p date_range=... -p dataset_types=... -p datasets=... -p dataset_qc_lte=... -p performance_gte=... -p performance_lte=... -p project=... -p atlas_name=... -p atlas_acronym=... -p atlas_id=... -p histology=... -p tag=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["sessions", "list"]
var params = {
    limit: ...,
    offset: ...,
    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: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["sessions", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "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": ...,
}
result = client.action(schema, action, params=params)

create

POST /sessions

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action sessions create -p subject=... -p start_time=... -p number=... -p lab=... -p projects=... -p task_protocol=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["sessions", "create"]
var params = {
    subject: ...,
    start_time: ...,
    number: ...,
    lab: ...,
    projects: ...,
    task_protocol: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["sessions", "create"]
params = {
    "subject": ...,
    "start_time": ...,
    "number": ...,
    "lab": ...,
    "projects": ...,
    "task_protocol": ...,
}
result = client.action(schema, action, params=params)

read

GET /sessions/{id}

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action sessions read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["sessions", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["sessions", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /sessions/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action sessions update -p id=... -p subject=... -p users=... -p location=... -p procedures=... -p lab=... -p projects=... -p type=... -p task_protocol=... -p number=... -p start_time=... -p end_time=... -p narrative=... -p parent_session=... -p n_correct_trials=... -p n_trials=... -p extended_qc=... -p qc=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["sessions", "update"]
var params = {
    id: ...,
    subject: ...,
    users: ...,
    location: ...,
    procedures: ...,
    lab: ...,
    projects: ...,
    type: ...,
    task_protocol: ...,
    number: ...,
    start_time: ...,
    end_time: ...,
    narrative: ...,
    parent_session: ...,
    n_correct_trials: ...,
    n_trials: ...,
    extended_qc: ...,
    qc: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["sessions", "update"]
params = {
    "id": ...,
    "subject": ...,
    "users": ...,
    "location": ...,
    "procedures": ...,
    "lab": ...,
    "projects": ...,
    "type": ...,
    "task_protocol": ...,
    "number": ...,
    "start_time": ...,
    "end_time": ...,
    "narrative": ...,
    "parent_session": ...,
    "n_correct_trials": ...,
    "n_trials": ...,
    "extended_qc": ...,
    "qc": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /sessions/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action sessions partial_update -p id=... -p subject=... -p users=... -p location=... -p procedures=... -p lab=... -p projects=... -p type=... -p task_protocol=... -p number=... -p start_time=... -p end_time=... -p narrative=... -p parent_session=... -p n_correct_trials=... -p n_trials=... -p extended_qc=... -p qc=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["sessions", "partial_update"]
var params = {
    id: ...,
    subject: ...,
    users: ...,
    location: ...,
    procedures: ...,
    lab: ...,
    projects: ...,
    type: ...,
    task_protocol: ...,
    number: ...,
    start_time: ...,
    end_time: ...,
    narrative: ...,
    parent_session: ...,
    n_correct_trials: ...,
    n_trials: ...,
    extended_qc: ...,
    qc: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["sessions", "partial_update"]
params = {
    "id": ...,
    "subject": ...,
    "users": ...,
    "location": ...,
    "procedures": ...,
    "lab": ...,
    "projects": ...,
    "type": ...,
    "task_protocol": ...,
    "number": ...,
    "start_time": ...,
    "end_time": ...,
    "narrative": ...,
    "parent_session": ...,
    "n_correct_trials": ...,
    "n_trials": ...,
    "extended_qc": ...,
    "qc": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /sessions/{id}

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action sessions delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["sessions", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["sessions", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

subjects

list

GET /subjects

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action subjects list -p limit=... -p offset=... -p id=... -p name=... -p json=... -p nickname=... -p species=... -p litter=... -p sex=... -p strain=... -p genotype=... -p genotype_test=... -p source=... -p line=... -p birth_date=... -p death_date=... -p wean_date=... -p genotype_date=... -p responsible_user=... -p lab=... -p projects=... -p cage=... -p request=... -p ear_mark=... -p protocol_number=... -p description=... -p cull_method=... -p adverse_effects=... -p actual_severity=... -p to_be_genotyped=... -p to_be_culled=... -p reduced=... -p reduced_date=... -p django=... -p alive=... -p stock=... -p water_restricted=... -p project=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["subjects", "list"]
var params = {
    limit: ...,
    offset: ...,
    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: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["subjects", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "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": ...,
}
result = client.action(schema, action, params=params)

create

POST /subjects

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action subjects create -p nickname=... -p responsible_user=... -p birth_date=... -p death_date=... -p species=... -p sex=... -p litter=... -p strain=... -p source=... -p line=... -p projects=... -p lab=... -p genotype=... -p description=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["subjects", "create"]
var params = {
    nickname: ...,
    responsible_user: ...,
    birth_date: ...,
    death_date: ...,
    species: ...,
    sex: ...,
    litter: ...,
    strain: ...,
    source: ...,
    line: ...,
    projects: ...,
    lab: ...,
    genotype: ...,
    description: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["subjects", "create"]
params = {
    "nickname": ...,
    "responsible_user": ...,
    "birth_date": ...,
    "death_date": ...,
    "species": ...,
    "sex": ...,
    "litter": ...,
    "strain": ...,
    "source": ...,
    "line": ...,
    "projects": ...,
    "lab": ...,
    "genotype": ...,
    "description": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

read

GET /subjects/{nickname}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`nickname` required	Easy-to-remember name (e.g. 'Hercules').

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action subjects read -p nickname=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["subjects", "read"]
var params = {
    nickname: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["subjects", "read"]
params = {
    "nickname": ...,
}
result = client.action(schema, action, params=params)

update

PUT /subjects/{nickname}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action subjects update -p nickname=... -p nickname=... -p responsible_user=... -p birth_date=... -p death_date=... -p species=... -p sex=... -p litter=... -p strain=... -p source=... -p line=... -p projects=... -p lab=... -p description=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["subjects", "update"]
var params = {
    nickname: ...,
    nickname: ...,
    responsible_user: ...,
    birth_date: ...,
    death_date: ...,
    species: ...,
    sex: ...,
    litter: ...,
    strain: ...,
    source: ...,
    line: ...,
    projects: ...,
    lab: ...,
    description: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["subjects", "update"]
params = {
    "nickname": ...,
    "nickname": ...,
    "responsible_user": ...,
    "birth_date": ...,
    "death_date": ...,
    "species": ...,
    "sex": ...,
    "litter": ...,
    "strain": ...,
    "source": ...,
    "line": ...,
    "projects": ...,
    "lab": ...,
    "description": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /subjects/{nickname}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action subjects partial_update -p nickname=... -p nickname=... -p responsible_user=... -p birth_date=... -p death_date=... -p species=... -p sex=... -p litter=... -p strain=... -p source=... -p line=... -p projects=... -p lab=... -p description=... -p json=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["subjects", "partial_update"]
var params = {
    nickname: ...,
    nickname: ...,
    responsible_user: ...,
    birth_date: ...,
    death_date: ...,
    species: ...,
    sex: ...,
    litter: ...,
    strain: ...,
    source: ...,
    line: ...,
    projects: ...,
    lab: ...,
    description: ...,
    json: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["subjects", "partial_update"]
params = {
    "nickname": ...,
    "nickname": ...,
    "responsible_user": ...,
    "birth_date": ...,
    "death_date": ...,
    "species": ...,
    "sex": ...,
    "litter": ...,
    "strain": ...,
    "source": ...,
    "line": ...,
    "projects": ...,
    "lab": ...,
    "description": ...,
    "json": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /subjects/{nickname}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`nickname` required	Easy-to-remember name (e.g. 'Hercules').

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action subjects delete -p nickname=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["subjects", "delete"]
var params = {
    nickname: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["subjects", "delete"]
params = {
    "nickname": ...,
}
result = client.action(schema, action, params=params)

surgeries

list

GET /surgeries

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action surgeries list -p limit=... -p offset=... -p id=... -p name=... -p json=... -p users=... -p subject=... -p lab=... -p procedures=... -p narrative=... -p start_time=... -p end_time=... -p outcome_type=... -p location=... -p implant_weight=... -p django=... -p nickname=... -p date_range=... -p procedure=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["surgeries", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    json: ...,
    users: ...,
    subject: ...,
    lab: ...,
    procedures: ...,
    narrative: ...,
    start_time: ...,
    end_time: ...,
    outcome_type: ...,
    location: ...,
    implant_weight: ...,
    django: ...,
    nickname: ...,
    date_range: ...,
    procedure: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["surgeries", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "json": ...,
    "users": ...,
    "subject": ...,
    "lab": ...,
    "procedures": ...,
    "narrative": ...,
    "start_time": ...,
    "end_time": ...,
    "outcome_type": ...,
    "location": ...,
    "implant_weight": ...,
    "django": ...,
    "nickname": ...,
    "date_range": ...,
    "procedure": ...,
}
result = client.action(schema, action, params=params)

read

GET /surgeries/{id}

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action surgeries read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["surgeries", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["surgeries", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /surgeries/{id}

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` required	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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action surgeries update -p id=... -p subject=... -p name=... -p json=... -p narrative=... -p start_time=... -p end_time=... -p outcome_type=... -p implant_weight=... -p lab=... -p location=... -p users=... -p procedures=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["surgeries", "update"]
var params = {
    id: ...,
    subject: ...,
    name: ...,
    json: ...,
    narrative: ...,
    start_time: ...,
    end_time: ...,
    outcome_type: ...,
    implant_weight: ...,
    lab: ...,
    location: ...,
    users: ...,
    procedures: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["surgeries", "update"]
params = {
    "id": ...,
    "subject": ...,
    "name": ...,
    "json": ...,
    "narrative": ...,
    "start_time": ...,
    "end_time": ...,
    "outcome_type": ...,
    "implant_weight": ...,
    "lab": ...,
    "location": ...,
    "users": ...,
    "procedures": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /surgeries/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action surgeries partial_update -p id=... -p subject=... -p name=... -p json=... -p narrative=... -p start_time=... -p end_time=... -p outcome_type=... -p implant_weight=... -p lab=... -p location=... -p users=... -p procedures=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["surgeries", "partial_update"]
var params = {
    id: ...,
    subject: ...,
    name: ...,
    json: ...,
    narrative: ...,
    start_time: ...,
    end_time: ...,
    outcome_type: ...,
    implant_weight: ...,
    lab: ...,
    location: ...,
    users: ...,
    procedures: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["surgeries", "partial_update"]
params = {
    "id": ...,
    "subject": ...,
    "name": ...,
    "json": ...,
    "narrative": ...,
    "start_time": ...,
    "end_time": ...,
    "outcome_type": ...,
    "implant_weight": ...,
    "lab": ...,
    "location": ...,
    "users": ...,
    "procedures": ...,
}
result = client.action(schema, action, params=params)

sync-file-status

read

GET /sync-file-status

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action sync-file-status read

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["sync-file-status", "read"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["sync-file-status", "read"]
result = client.action(schema, action)

create

POST /sync-file-status

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action sync-file-status create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["sync-file-status", "create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["sync-file-status", "create"]
result = client.action(schema, action)

tasks

list

GET /tasks

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

===> task 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`
`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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action tasks list -p limit=... -p offset=... -p id=... -p name=... -p priority=... -p io_charge=... -p level=... -p gpu=... -p cpu=... -p ram=... -p time_out_secs=... -p time_elapsed_secs=... -p executable=... -p graph=... -p status=... -p log=... -p session=... -p version=... -p parents=... -p datetime=... -p arguments=... -p data_repository=... -p django=... -p lab=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "list"]
var params = {
    limit: ...,
    offset: ...,
    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: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["tasks", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "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": ...,
}
result = client.action(schema, action, params=params)

create

POST /tasks

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action tasks create -p parents=... -p session=... -p data_repository=... -p status=... -p name=... -p priority=... -p io_charge=... -p level=... -p gpu=... -p cpu=... -p ram=... -p time_out_secs=... -p time_elapsed_secs=... -p executable=... -p graph=... -p log=... -p version=... -p arguments=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "create"]
var params = {
    parents: ...,
    session: ...,
    data_repository: ...,
    status: ...,
    name: ...,
    priority: ...,
    io_charge: ...,
    level: ...,
    gpu: ...,
    cpu: ...,
    ram: ...,
    time_out_secs: ...,
    time_elapsed_secs: ...,
    executable: ...,
    graph: ...,
    log: ...,
    version: ...,
    arguments: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["tasks", "create"]
params = {
    "parents": ...,
    "session": ...,
    "data_repository": ...,
    "status": ...,
    "name": ...,
    "priority": ...,
    "io_charge": ...,
    "level": ...,
    "gpu": ...,
    "cpu": ...,
    "ram": ...,
    "time_out_secs": ...,
    "time_elapsed_secs": ...,
    "executable": ...,
    "graph": ...,
    "log": ...,
    "version": ...,
    "arguments": ...,
}
result = client.action(schema, action, params=params)

read

GET /tasks/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this task.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action tasks read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["tasks", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /tasks/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action tasks update -p id=... -p parents=... -p session=... -p data_repository=... -p status=... -p name=... -p priority=... -p io_charge=... -p level=... -p gpu=... -p cpu=... -p ram=... -p time_out_secs=... -p time_elapsed_secs=... -p executable=... -p graph=... -p log=... -p version=... -p arguments=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "update"]
var params = {
    id: ...,
    parents: ...,
    session: ...,
    data_repository: ...,
    status: ...,
    name: ...,
    priority: ...,
    io_charge: ...,
    level: ...,
    gpu: ...,
    cpu: ...,
    ram: ...,
    time_out_secs: ...,
    time_elapsed_secs: ...,
    executable: ...,
    graph: ...,
    log: ...,
    version: ...,
    arguments: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["tasks", "update"]
params = {
    "id": ...,
    "parents": ...,
    "session": ...,
    "data_repository": ...,
    "status": ...,
    "name": ...,
    "priority": ...,
    "io_charge": ...,
    "level": ...,
    "gpu": ...,
    "cpu": ...,
    "ram": ...,
    "time_out_secs": ...,
    "time_elapsed_secs": ...,
    "executable": ...,
    "graph": ...,
    "log": ...,
    "version": ...,
    "arguments": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /tasks/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action tasks partial_update -p id=... -p parents=... -p session=... -p data_repository=... -p status=... -p name=... -p priority=... -p io_charge=... -p level=... -p gpu=... -p cpu=... -p ram=... -p time_out_secs=... -p time_elapsed_secs=... -p executable=... -p graph=... -p log=... -p version=... -p arguments=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "partial_update"]
var params = {
    id: ...,
    parents: ...,
    session: ...,
    data_repository: ...,
    status: ...,
    name: ...,
    priority: ...,
    io_charge: ...,
    level: ...,
    gpu: ...,
    cpu: ...,
    ram: ...,
    time_out_secs: ...,
    time_elapsed_secs: ...,
    executable: ...,
    graph: ...,
    log: ...,
    version: ...,
    arguments: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["tasks", "partial_update"]
params = {
    "id": ...,
    "parents": ...,
    "session": ...,
    "data_repository": ...,
    "status": ...,
    "name": ...,
    "priority": ...,
    "io_charge": ...,
    "level": ...,
    "gpu": ...,
    "cpu": ...,
    "ram": ...,
    "time_out_secs": ...,
    "time_elapsed_secs": ...,
    "executable": ...,
    "graph": ...,
    "log": ...,
    "version": ...,
    "arguments": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /tasks/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this task.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action tasks delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["tasks", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["tasks", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

trajectories

list

GET /trajectories

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action trajectories list -p limit=... -p offset=... -p id=... -p probe_insertion=... -p chronic_insertion=... -p x=... -p y=... -p z=... -p depth=... -p theta=... -p phi=... -p roll=... -p provenance=... -p coordinate_system=... -p datetime=... -p django=... -p subject=... -p project=... -p date=... -p experiment_number=... -p session=... -p probe=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["trajectories", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    probe_insertion: ...,
    chronic_insertion: ...,
    x: ...,
    y: ...,
    z: ...,
    depth: ...,
    theta: ...,
    phi: ...,
    roll: ...,
    provenance: ...,
    coordinate_system: ...,
    datetime: ...,
    django: ...,
    subject: ...,
    project: ...,
    date: ...,
    experiment_number: ...,
    session: ...,
    probe: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["trajectories", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "probe_insertion": ...,
    "chronic_insertion": ...,
    "x": ...,
    "y": ...,
    "z": ...,
    "depth": ...,
    "theta": ...,
    "phi": ...,
    "roll": ...,
    "provenance": ...,
    "coordinate_system": ...,
    "datetime": ...,
    "django": ...,
    "subject": ...,
    "project": ...,
    "date": ...,
    "experiment_number": ...,
    "session": ...,
    "probe": ...,
}
result = client.action(schema, action, params=params)

create

POST /trajectories

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action trajectories create -p probe_insertion=... -p x=... -p y=... -p z=... -p depth=... -p theta=... -p phi=... -p roll=... -p provenance=... -p coordinate_system=... -p json=... -p chronic_insertion=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["trajectories", "create"]
var params = {
    probe_insertion: ...,
    x: ...,
    y: ...,
    z: ...,
    depth: ...,
    theta: ...,
    phi: ...,
    roll: ...,
    provenance: ...,
    coordinate_system: ...,
    json: ...,
    chronic_insertion: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["trajectories", "create"]
params = {
    "probe_insertion": ...,
    "x": ...,
    "y": ...,
    "z": ...,
    "depth": ...,
    "theta": ...,
    "phi": ...,
    "roll": ...,
    "provenance": ...,
    "coordinate_system": ...,
    "json": ...,
    "chronic_insertion": ...,
}
result = client.action(schema, action, params=params)

read

GET /trajectories/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this trajectory estimate.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action trajectories read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["trajectories", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["trajectories", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /trajectories/{id}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action trajectories update -p id=... -p probe_insertion=... -p x=... -p y=... -p z=... -p depth=... -p theta=... -p phi=... -p roll=... -p provenance=... -p coordinate_system=... -p json=... -p chronic_insertion=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["trajectories", "update"]
var params = {
    id: ...,
    probe_insertion: ...,
    x: ...,
    y: ...,
    z: ...,
    depth: ...,
    theta: ...,
    phi: ...,
    roll: ...,
    provenance: ...,
    coordinate_system: ...,
    json: ...,
    chronic_insertion: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["trajectories", "update"]
params = {
    "id": ...,
    "probe_insertion": ...,
    "x": ...,
    "y": ...,
    "z": ...,
    "depth": ...,
    "theta": ...,
    "phi": ...,
    "roll": ...,
    "provenance": ...,
    "coordinate_system": ...,
    "json": ...,
    "chronic_insertion": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /trajectories/{id}

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`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action trajectories partial_update -p id=... -p probe_insertion=... -p x=... -p y=... -p z=... -p depth=... -p theta=... -p phi=... -p roll=... -p provenance=... -p coordinate_system=... -p json=... -p chronic_insertion=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["trajectories", "partial_update"]
var params = {
    id: ...,
    probe_insertion: ...,
    x: ...,
    y: ...,
    z: ...,
    depth: ...,
    theta: ...,
    phi: ...,
    roll: ...,
    provenance: ...,
    coordinate_system: ...,
    json: ...,
    chronic_insertion: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["trajectories", "partial_update"]
params = {
    "id": ...,
    "probe_insertion": ...,
    "x": ...,
    "y": ...,
    "z": ...,
    "depth": ...,
    "theta": ...,
    "phi": ...,
    "roll": ...,
    "provenance": ...,
    "coordinate_system": ...,
    "json": ...,
    "chronic_insertion": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /trajectories/{id}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this trajectory estimate.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action trajectories delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["trajectories", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["trajectories", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

uploaded

read

GET /uploaded/{img_url}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`img_url` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action uploaded read -p img_url=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["uploaded", "read"]
var params = {
    img_url: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["uploaded", "read"]
params = {
    "img_url": ...,
}
result = client.action(schema, action, params=params)

users

list

GET /users

FILTERS - 'id' - 'username' - 'email' - 'subjects_responsible' - 'lab' - 'allowed_users' ===> user 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.
`password`
`last_login`
`is_superuser`
`groups`
`user_permissions`
`username`
`first_name`
`last_name`
`email`
`is_staff`
`is_active`
`date_joined`
`id`
`is_stock_manager`
`allowed_users`
`is_public_user`
`django`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action users list -p limit=... -p offset=... -p password=... -p last_login=... -p is_superuser=... -p groups=... -p user_permissions=... -p username=... -p first_name=... -p last_name=... -p email=... -p is_staff=... -p is_active=... -p date_joined=... -p id=... -p is_stock_manager=... -p allowed_users=... -p is_public_user=... -p django=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "list"]
var params = {
    limit: ...,
    offset: ...,
    password: ...,
    last_login: ...,
    is_superuser: ...,
    groups: ...,
    user_permissions: ...,
    username: ...,
    first_name: ...,
    last_name: ...,
    email: ...,
    is_staff: ...,
    is_active: ...,
    date_joined: ...,
    id: ...,
    is_stock_manager: ...,
    allowed_users: ...,
    is_public_user: ...,
    django: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["users", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "password": ...,
    "last_login": ...,
    "is_superuser": ...,
    "groups": ...,
    "user_permissions": ...,
    "username": ...,
    "first_name": ...,
    "last_name": ...,
    "email": ...,
    "is_staff": ...,
    "is_active": ...,
    "date_joined": ...,
    "id": ...,
    "is_stock_manager": ...,
    "allowed_users": ...,
    "is_public_user": ...,
    "django": ...,
}
result = client.action(schema, action, params=params)

create

POST /users

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`email`
`subjects_responsible` required
`allowed_users` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action users create -p username=... -p email=... -p subjects_responsible=... -p allowed_users=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "create"]
var params = {
    username: ...,
    email: ...,
    subjects_responsible: ...,
    allowed_users: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["users", "create"]
params = {
    "username": ...,
    "email": ...,
    "subjects_responsible": ...,
    "allowed_users": ...,
}
result = client.action(schema, action, params=params)

read

GET /users/{username}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action users read -p username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "read"]
var params = {
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["users", "read"]
params = {
    "username": ...,
}
result = client.action(schema, action, params=params)

update

PUT /users/{username}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`email`
`subjects_responsible` required
`allowed_users` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action users update -p username=... -p username=... -p email=... -p subjects_responsible=... -p allowed_users=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "update"]
var params = {
    username: ...,
    username: ...,
    email: ...,
    subjects_responsible: ...,
    allowed_users: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["users", "update"]
params = {
    "username": ...,
    "username": ...,
    "email": ...,
    "subjects_responsible": ...,
    "allowed_users": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /users/{username}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username`	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`email`
`subjects_responsible`
`allowed_users`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action users partial_update -p username=... -p username=... -p email=... -p subjects_responsible=... -p allowed_users=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "partial_update"]
var params = {
    username: ...,
    username: ...,
    email: ...,
    subjects_responsible: ...,
    allowed_users: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["users", "partial_update"]
params = {
    "username": ...,
    "username": ...,
    "email": ...,
    "subjects_responsible": ...,
    "allowed_users": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /users/{username}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action users delete -p username=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["users", "delete"]
var params = {
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["users", "delete"]
params = {
    "username": ...,
}
result = client.action(schema, action, params=params)

water-administrations

list

GET /water-administrations

Lists or creates a new water administration.

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`
`user`
`subject`
`date_time`
`session`
`water_administered`
`water_type`
`adlib`
`django`
`nickname`
`users`
`date_range`
`lab`
`location`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-administrations list -p limit=... -p offset=... -p id=... -p name=... -p json=... -p user=... -p subject=... -p date_time=... -p session=... -p water_administered=... -p water_type=... -p adlib=... -p django=... -p nickname=... -p users=... -p date_range=... -p lab=... -p location=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-administrations", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    json: ...,
    user: ...,
    subject: ...,
    date_time: ...,
    session: ...,
    water_administered: ...,
    water_type: ...,
    adlib: ...,
    django: ...,
    nickname: ...,
    users: ...,
    date_range: ...,
    lab: ...,
    location: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-administrations", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "json": ...,
    "user": ...,
    "subject": ...,
    "date_time": ...,
    "session": ...,
    "water_administered": ...,
    "water_type": ...,
    "adlib": ...,
    "django": ...,
    "nickname": ...,
    "users": ...,
    "date_range": ...,
    "lab": ...,
    "location": ...,
}
result = client.action(schema, action, params=params)

create

POST /water-administrations

Lists or creates a new water administration.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`subject` required
`date_time`
`water_administered`	Water administered, in milliliters
`water_type`
`user`
`session`
`adlib`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-administrations create -p subject=... -p date_time=... -p water_administered=... -p water_type=... -p user=... -p session=... -p adlib=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-administrations", "create"]
var params = {
    subject: ...,
    date_time: ...,
    water_administered: ...,
    water_type: ...,
    user: ...,
    session: ...,
    adlib: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-administrations", "create"]
params = {
    "subject": ...,
    "date_time": ...,
    "water_administered": ...,
    "water_type": ...,
    "user": ...,
    "session": ...,
    "adlib": ...,
}
result = client.action(schema, action, params=params)

read

GET /water-administrations/{id}

Allows viewing of full detail and deleting a water administration.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this water administration.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-administrations read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-administrations", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-administrations", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /water-administrations/{id}

Allows viewing of full detail and deleting a water administration.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this water administration.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`subject` required
`date_time`
`water_administered`	Water administered, in milliliters
`water_type`
`user`
`session`
`adlib`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-administrations update -p id=... -p subject=... -p date_time=... -p water_administered=... -p water_type=... -p user=... -p session=... -p adlib=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-administrations", "update"]
var params = {
    id: ...,
    subject: ...,
    date_time: ...,
    water_administered: ...,
    water_type: ...,
    user: ...,
    session: ...,
    adlib: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-administrations", "update"]
params = {
    "id": ...,
    "subject": ...,
    "date_time": ...,
    "water_administered": ...,
    "water_type": ...,
    "user": ...,
    "session": ...,
    "adlib": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /water-administrations/{id}

Allows viewing of full detail and deleting a water administration.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this water administration.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`subject`
`date_time`
`water_administered`	Water administered, in milliliters
`water_type`
`user`
`session`
`adlib`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-administrations partial_update -p id=... -p subject=... -p date_time=... -p water_administered=... -p water_type=... -p user=... -p session=... -p adlib=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-administrations", "partial_update"]
var params = {
    id: ...,
    subject: ...,
    date_time: ...,
    water_administered: ...,
    water_type: ...,
    user: ...,
    session: ...,
    adlib: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-administrations", "partial_update"]
params = {
    "id": ...,
    "subject": ...,
    "date_time": ...,
    "water_administered": ...,
    "water_type": ...,
    "user": ...,
    "session": ...,
    "adlib": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /water-administrations/{id}

Allows viewing of full detail and deleting a water administration.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this water administration.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-administrations delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-administrations", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-administrations", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

water-requirement

read

GET /water-requirement/{nickname}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`nickname` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-requirement read -p nickname=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-requirement", "read"]
var params = {
    nickname: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-requirement", "read"]
params = {
    "nickname": ...,
}
result = client.action(schema, action, params=params)

water-restricted-subjects

list

GET /water-restricted-subjects

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-restricted-subjects list -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-restricted-subjects", "list"]
var params = {
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-restricted-subjects", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

water-restriction

list

GET /water-restriction

Lists water restriction.

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`
`reference_weight`
`water_type`
`django`
`nickname`
`date_range`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-restriction list -p limit=... -p offset=... -p id=... -p name=... -p json=... -p users=... -p subject=... -p location=... -p lab=... -p procedures=... -p narrative=... -p start_time=... -p end_time=... -p reference_weight=... -p water_type=... -p django=... -p nickname=... -p date_range=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-restriction", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    json: ...,
    users: ...,
    subject: ...,
    location: ...,
    lab: ...,
    procedures: ...,
    narrative: ...,
    start_time: ...,
    end_time: ...,
    reference_weight: ...,
    water_type: ...,
    django: ...,
    nickname: ...,
    date_range: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-restriction", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "json": ...,
    "users": ...,
    "subject": ...,
    "location": ...,
    "lab": ...,
    "procedures": ...,
    "narrative": ...,
    "start_time": ...,
    "end_time": ...,
    "reference_weight": ...,
    "water_type": ...,
    "django": ...,
    "nickname": ...,
    "date_range": ...,
}
result = client.action(schema, action, params=params)

water-type

list

GET /water-type

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.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-type list -p limit=... -p offset=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-type", "list"]
var params = {
    limit: ...,
    offset: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-type", "list"]
params = {
    "limit": ...,
    "offset": ...,
}
result = client.action(schema, action, params=params)

create

POST /water-type

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-type create -p json=... -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-type", "create"]
var params = {
    json: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-type", "create"]
params = {
    "json": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

read

GET /water-type/{name}

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`name` required

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-type read -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-type", "read"]
var params = {
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-type", "read"]
params = {
    "name": ...,
}
result = client.action(schema, action, params=params)

create_0

POST /water-type/{name}

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

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action water-type create_0 -p name=... -p json=... -p name=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["water-type", "create_0"]
var params = {
    name: ...,
    json: ...,
    name: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["water-type", "create_0"]
params = {
    "name": ...,
    "json": ...,
    "name": ...,
}
result = client.action(schema, action, params=params)

weighings

list

GET /weighings

Lists or creates a new weighing.

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`
`user`
`subject`
`date_time`
`weight`
`django`
`nickname`
`users`
`date_range`
`lab`
`location`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action weighings list -p limit=... -p offset=... -p id=... -p name=... -p json=... -p user=... -p subject=... -p date_time=... -p weight=... -p django=... -p nickname=... -p users=... -p date_range=... -p lab=... -p location=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["weighings", "list"]
var params = {
    limit: ...,
    offset: ...,
    id: ...,
    name: ...,
    json: ...,
    user: ...,
    subject: ...,
    date_time: ...,
    weight: ...,
    django: ...,
    nickname: ...,
    users: ...,
    date_range: ...,
    lab: ...,
    location: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["weighings", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "id": ...,
    "name": ...,
    "json": ...,
    "user": ...,
    "subject": ...,
    "date_time": ...,
    "weight": ...,
    "django": ...,
    "nickname": ...,
    "users": ...,
    "date_range": ...,
    "lab": ...,
    "location": ...,
}
result = client.action(schema, action, params=params)

create

POST /weighings

Lists or creates a new weighing.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`subject` required
`date_time`
`weight` required	Weight in grams
`user`

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action weighings create -p subject=... -p date_time=... -p weight=... -p user=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["weighings", "create"]
var params = {
    subject: ...,
    date_time: ...,
    weight: ...,
    user: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["weighings", "create"]
params = {
    "subject": ...,
    "date_time": ...,
    "weight": ...,
    "user": ...,
}
result = client.action(schema, action, params=params)

read

GET /weighings/{id}

Allows viewing of full detail and deleting a weighing.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this weighing.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action weighings read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["weighings", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["weighings", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /weighings/{id}

Allows viewing of full detail and deleting a weighing.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A UUID string identifying this weighing.

# Load the schema document
$ coreapi get https://openalyx.internationalbrainlab.org/docs/

# Interact with the API endpoint
$ coreapi action weighings delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["weighings", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://openalyx.internationalbrainlab.org/docs/")

# Interact with the API endpoint
action = ["weighings", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)