CAcatmaid
skeletons

Import a neuron modeled by a skeleton from an uploaded file.

Changed on

Import a neuron modeled by a skeleton from an uploaded file.

Currently only SWC and eSWC representation is supported.

posthttp://localhost:8000/{project_id}/skeletons/import

Request

Path parameters

project_idstring required

Request body application/x-www-form-urlencoded

neuron_idstring

If specified a request for a particular neuron ID is expressed. If force = true, this request is enforced and the existing neuron ID (and all its skeletons) is replaced (as long as they are in the target project). If force = false (default), the neuron ID is only used if available and a new one is generated otherwise.

skeleton_idstring

If specified a request for a particular skeleton ID is expressed. If force = true, this request is enforced and the existing skeleton ID (and all its neurons) is replaced (as long as they are in the target project). If force = false (default), the skeleton ID is only used if available and a new one is generated otherwise.

forcestring

If neuron_id or skeleton_id are passed in, existing neuron/skeleton instances in this project are replaced. All their respectively linked skeletons and neurons will be removed.

auto_idstring

If a passed in neuron ID or skeleton ID is already in use, a new ID will be selected automatically (default). If auto_id is set to false, an error is raised in this situation.

namestring

If specified, the name of a new neuron will be set to this.

annotationsstring

An optional list of annotation names that is added to the imported skeleton.

replace_annotationsstring

If enabled and an existing neuron is replaced with a new skeleton, then all existing annotations of the target neuron are replaced with the annotations passed in or the default 'Import' annotations. If disabled, the existing annotations remaind and the passed in annotations or the default 'Import' annotation are appended (default). For newly created skelteons, this option has no relevance.

source_idstring

If specified, this source ID will be saved and mapped to the new skeleton ID.

source_project_idstring

If specified, this source project ID will be saved and mapped to the new skeleton ID. This is only valid together with source_id and source_url.

source_urlstring

If specified, this source URL will be saved and mapped to the new skeleton ID.

source_typestring

Can be either 'skeleton' or 'segmentation', to further specify of what type the origin data is.

Response

Created

Changes