Download OpenAPI specification:Download
Create a key-value store datastore for the client.
The request user must not be anonymous and must have browse, annotate or administer permissions for at least one project.
| name required | string String key for the datastore. This will be used in URLs so may only contain alphanumeric characters and hyphens. |
List key-value data in a datastore for the client.
Returns key-values belong to the request user or no user, optionally filtering for those pairs belong to a specific project or no project.
| name required | string String key for the datastore with which this key-value entry is associated. |
| project_id | string ID of a project to associate this data with, if any. |
Create or replace a key-value data entry for the client.
Each entry is associated with a datastore, an optional project, an optional user, and a key. Creating a request that duplicates this quadruple will replace rather than create the value in the key-value pair.
Entries associated with neither a project nor user are considered global; those associated with a project but no user are project- default; those associated with a user but no project are user-default; and those associated with both a project and a user are user-project specific. When listing key-value data, all four of these values, if existing, will be returned.
| name required | string String key for the datastore with which this key-value entry is associated. |
| project_id | string ID of a project to associate this data with, if any. |
| ignore_user | string Whether to associate this key-value entry with the instance rather than the request user. Only project administrators can do this for project-associated instance data, and only super users can do this for global data (instance data not associated with any project). |
| key required | string A key for this entry. |
| value required | string A value for this entry. Must be valid JSON. |
| format | string This function parameter is ignored |
Delete all key-value store datastores for the client.
The request user must not be anonymous and must have browse, annotate or administer permissions for at least one project.
| name required | string |
| project_id | string ID of a project to delete data from, if any. |
| ignore_user | string Whether to clear dataassociated with the instance or the request user. Only project administrators can do this for project-associated instance data, and only super users can do this for global data (instance data not associated with any project). |
Update the group membership of multiple users at once.
Users and groups as well as their memberships are global, therefore this action requires either superuser status or project tokens need to be in use. If the latter is the case, the requesting user is expected to have a) admin permission in the current project and is b) only allowed to change users and groups visible to them.
| project_id required | string |
List nodes that are located in a broken section.
Broken secrions of all stacks linked to the current project are tested if they contain any nodes. Stack orientatins are respected. Optionally, only particular skeletons can be checked.
| project_id required | string |
| skeleton_ids | string List of skeleton IDs to constrain tests on |
List annotations matching filtering criteria that are currently in use.
The result set is the intersection of annotations matching criteria (the criteria are conjunctive) unless stated otherwise.
| project_id required | string |
| annotations | string A list of (meta) annotations with which which resulting annotations should be annotated with. |
| annotates | string A list of entity IDs (like annotations and neurons) that should be annotated by the result set. |
| parallel_annotations | string A list of annotation that have to be used alongside the result set. |
| user_id | string Result annotations have to be used by this user. |
| neuron_id | string Result annotations will annotate this neuron. |
| skeleton_id | string Result annotations will annotate the neuron modeled by this skeleton. |
| ignored_annotations | string A list of annotation names that will be excluded from the result set. |
| if_modified_since | string Works only if |
List annotations matching filtering criteria that are currently in use.
The result set is the intersection of annotations matching criteria (the criteria are conjunctive) unless stated otherwise.
| project_id required | string |
| annotations | string A list of (meta) annotations with which which resulting annotations should be annotated with. |
| annotates | string A list of entity IDs (like annotations and neurons) that should be annotated by the result set. |
| parallel_annotations | string A list of annotation that have to be used alongside the result set. |
| user_id | string Result annotations have to be used by this user. |
| neuron_id | string Result annotations will annotate this neuron. |
| skeleton_id | string Result annotations will annotate the neuron modeled by this skeleton. |
| ignored_annotations | string A list of annotation names that will be excluded from the result set. |
| if_modified_since | string Works only if |
Add missing neuron name annotations.
To each passed in neuron, a list of neuron IDs and/or skelton IDs, the neuron name stored in the neuron's base name is added as annotation. Each neuron name annotation is meta-annotated with a "Name" annotation.
| project_id required | string |
| skeleton_ids | string A list of skeleton IDs to update |
| entity_ids | string A list of target entity IDs to update |
Get annotations and who used them for a set of skeletons.
This method focuses only on annotations linked to skeletons and is likely to be faster than the general query. Returns an object with two fields: "annotations", which is itself an object with annotation IDs as fields, giving access to the corresponding annotation names. And the field "skeletons" is also an object, mapping skeleton IDs to lists of annotation-annotator ID pairs. Also, as JSON separator a colon is used instead of a comma.
| project_id required | string |
| skeleton_ids | string A list of skeleton IDs which are annotated by the resulting annotations. |
Query annotations linked to a list of objects.
These objects can for instance be neurons, annotations or stack groups. From a database perspective, these objects are class instances.
Returned is an object with the fields "entities" and "annotations". The former is an object mapping an entity ID to a list of annotations. Each annotation is represented by an object containing its "id" and "uid", the user who annotated it. The latter maps annotation IDs to annotation names. For instance::
{ "entities": { "42": [{id: 1, uid: 12}, {id: 3, uid: 14}] }, "annotations": { 12: "example1", 14: "example2" } }
| project_id required | string |
| object_ids | string A list of object IDs for which annotations should be returned. |
Query entities based on various constraints
Entities are objects that can be referenced within CATMAID's semantic space, e.g. neurons, annotations or stack groups. This API allows to query them, mainly by annotations that have been used with them. Multiple annotation parameters can be used to combine different annotation sets with AND. Elements of one annotation parameter are combined with OR.
| project_id required | string |
| annotation_date_start | string The earliest YYYY-MM-DD date result elements have been annotated at. |
| annotation_date_end | string The latest YYYY-MM-DD date result elements have been annotated at. |
| name | string The name (or a part of it) of result elements. |
| name_exact | string Whether the name has to match exactly or can be a part of the result name. This is typically faster than using a regular expression. False by default. |
| name_case_sensitive | string Whether the name has to match the exact letter case provided. False by default. |
| annotated_by | string A result element was annotated by a user with this ID. |
| annotated_with | string A comma separated list of annotation IDs which all annotate the result elements. |
| not_annotated_with | string A comma separated list of annotation IDs which don't annotate the result elements. |
| sub_annotated_with | string A comma separated list of annotation IDs that are contained in either 'annotated_with' or 'not_annotated_with' that get expanded to also include their sub-annotations in the query (of which then at least one has to match inclusion or exclusion respectively). |
| with_annotations | string Indicate if annotations of result elements should be returned. |
| types | string Allowed result types. Multple types can be passed with multiple parameters. Defaults to 'neuron' and 'annotation'. |
| sort_by | string Indicates how results are sorted. |
| sort_dir | string Indicates sorting direction. |
| range_start | string The first result element index. |
| range_length | string The number of results |
| annotation_reference | string Whether annoation references are IDs or names, can be 'id' or 'name. |
| with_timestamps | string Whether to return also the annotation time for each entity. |
| import_only | string Whether and how only skeletons that contain imported fragments should be returned. If set to 'partial', only skeletons that have at least one imported node in them are returned. If set to 'full', only skeletons that are fully imported are returned. Not set by default. |
| ignore_nonexisting | string Whether non-existing query annotations should be ignored instead of raising an error. |
| with_name | string Whether to return the name of each entity. |
| with_type | string Whether to return the type of each entity. |
Get a list of connectors that are linked to a set of treenodes.
| project_id required | string The project to operate in. |
| treenode_ids required | string Treenode IDs that result nodes are connected to. |
Get a collection of connectors.
The connectors field of the returned object contains a list of all result
nodes, each represented as a list of the form:
[id, x, y, z, confidence, creator_id, editor_id, creation_time, edition_time]
Both edition time and creation time are returned as UTC epoch values. If
tags are requested, the tags field of the response object will contain a
mapping of connector IDs versus tag lists. If partners are requested, the
partners field of the response object will contain a mapping of connector
IDs versus lists of partner links. Each partner link is an array of the
following format:
[link_id, treenode_id, skeleton_id, relation_id, confidence]
If both skeleton_ids and relation_type are used, the linked skeletons
need to be linked by the specified relation. Without relation_type,
linked skeletons can have any relation and without skeleton_ids a
connector needs to have a least one link with the specified relation.
| project_id required | string Project of connectors |
| skeleton_ids | string Skeletons linked to connectors |
| tags | string Require a set of tags |
| relation_type | string Relation of linked skeletons to connector. |
| without_relation_types | string Relations to linked skeletons that connectors must not have. |
| with_tags | string If connector tags should be fetched |
| with_partners | string If partner node and link information should be fetched |
Get a list of all connector nodes that intersect with the passed in bounding box.
| project_id required | string |
| limit | string Limit the number of returned nodes. |
| minx required | string Minimum world space X coordinate |
| miny required | string Minimum world space Y coordinate |
| minz required | string Minimum world space Z coordinate |
| maxx required | string Maximum world space X coordinate |
| maxy required | string Maximum world space Y coordinate |
| maxz required | string Maximum world space Z coordinate |
| with_locations | string Whether to return the location of each connector. |
| with_links | string Whether to return every individual link or null for unlinked connectors (if part of response). |
| only_linked | string Whether to return only connectors with linked treenodes. By default all connectors are returned and link information is null for unlinked nodes. |
| skeleton_ids | string Skeletons linked to connectors |
Get a list of all connector nodes that intersect with the passed in bounding box.
| project_id required | string |
| limit | string Limit the number of returned nodes. |
| minx required | string Minimum world space X coordinate |
| miny required | string Minimum world space Y coordinate |
| minz required | string Minimum world space Z coordinate |
| maxx required | string Maximum world space X coordinate |
| maxy required | string Maximum world space Y coordinate |
| maxz required | string Maximum world space Z coordinate |
| with_locations | string Whether to return the location of each connector. |
| with_links | string Whether to return every individual link or null for unlinked connectors (if part of response). |
| only_linked | string Whether to return only connectors with linked treenodes. By default all connectors are returned and link information is null for unlinked nodes. |
| skeleton_ids | string Skeletons linked to connectors |
Get connectors linked to a set of skeletons.
The result data set includes information about linked connectors on a given input set of skeletons. These links are further constrained by relation type, with currently support available for: postsynaptic_to, presynaptic_to, abutting, gapjunction_with, tightjunction_with, desmosome_with.
Returned is an object containing an array of links to connectors and a set of tags for all connectors found (if not disabled). The link array contains one array per connector link with the following content: [Linked skeleton ID, Connector ID, Connector X, Connector Y, Connector Z, Link confidence, Link creator ID, Linked treenode ID, Link edit time].
A POST handler is able to accept large lists of skeleton IDs.
| project_id required | string |
| skeleton_ids required | string Skeletons to list connectors for |
| relation_type required | string Relation of listed connector links |
| with_tags | string If connector tags should be fetched |
Get connectors linked to a set of skeletons.
The result data set includes information about linked connectors on a given input set of skeletons. These links are further constrained by relation type, with currently support available for: postsynaptic_to, presynaptic_to, abutting, gapjunction_with, tightjunction_with, desmosome_with.
Returned is an object containing an array of links to connectors and a set of tags for all connectors found (if not disabled). The link array contains one array per connector link with the following content: [Linked skeleton ID, Connector ID, Connector X, Connector Y, Connector Z, Link confidence, Link creator ID, Linked treenode ID, Link edit time].
A POST handler is able to accept large lists of skeleton IDs.
| project_id required | string |
| skeleton_ids required | string Skeletons to list connectors for |
| relation_type required | string Relation of listed connector links |
| with_tags | string If connector tags should be fetched |
Return information on a treenode connector edge.
Returns a JSON array with elements representing information on the matched links. They have the following form:
{ "user": ..., "creaetion_time": ..., "edition_time": ... }
Developer node: This function is called often (every connector mouseover) and should therefore be as fast as possible. Analogous to user_info for treenodes and connectors.
| project_id required | string Project of connectors |
| treenode_id required | string The treenode, the connector is linked to |
| connector_id required | string The connector, the treenode is linked to |
| relation_id | string The relation ID of the link, can be used instead of relation_name |
| relation_name | string The relation name of the link, can be used instead of relation_id |
Attempt to create a new project based on the passed in project ID.
| project_id required | string |
| name required | string Name of new project |
| description | string Description of new project |
| copy_volumes | string Whether volumes will be copied to the new project |
| project_token | string Whether or not a new project token should be generated |
| add_to_favorites | string Whether or not the new project is marked as a favorite |
Given a set of one or more skeleton IDs, find all skeletons that connect them (n_circles=1), or that connect to others that connect them (n_circles=2), etc. Returns a list of unique skeleton IDs that exclude the ones provided as argument.
| project_id required | string |
| skeleton_ids[] required | string IDs of the skeletons to start expanding from. |
| n_circles | string (Optional) The numbers of recursive expansions. |
| allowed_connector_ids[] | string (Optional) IDs of connector nodes that are allowed to be used for expansion. |
List all labels (front-end node tags) attached to a particular node.
| project_id required | string Project containing node of interest |
| node_type required | string Either 'connector', 'treenode' or 'location' |
| node_id required | string ID of node to list labels for |
List available landmarks, optionally only the ones in a set of landmark groups.
| project_id required | string Project of landmark |
| with_locations | string Whether to return linked locations |
Delete a list of landmarks including the linked locations, if they are not used by other landmarks.
| project_id required | string The project the landmark is part of. |
| landmark_ids required | string The landmarks to remove. |
| keep_points | string Don't delete points. |
List available landmark groups.
| project_id required | string Project of landmark groups |
| with_members | string Whether to return group members |
| with_locations | string Whether to return linked locations |
| with_names | string Whether to return location with their landmark names |
| with_links | string Whether to return links to other groups |
| with_relations | string Whether to return a map of used relation IDs to their names |
Add a new landmarkgroup. Expect at least the name as parameter.
| project_id required | string Project of landmark group |
| name required | string Name of new landmark group |
Import and link landmarks, landmark groups and locations.
The passed in parameter is a list of two-element lists, each representing a group along with its linked landmark and locations. The group is represented by its name and the members are a list of four-element lists, containing the landmark name and the location. This results in the following format:
[[group_1_name, [[landmark_1_name, x, y, z], [landmark_2_name, x, y, z]]], ...]
Note that this parameter has to be transmitted as a JSON encoded string.
| project_id required | string The project the landmark group is part of. |
| data required | string The data to import. |
| reuse_existing_groups | string Whether existing groups should be reused. |
| reuse_existing_landmarks | string Whether existing landmarks should be reused. |
| create_non_existing_groups | string Whether non-existing groups should be created. |
| create_non_existing_landmarks | string Whether non-existing landmarks should be created. |
Link a location group to another landmark group. If the passed in groups already are in relation to each other using the passed in relation, no new link is created. Instead, the existing link will be returned. A flag in the result indicates whether the returned object is new.
| project_id required | string Project of landmark group |
| group_1_id required | string The first landmark group, has role of subject. |
| relation_id required | string The relation between group 1 and 2, has role of predicate. |
| group_2_id required | string The first landmark group, has role of object. |
Create all passed in landmarks along with a set of groups in one go.
The format for the passed in landmarks is expected to be [name, x1, y1, z1, x2, y2, z2], representing a shared landmark at locations (x1, y1, z1) for group A and (x2, y2, z2) for group B.
The format for the optionally passed in links is: [group_name_1, relation_name, group_name_2] elements, representing a relation between two groups. Whether group A and B map to 1 and 2 or vice versa depends on the semantics of the relation.
| project_id required | string The project to operate in. |
| group_a_name required | string The name of landmark group A. |
| group_b_name required | string The name of landmark group B. |
| landmarks required | string A list of landmark definitions for group B. |
| links | string A list of link definitions between group A and B. |
| reuse_existing_landmarks | string If existing landmarks can be reused, no error will be thrown if a landmark with the same name exists alrady. |
Get details on one particular landmarkgroup group, including its members.
| project_id required | string The project the landmark group is part of. |
| landmarkgroup_id required | string The ID of the landmark group. |
| with_members | string Whether to return group members |
| with_locations | string Whether to return linked locations |
| with_names | string Whether to return linked landmark names |
Update an existing landmark group.
Currently, only the name and group members can be updated. Edit permissions are only needed when removing group members.
| project_id required | string The project the landmark group is part of. |
| landmarkgroup_id required | string |
| landmark_id required | string The ID of the landmark group. |
| name | string The new name of the landmark group. |
| members | string The new members of the landmark group. |
| append_members | string Whether the existing members should be extended by the passed in members. No members will be removed. |
Remove the link between a location and a landmark group.
| project_id required | string Project of landmark group |
| landmarkgroup_id required | string The landmark group to link |
| location_id required | string Existing location ID |
Get a list of landmark groups that are transitively linked to the input group with the passed in relation.
| project_id required | string Project of landmark groups |
| landmarkgroup_id required | string The starting landmark group |
| relation_id required | string The relation a valid group link has to have |
| max_depth | string (optional) Maximum number of hops from the source group. 0 to disable. |
Get details on one particular landmark.
If locations are returned alongside the landmarks, they are all points that are linked to a particular landmark, regardless of which group the location is linked to.
| project_id required | string The project the landmark is part of. |
| landmark_id required | string The ID of the landmark. |
| with_locations | string Whether to return linked locations |
Update an existing landmark.
Currently, only the name and group membership can be updated.
| project_id required | string The project the landmark is part of. |
| landmark_id required | string The ID of the landmark. |
| group_ids required | string The groups this landmark is a member of. |
| name | string The name of the landmark. |
| append_memberships | string Whether the existing memberships should be extended by the passed in memberships. No memberships will be removed. |
Delete the link between a location and a landmark and a group and a location, if and only if both exist. If the last link to a location is deleted, the location is removed as well.
| project_id required | string Project of landmark group |
| landmark_id required | string The landmark to unlink from |
| group_id required | string The group to unlink from |
| keep_points required | string Wheter only links should be deleted and points should be kept. |
Add a new location or use an existing one and link it to a landmark.
Either (x,y,z) or location_id have to be provided.
| project_id required | string Project of landmark group |
| landmark_id required | string The landmark to link |
| location_id | string Optional existing location ID |
| x | string Optional new location X coodinate |
| y | string Optional new location Y coodinate |
| z | string Optional new location Z coodinate |
Delete the link between a location and a landmark. If the last link to a location is deleted, the location is removed as well.
| project_id required | string Project of landmark group |
| landmark_id required | string The landmark to unlink |
| location_id required | string The location to unlink |
Get a deep-links available to the client.
No specific permissions are needed here, because this just rewrites a URL and the client can handle the potential permission error in a more user-friendly manner.
| project_id required | string |
| alias required | string |
List neurons matching filtering criteria.
The result set is the intersection of neurons matching criteria (the criteria are conjunctive) unless stated otherwise.
| project_id required | string |
| created_by | string Filter for user ID of the neurons' creator. |
| reviewed_by | string Filter for user ID of the neurons' reviewer. |
| from_date | string Filter for neurons with nodes created after this date. |
| to_date | string Filter for neurons with nodes created before this date. |
| nodecount_gt | string Filter for neurons with more nodes than this threshold. Removes all other criteria. |
Retrieve neuron IDs modeled by particular entities, eg skeletons.
From a list of source entities (class instances), the IDs of all modeled neurons are returned. There are currently only skeletons that model neurons.
| project_id required | string |
| model_ids[] required | string IDs of models to find neurons for (e.g. skeleton IDs) |
Rename a neuron.
If a neuron is not locked by a user on which the current user has no permission, the name of neuron can be changed through this endpoint. Neuron names are currently not allowed to contain pipe characters ("|").
| project_id required | string |
| neuron_names required | string A list of two-element tuples, containing of neuron ID and new name each. |
Rename a neuron.
If a neuron is not locked by a user on which the current user has no permission, the name of neuron can be changed through this endpoint. Neuron names are currently not allowed to contain pipe characters ("|").
| project_id required | string |
| neuron_id required | string ID of neuron to rename |
| name required | string New name of the neuron |
Retrieve all nodes intersecting a bounding box
The intersection bounding box is defined in terms of its minimum and maximum project space coordinates. The number of returned nodes can be limited to constrain query execution time. Optionally, lists of treenodes and connector IDs can be provided to make sure they are included in the result set, regardless of intersection.
Returned is an array with five entries, plus optionally a sixth one
[[treenodes], [connectors], {labels}, node_limit_reached, {relation_map}, {exstraNodes}]
The list of treenodes has elements of this form:
[id, parent_id, location_x, location_y, location_z, confidence, radius, skeleton_id, edition_time, user_id]
The list connectors has elements of this form:
[id, location_x, location_y, location_z, confidence, edition_time, user_id, [partners]]
The partners arrary represents linked partner nodes, each one represented like this:
[treenode_id, relation_id, link_confidence, link_edition_time, link_id]
If labels are returned, they are represented as an object of the following form, with the labels just being simple strings:
{treenode_id: [labels]}
The fourth top level entry, node_limit_reached, is a boolean that represents if there are more nodes available than the ones returned.
With the last top level element returned the present connector linked relations are mapped to their textural representations:
{relation_id: relation_name}
| project_id required | string |
| treenode_ids | string Whether linked connectors should be returned. |
| connector_ids | string Whether tags should be returned. |
| limit | string Limit the number of returned nodes. |
| left required | string Minimum world space X coordinate |
| top required | string Minimum world space Y coordinate |
| z1 required | string Minimum world space Z coordinate |
| right required | string Maximum world space X coordinate |
| bottom required | string Maximum world space Y coordinate |
| z2 required | string Maximum world space Z coordinate |
| format | string Either "json" (default) or "msgpack", optional. |
| with_relation_map | string Whether an ID to name mapping for the used relations should be included and which extent it should have. |
| with_origin | string Whether the origin for each skeleton should be looked up and returned. This will show which skeletons are imported. |
| n_largest_skeletons_limit | string Maximum number of the largest skeletons in view |
| n_last_edited_skeletons_limit | string Maximum number of most recently edited skeletons. |
| hidden_last_editor_id | string No nodes edited last by this user will be retuned. |
| min_skeleton_length | string Optional minimum skeleton length, no returned node is of a shorter skeleton. |
| order | string Either empty, cable-asc or cable-desc. Will return in a particular order. By default, no ordering is applied. |
List nodes with labels matching a query, ordered by distance.
Find nodes with labels (front-end node tags) matching a regular expression, sort them by ascending distance from a reference location, and return the result. Returns at most 50 nodes.
| project_id required | string |
| x required | string X coordinate of the distance reference in project space. |
| y required | string Y coordinate of the distance reference in project space. |
| z required | string Z coordinate of the distance reference in project space. |
| label_regex required | string Regular expression query to match labels |
Get locations for a particular set of nodes in a project.
A list of lists is returned. Each inner list represents one location and hast the following format: [id, x, y, z].
| project_id required | string |
| node_ids required | string A list of node IDs to get the location for |
Retrieve the last edited node.
Without any further parameters, this will retrieve the node last edited on any skeleton by any user. This can be further constrained by skeleton and user.
| project_id required | string The project to operate in. |
| skeleton_id | string (optional) Skeleton for which to retrieve last edited node. |
| user_id | string (optional) User of which to retrieve last edited node. |
Find the closest node in a skeleton relative to a passed in location.
If a skeleton ID or neuron id is passed in as well, the nearest node in the respective skeleton is returned.
| project_id required | string The project to operate in. |
| x required | string X coordinate of query location. |
| y required | string X coordinate of query location. |
| z required | string Z coordinate of query location. |
| skeleton_id | string Result treenode has to be in this skeleton. |
| neuron_id | string Alternative to skeleton_id. Result treenode has to be in this neuron |
List all available point clouds or optionally a sub set.
| project_id required | string Project of the returned point clouds |
| pointcloud_ids required | string A list of point cloud IDs to which the query is constrained. |
| order_by required | string The field to order the response list by (name, id). |
| simple | string Wheter or not only ID and name should be returned |
| with_images | string Wheter linked images should returned as well. |
| with_points | string Wheter linked points should returned as well. |
| sample_ratio | string Number in [0,1] to optionally sample point cloud |
List all available point clouds or optionally a sub set.
| project_id required | string Project of the returned point clouds |
| pointcloud_ids required | string A list of point cloud IDs to which the query is constrained. |
| order_by required | string The field to order the response list by (name, id). |
| simple | string Wheter or not only ID and name should be returned |
| with_images | string Wheter linked images should returned as well. |
| with_points | string Wheter linked points should returned as well. |
| sample_ratio | string Number in [0,1] to optionally sample point cloud |
Create a new pointcloud by providing.
| project_id required | string Project of the new point cloud |
| name required | string Name of the new point cloud |
| description | string Description of the new point cloud |
| points required | string Points of point cloud in project space. Can be a stringified JSON array. |
| group_id | string A group for which this point cloud will be visible exclusivly. |
Return a point cloud. parameters:
| project_id required | string |
| pointcloud_id required | string |
Return a point cloud. parameters:
| project_id required | string |
| pointcloud_id required | string |
| image_id required | string |
Add a new point. Expect at least the location as parameters.
| project_id required | string Project of points |
| location_x required | string X coordinate |
| location_y required | string Y coordinate |
| location_z required | string Z coordinate |
| radius | string Optional radius |
| confidence | string Optional confidence in [0,5] |
Update one particular point.
Requires at least one field to change.
| project_id required | string Project point is part of |
| point_id required | string ID of point |
| location_x | string X coordinate |
| location_y | string Y coordinate |
| location_z | string Z coordinate |
| radius | string Optional radius |
| confidence | string Optional confidence in [0,5] |
List all available point sets or optionally a sub set.
| project_id required | string Project of the returned point sets |
| pointset_ids required | string A list of point set IDs to which the query is constrained. |
| order_by required | string The field to order the response list by (name, id). |
| simple | string Wheter or not only ID and name should be returned |
| with_points | string Wheter linked points should returned as well. |
List all available point sets or optionally a sub set.
| project_id required | string Project of the returned point sets |
| pointset_ids required | string A list of point set IDs to which the query is constrained. |
| order_by required | string The field to order the response list by (name, id). |
| simple | string Wheter or not only ID and name should be returned |
| with_points | string Wheter linked points should returned as well. |
Return a point set. parameters:
| project_id required | string |
| pointset_id required | string |
Get a collection of available samplers.
Optionally, the "skeleton_ids" parameter can provide a list of skeleton IDs. If this is the case, only samplers for the respective skeletons are returned.
| project_id required | string |
| skeleton_ids | string Optional skeleton IDs to constrain result set to. |
| with_domains | string Optional flag to include all domains of all result sampler results. |
| with_intervals | string Optional flag to include all intervals of all domains. Implies with_domains. |
Create a new sampler for a skeleton.
| project_id required | string |
| skeleton_id required | string Skeleton this sampelr is for |
| interval_length required | string Length of a intervals with domains (nm). |
| interval_error | string Maximum allowed error for a single interval. |
| review_required required | string Whether reviews should be enforced in this sampler |
| create_interval_boundaries required | string Whether new nodes for interval boundaries should be created. |
| leaf_segment_handling | string How leaf segments should be handled, can be 'ignore', 'merge' or 'short-interval'. |
| merge_limit | string A leaf handling option for merge-or-create mode. A value between 0 and 1 representing the interval length ratio up to which a merge is allowed. |
Get a list of connectors that already have a state associated with them.
If a connector is not part of this list it is implicetely assumed to be in an "untouched" state.
| project_id required | string |
| interval_id | string The interval all results should be part of |
| connector_id | string The connector to get sampler information for |
| state_id | string The state all result sets have to have. |
Set state of sampler connector
| project_id required | string |
| interval_id required | string Interval the connector is part of |
| connector_id required | string Connector to set state of |
| state_id required | string The new state |
Create all intervals in a particular domain.
| project_id required | string |
| domain_id required | string Domain to add intervals in |
| intervals required | string A list of two-element lists, with start and end node each |
| added_nodes | string A JSON encoded list of lists, each inner list of format: [id, child, parent, x,y,z], representing an interval node filter. Matching nodes will be created if collinear. |
Get details on a particular sampler.
| project_id required | string The project to operate in. |
| sampler_id required | string The sampler to return. |
| with_domains | string Optional flag to include all domains of all result sampler results. |
| with_intervals | string Optional flag to include all intervals of all domains. Implies with_domains. |
Set fields of a particular sampler.
| project_id required | string The project to operate in. |
| sampler_id required | string The sampler to return. |
| leaf_handling_mode | string Optional flag to include all domains of all result sampler results. |
Delete a sampler if permissions allow it.
If the sampler was created with allowing the creation of new boundary nodes,
these nodes are removed by default if they have not been modified since
their insertion. This can optionally be disabled using the
| project_id required | string |
| sampler_id required | string |
| delete_created_nodes | string Optional flag to disable automatic removal of untouched nodes created for this sampler's intervals. |
Create a new domain for a sampler.
| project_id required | string |
| sampler_id required | string Sampeler the new domain is part of |
| domain_type_id required | string The type of the new domain |
| start_node_id required | string Start node of domain |
| end_node_ids required | string A list of all end nodes for the new domain |
| parent_interval_id | string Optional parent inerval ID. |
Create a new similarity/NBLAST configuration either by providing parameters to have the back-end queue a job or by providing the complete matrix data.
| project_id required | string Project of the NBLAST configuration |
| name required | string Name of the new NBLAST configuration |
| source | string Where random skeletons come from. Either "data", "request" or "backend-random". |
| distance_breaks | string Bin boundaries for the distance in nm. Defaults to [0, 500] in an increasing logarithmic bin sizw |
| dot_breaks | string Bin boundaries for the absolute dot product. Defaults to [0, 1] in 0.1 steps. |
| tangent_neighbors | string The number of neighbor nodes that should be considered when computing a tangent vector. |
| matching_skeleton_ids | string A list of matching skeleton IDs if |
| matching_pointset_ids | string A list of matching pointset IDs if |
| matching_pointcloud_ids | string A list of matching pointcloud IDs if |
| random_skeleton_ids | string A list of random skeleton IDs if |
| matching_sample_id | string An NblastSample foreign key of the matching sample. |
| random_sample_id | string An NblastSample foreign key tp a random sample. |
| scoring | string If passed in a new similarity matrix will be created based on this explict scoring. It is assumed to be a simple list which is organized in rows following each other sequentially. Requires distance binning and dot binning information. |
List all available NBLAST similarity tasks.
| project_id required | string Project of the returned similarities |
| config_id | string Return only similarities linked to this config |
| with_scoring | string Whether or not to include scoring information in response. |
| with_objects | string Whether or not to include query and target object IDs. |
Compare two sets of objects (skeletons or point clouds) and return an NBLAST scoring based on an existing NBLAST configuration.
| project_id required | string Project to operate in |
| config_id required | string ID of the new NBLAST configuration to use |
| query_ids required | string Set of objects (skeletons or point clouds) to query similarity for. |
| target_ids required | string Set of objects (skeletons or point clouds) or point clouds to compare against. |
| target_type | string Type of target objects, 'skeleton' or 'pointcloud'. |
| name | string Name for the similarity lookup task |
| normalized | string Whether and how scores should be normalized. |
| use_alpha | string Whether to consider local directions in the similarity computation |
| reverse | string If enabled, the target is matched against the query. |
| query_type_id | string Type of query data |
| target_type_id | string Type of query data |
| query_meta | string Extra data for the selected query type. A JSON encoded string is expected. |
| target_meta | string Extra data for the selected target type. A JSON encoded string is expected. |
| remove_target_duplicates | string Remove all target objects that appear also in the query. |
| simplify | string Whether or not to simplify neurons and remove parts below a specified branch point level. |
| required_branches | string The required branch levels if neurons should be simplified. |
| use_cache | string Whether or not to use cached data when computing similarity scores. |
| top_n | string How many results should be returned sorted by score. A value of zero dsiables this cutoff. |
Get a particular similarity query result.
| project_id required | string Project of the returned similarities |
| similarity_id | string The similarity to load. |
| with_scoring | string Whether or not to include scoring information in response. |
| with_objects | string Whether or not to include query and target object IDs. |
Return a sparse connectivity matrix representation for the given skeleton IDs. The returned dictionary has a key for each row skeleton having outgoing connections to one or more column skeletons. Each entry stores a dictionary that maps the connection partners to the individual outgoing synapse counts.
| project_id required | string Project of skeletons |
| rows required | string IDs of row skeletons |
| columns required | string IDs of column skeletons |
| with_locations | string Whether or not to return locations of connectors |
| row_relation | string The relation from a row skeleton to a connector |
| col_relation | string The relation from a column skeleton to a connector |
Export an extended SWC file. It includes a creation user name, creation timestamp, editor user name and edition time stamp as well as a condidence value in range [0,5].
| project_id required | string |
| skeleton_id required | string |
List skeletons matching filtering criteria.
The result set is the intersection of skeletons matching criteria (the criteria are conjunctive) unless stated otherwise.
| project_id required | string |
| created_by | string Filter for user ID of the skeletons' creator. |
| reviewed_by | string Filter for user ID of the skeletons' reviewer. |
| from_date | string Filter for skeletons with nodes created after this date. |
| to_date | string Filter for skeletons with nodes created before this date. |
| nodecount_gt | string Filter for skeletons with more nodes than this threshold. Removes all other criteria. |
Get the cable length of a set of skeletons.
Returns a mapping from skeleton ID to cable length.
| project_id required | string Project to operate in |
| skeleton_ids[] required | string IDs of the skeletons to query cable-length for |
Get the cable length of a set of skeletons.
Returns a mapping from skeleton ID to cable length.
| project_id required | string Project to operate in |
| skeleton_ids[] required | string IDs of the skeletons to query cable-length for |
Return the history of all skeletons ID changes in a project over time. Optionally, this can be constrained by a user ID and a time window.
| project_id required | string Project to operate in |
| initial_user_id | string User who caused the first change in all returned skeleton. |
| changes_after | string Date of format YYYY-MM-DDTHH:mm:ss, only the date part is required. Limits returns history to skeleton changes after this date. |
| changes_before | string Date of format YYYY-MM-DDTHH:mm:ss, only the date part is required. Limits returns history to skeleton changes before this date. |
| skeleton_ids | string Skeleton IDs of the initial set of treenodes. |
Get a compact treenode representation of a list of skeletons, optionally with the history of individual nodes and connectors.
Returns, in JSON, [[nodes], [connectors], {nodeID: [tags]}], with connectors and tags being empty when 0 == with_connectors and 0 == with_tags, respectively.
Each element in the [nodes] array has the following form:
[skeleton_id, id, parent_id, user_id, location_x, location_y, location_z, radius, confidence].
Each element in the [connectors] array has the following form, with the third element representing the connector link as 0 = presynaptic, 1 = postsynaptic, 2 = gap junction, -1 = other:
[treenode_id, connector_id, 0|1|2|-1, location_x, location_y, location_z]
If history data is requested, each row contains a validity interval. Note that for the live table entry (the currently valid version), there are special semantics for this interval: The upper bound is older than or the same as the lower bound. This is done to encode the information of this row being the most recent version and including the original creation time at the same time, plus it requires less queries on the back-end to retireve data. This requires the client to do slightly more work, but unfortunately the original creation time is needed for data that was created without history tables enabled.
| project_id required | string |
string | |
| with_connectors | string Whether linked connectors should be returned. |
| with_tags | string Whether tags should be returned. |
| with_history | string Whether history information should be returned for each treenode and connector. |
| with_merge_history | string Whether the history of arbors merged into the requested skeleton should be returned. Only used if history is returned. |
| with_reviews | string Whether a node index should be returned that maps node IDs to the list of reviews done on them, respects history parameter. |
| with_annotations | string Whether the list of linked annotations should be returned. If history should be returned, returns all link versions. |
| with_user_info | string Whether all result elements should contain also the creator ID. |
Get a synaptic graph between skeletons compartmentalized by confidence.
Given a set of skeletons, retrieve presynaptic-to-postsynaptic edges between them, annotated with count. If a confidence threshold is supplied, compartmentalize the skeletons at edges in the arbor below that threshold and report connectivity based on these compartments.
When skeletons are split into compartments, nodes in the graph take an
string ID like {skeleton_id}_{compartment #}.
| project_id required | string |
| skeleton_ids[] required | string IDs of the skeletons to graph |
| confidence_threshold | string Confidence value below which to segregate compartments |
| bandwidth | string Bandwidth in nanometers |
| cable_spread | string Cable spread in nanometers |
| expand[] | string IDs of the skeletons to expand |
| link_types[] | string IDs of link types to respect |
| allowed_connector_ids[] | string (Optional) IDs of allowed conectors. All other connectors will be ignored. |
Retrieve a list of down/up-stream partners of a set of skeletons.
From a queried set of source skeletons, find all upstream and downstream partners, the number of synapses between each source and each partner, and a list of reviewers for each partner set. Confidence distributions for each synapse count are included. Optionally find only those partners that are common between the source skeleton set.
| project_id required | string |
| source_skeleton_ids required | string IDs of the skeletons whose partners to find |
| boolean_op required | string Whether to find partners of any source skeleton ("OR") or partners common to all source skeletons ("AND") |
| with_nodes | string Whether to return detailed connectivity information that includes partner sites. |
| link_types | string A list of allowed link types: incoming, outgoing, abutting, gapjunction, tightjunction, desmosome, attachment, close_object. |
Get the number of synapses per type for r a set of skeletons.
Returns an object with to fields. The first, connectivity, is a mapping
from skeleton ID to objects that map a relation ID to connectivity count for
that particular relation. The second field of the returned object,
relations, maps relation IDs used in the first field to relation names.
| project_id required | string Project of work in |
| count_partner_links required | string Whether to count partner links or links to a connector. |
| source_relations[] | string A list of pre-connector relations that have to be used |
| target_relations[] | string A list of post-connector relations that have to be used |
| skeleton_ids[] required | string IDs of the skeletons whose partners to count |
Get the number of synapses per type for r a set of skeletons.
Returns an object with to fields. The first, connectivity, is a mapping
from skeleton ID to objects that map a relation ID to connectivity count for
that particular relation. The second field of the returned object,
relations, maps relation IDs used in the first field to relation names.
| project_id required | string Project of work in |
| count_partner_links required | string Whether to count partner links or links to a connector. |
| source_relations[] | string A list of pre-connector relations that have to be used |
| target_relations[] | string A list of post-connector relations that have to be used |
| skeleton_ids[] required | string IDs of the skeletons whose partners to count |
Return a CSV file that represents the connectivity matrix of a set of row skeletons and a set of column skeletons.
| project_id required | string Project of skeletons |
| rows required | string IDs of row skeletons |
| columns required | string IDs of column skeletons |
| names | string An optional mapping of skeleton IDs versus names.
Represented as a list of two-element lists. Each inner list
follows the form [ |
| row_relation | string The relation from a row skeleton to a connector |
| col_relation | string The relation from a column skeleton to a connector |
Find mappings to existing skeletons for potential imports.
| project_id required | string Project to operate in |
| source_url required | string Source URL of skeletons |
| source_project_id required | string Source project ID of skeletons |
| source_ids[] required | string IDs of the source IDs to query origin for |
Find mappings to existing skeletons for potential imports.
| project_id required | string Project to operate in |
| source_url required | string Source URL of skeletons |
| source_project_id required | string Source project ID of skeletons |
| source_ids[] required | string IDs of the source IDs to query origin for |
Import a neuron modeled by a skeleton from an uploaded file.
Currently only SWC and eSWC representation is supported.
| project_id required | string |
| neuron_id | string 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_id | string 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. |
| force | string 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_id | string 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. |
| name | string If specified, the name of a new neuron will be set to this. |
| annotations | string An optional list of annotation names that is added to the imported skeleton. |
| replace_annotations | string 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_id | string If specified, this source ID will be saved and mapped to the new skeleton ID. |
| source_project_id | string 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_url | string If specified, this source URL will be saved and mapped to the new skeleton ID. |
| source_type | string Can be either 'skeleton' or 'segmentation', to further specify of what type the origin data is. |
Get information on imported nodes of a set of skeletons.
| project_id required | string Project to operate in |
| skeleton_ids[] required | string IDs of skeletons to get import information for. |
| with_treenodes | string Whether to include IDs of all imported nodes in response. |
Get information on imported nodes of a set of skeletons.
| project_id required | string Project to operate in |
| skeleton_ids[] required | string IDs of skeletons to get import information for. |
| with_treenodes | string Whether to include IDs of all imported nodes in response. |
Get a list of all skeletons that intersect with the query bounding box. Optionally, only a subset of passed in skeletons can be tested against.
| project_id required | string |
| limit | string Limit the number of returned nodes. |
| minx required | string Minimum world space X coordinate |
| miny required | string Minimum world space Y coordinate |
| minz required | string Minimum world space Z coordinate |
| maxx required | string Maximum world space X coordinate |
| maxy required | string Maximum world space Y coordinate |
| maxz required | string Maximum world space Z coordinate |
| min_nodes | string A minimum number of nodes per result skeleton |
| min_cable | string A minimum number of cable length per result skeleton |
| volume_id | string Alternative to manual bounding box definition. The bounding box of the volume is used. |
| skeleton_ids | string An optional list of skeleton IDs that should only be tested againt. If used, the result will only contain skeletons of this set. |
Get a list of all skeletons that intersect with the query bounding box. Optionally, only a subset of passed in skeletons can be tested against.
| project_id required | string |
| limit | string Limit the number of returned nodes. |
| minx required | string Minimum world space X coordinate |
| miny required | string Minimum world space Y coordinate |
| minz required | string Minimum world space Z coordinate |
| maxx required | string Maximum world space X coordinate |
| maxy required | string Maximum world space Y coordinate |
| maxz required | string Maximum world space Z coordinate |
| min_nodes | string A minimum number of nodes per result skeleton |
| min_cable | string A minimum number of cable length per result skeleton |
| volume_id | string Alternative to manual bounding box definition. The bounding box of the volume is used. |
| skeleton_ids | string An optional list of skeleton IDs that should only be tested againt. If used, the result will only contain skeletons of this set. |
Return relationship between label IDs and skeleton IDs
| project_id required | string |
| label_ids[] required | string IDs of the labels to find skeletons associated with |
| label_names[] required | string Alternative to |
Return relationship between label IDs and skeleton IDs
| project_id required | string |
| label_ids[] required | string IDs of the labels to find skeletons associated with |
| label_names[] required | string Alternative to |
Retrieve the review status for a collection of skeletons.
The review status for each skeleton in the request is a tuple of total nodes and number of reviewed nodes (integers). The reviews of only certain users or a reviewer team may be counted instead of all reviews.
| project_id required | string |
| skeleton_ids[] required | string IDs of the skeletons to retrieve. |
| whitelist | string ID of the user whose reviewer team to use to filter reviews (exclusive to user_ids) |
| user_ids[] | string IDs of the users whose reviews should be counted (exclusive to whitelist) |
Get the number of samplers associated with each skeleton in the passed in last.
| project_id required | string Project of skeleton |
| skeleton_ids required | string IDs of the skeleton to get the sampler count for. |
Get the original creation time, last edit time, number of nodes, number of imported nodes, cable length and last editor information for a list skeleton IDs.
Returns a mapping from skeleton ID to summary info
| project_id required | string Project to operate in |
| skeleton_ids[] required | string IDs of the skeletons to query summary for. |
Get the original creation time, last edit time, number of nodes, number of imported nodes, cable length and last editor information for a list skeleton IDs.
Returns a mapping from skeleton ID to summary info
| project_id required | string Project to operate in |
| skeleton_ids[] required | string IDs of the skeletons to query summary for. |
Find out if passed skeleton IDs are valid (and represent present skeletons).
Returns all passed in skeletons that are valid.
| project_id required | string Project of landmark |
| skeleton_ids[] required | string IDs of the skeletons whose partners to find |
| return_invalid | string Whether or not to return invalid skeleton IDs rather than valid ones. |
Find out if passed skeleton IDs are valid (and represent present skeletons).
Returns all passed in skeletons that are valid.
| project_id required | string Project of landmark |
| skeleton_ids[] required | string IDs of the skeletons whose partners to find |
| return_invalid | string Whether or not to return invalid skeleton IDs rather than valid ones. |
Find skeletons within a given L-infinity distance of a treenode.
Returns at most 100 results.
| project_id required | string |
| treenode_id required | string ID of the origin treenode to search around |
| distance | string L-infinity distance in nanometers within which to search |
| size_mode | string Whether to return skeletons with only one node in the search area (1) or more than one node in the search area (0). |
Get a compact treenode representation of a skeleton, optionally with the history of individual nodes and connectors.
Returns, in JSON, [[nodes], [connectors], {nodeID: [tags]}], with connectors and tags being empty when 0 == with_connectors and 0 == with_tags, respectively.
Each element in the [nodes] array has the following form:
[id, parent_id, user_id, location_x, location_y, location_z, radius, confidence].
Each element in the [connectors] array has the following form, with the third element representing the connector link as 0 = presynaptic, 1 = postsynaptic, 2 = gap junction, -1 = other:
[treenode_id, connector_id, 0|1|2|-1, location_x, location_y, location_z]
If history data is requested, each row contains a validity interval. Note that for the live table entry (the currently valid version), there are special semantics for this interval: The upper bound is older than or the same as the lower bound. This is done to encode the information of this row being the most recent version and including the original creation time at the same time, plus it requires less queries on the back-end to retireve data. This requires the client to do slightly more work, but unfortunately the original creation time is needed for data that was created without history tables enabled.
| project_id required | string |
| skeleton_id required | string |
| with_connectors | string Whether linked connectors should be returned. |
| with_tags | string Whether tags should be returned. |
| with_history | string Whether history information should be returned for each treenode and connector. |
| with_merge_history | string Whether the history of arbors merged into the requested skeleton should be returned. Only used if history is returned. |
| with_reviews | string Whether a node index should be returned that maps node IDs to the list of reviews done on them, respects history parameter. |
| with_annotations | string Whether the list of linked annotations should be returned. If history should be returned, returns all link versions. |
| with_user_info | string Whether all result elements should contain also the creator ID. |
| ordered | string Whether result skeletons should be ordered by ID. |
List nodes in a skeleton with labels matching a query.
Find all nodes in this skeleton with labels (front-end node tags) matching a regular expression, sort them by ascending path distance from a treenode in the skeleton, and return the result.
| project_id required | string |
| skeleton_id required | string |
| treenode_id required | string ID of the origin treenode for path length distances |
| label_regex required | string Regular expression query to match labels |
| only_leaves | string Whether to only return information on leaf nodes. |
Update the skeleton ID and optionally the neuron ID.
Can only be called by superusers or users with can_administer permissions in the project.
| project_id required | string Project the skeleton is part of |
| skeleton_id required | string The skeleton to update |
| new_skeleton_id | string The new skeleton ID |
| new_neuron_id | string The new skeleton ID |
List open leaf nodes in a skeleton.
Return a list of the ID and location of open leaf nodes in a skeleton, their path length distance to the specified treenode, and their creation time.
Leaves are considered open if they are not tagged with a tag matching a particular regex.
.. note:: This endpoint is used interactively by the client so performance is critical.
| project_id required | string |
| skeleton_id required | string |
| treenode_id required | string ID of the origin treenode for path length distances |
Export skeleton as a set of segments with per-node review information.
Export the skeleton as a list of segments of non-branching node paths, with detailed information on reviewers and review times for each node.
| project_id required | string |
| skeleton_id required | string |
| subarbor_node_id | string If provided, only the subarbor starting at this treenode is returned. |
Get aggregate/sum information on various object types in the passed in project. parameters:
| project_id required | string |
Get the largest skeletons based on cable length.
| project_id required | string |
| n_skeletoons | string How many skeletons should be returned |
| name_pattern | string Optional name pattern that returned neuron names have to match. Start with '/' for a regular expression. |
Get per user contribution statistics
A date range can be provided to limit the scope of the returned statiscis. By default, the statistics for the last ten days is returned. The returned data includes created cable length, the number of created synaptic connections and the number of reviews made, per day and user.
| project_id required | string |
| start_date | string If provided (YYYY-MM-DD), only statistics from this day on are returned (inclusive). |
| end_date | string If provided (YYYY-MM-DD), only statistics to this day on are returned (inclusive). |
| time_zone | string Optional time zone for the date range, e.g. "US/Eastern" |
| with_imports | string Whether or not to return information on the imported number of nodes and cable length. |
Get a collection of all available transactions in the passed in project.
| project_id required | string |
| range_start | string The first result element index. |
| range_length | string The maximum number result elements. |
| user_id | string The user ID to retrieve transactions for. |
| type | string The type of log entry to retriee. |
Try to associate a location in the passed in project for a particular transaction.
| project_id required | string |
| transaction_id required | string Transaction ID in question |
| execution_time required | string Execution time of the transaction |
| label | string Optional label of the transaction to avoid extra lookup |
Retrieve node information in a compact form. A list of elements of the following form is returned:
[ID, parent ID, x, y, z, confidence, radius, skeleton_id, edition_time, user_id]
The returned edition time is an epoch number.
| project_id required | string Project to work in |
| treenode_ids | string A list of treeonde IDs to return information on |
| label_ids | string A list of label IDs that must be linked to result treenodes. Alternative to explicit treenode IDs and label names. |
| label_names | string A list of label names that must be linked to result treenodes. Alternative to explicit treenode IDs and label IDs |
| skeleton_ids | string A list of skeleton IDs that result skeletons have to be part of. |
Retrieve node information in a compact form. A list of the following form is returned:
[ID, parent ID, x, y, z, confidence, radius, skeleton_id, edition_time, user_id]
The returned edition time is an epoch number.
| project_id required | string |
| treenode_id required | string |
Update confidence of edge between a node to either its parent or its connectors.
The connection between a node and its parent or the connectors it is linked to can be rated with a confidence value in the range 1-5. If connector links should be updated, one can limit the affected connections to a specific connector. Returned is an object, mapping updated partners to their old confidences.
| project_id required | string |
| treenode_id required | string |
| new_confidence required | string New confidence, value in range 1-5 |
| to_connector | string Whether all linked connectors instead of parent should be updated |
| partner_ids | string Limit update to a set of connectors if to_connector is true |
| partner_confidences | string Set different confidences to connectors in |
Suppress a virtual treenode along the edge to this node.
Suppress a virtual treenode along the edge between this treenode and its parent from being traversed during normal topology navigation and review.
| project_id required | string |
| treenode_id required | string |
| orientation required | string Stack orientation to determine which axis is the coordinate of the plane where virtual nodes are suppressed. 0 for z, 1 for y, 2 for x. |
| location_coordinate required | string Coordinate along the edge from this node to its parent where virtual nodes are suppressed. |
Create a new volume
The ID of the newly created volume is returned. Currently, box volumes and triangle meshes are supported. Which one is created depends on the "type" parameter, which can be either set to "box" or to "trimesh".
If a triangle mesh should be created, the "mesh" parameter is expected to hold the complete volume. It is expected to be a string that encodes two lists in JSON format: [[points], [triangles]]. The list of points contains lists of three numbers, each one representing a vertex in the mesh. The array of triangles also contains three element lists as items. Each one represents a triangle based on the points in the other array, that are referenced by the triangle index values.
| project_id required | string |
| type required | string Type of volume to create |
| title required | string Title of volume |
| comment | string An optional comment |
| mesh | string Triangle mesh |
| minx | string Minimum x coordinate of box |
| miny | string Minimum y coordinate of box |
| minz | string Minimum z coordinate of box |
| maxx | string Maximum x coordinate of box |
| maxy | string Maximum y coordinate of box |
| maxz | string Maximum z coordinate of box |
Find mappings to existing volumes for the passed in entity (class instance) IDs..
| project_id required | string Project to operate in |
| entity_ids[] required | string IDs of the entity IDs to get volumes for |
Find mappings to existing volumes for the passed in entity (class instance) IDs..
| project_id required | string Project to operate in |
| entity_ids[] required | string IDs of the entity IDs to get volumes for |
Find mappings to existing volumes for potential imports.
| project_id required | string Project to operate in |
| source_url required | string Source URL of volumes. If not provided, this server is assumed to be the source. |
| source_project_id required | string Source project ID of volumes |
| source_ids[] required | string IDs of the source IDs to query origin for |
Find mappings to existing volumes for potential imports.
| project_id required | string Project to operate in |
| source_url required | string Source URL of volumes. If not provided, this server is assumed to be the source. |
| source_project_id required | string Source project ID of volumes |
| source_ids[] required | string IDs of the source IDs to query origin for |
Import triangle mesh volumes from an uploaded files.
Currently only STL representation is supported.
| project_id required | string |
Triangle mesh file to import. Multiple files can be provided, with each being imported as a mesh named by its base filename.
| source_id | string If specified, this source ID will be saved and mapped to the new volume ID. |
| source_project_id | string If specified, this source project ID will be saved and mapped to the new volume ID. This is only valid together with source_id and source_url. |
| source_url | string If specified, this source URL will be saved and mapped to the new volume ID. |
| source_type | string Can be either 'mesh' or 'segmentation', to further specify of what type the origin data is. |
Test environment only contains two skeletons - based on that, sql query always returns list of all SKIDs but all data (about both skeletons) is contained in the first SKID in the list - if this changes, write an else statement for: len(cleanResults) >1.
| project_id required | string The project to operate in |
| skeleton_ids | string Constrain results to these skeletons |
| annotation | string An annotation potential target volumes need to have |
| min_nodes | string A minimum number of nodes result skeleton need to have. |
| min_cable | string A minimum number of cable length esult skeleton need to have. |
Test environment only contains two skeletons - based on that, sql query always returns list of all SKIDs but all data (about both skeletons) is contained in the first SKID in the list - if this changes, write an else statement for: len(cleanResults) >1.
| project_id required | string The project to operate in |
| skeleton_ids | string Constrain results to these skeletons |
| annotation | string An annotation potential target volumes need to have |
| min_nodes | string A minimum number of nodes result skeleton need to have. |
| min_cable | string A minimum number of cable length esult skeleton need to have. |
Get detailed information on a spatial volume or set its properties.
The result will contain the bounding box of the volume's geometry and the actual geometry encoded in X3D format. The response might might therefore be relatively large.
| project_id required | string |
| volume_id required | string |
Update the properties of a spatial volume.
Only the fields that are provided are updated. If no mesh or bounding box parameter is changed, no type has to be provided.
| project_id required | string |
| volume_id required | string |
| type | string Type of volume to edit |
| title | string Title of volume |
| comment | string A comment on a volume |
Export volume as a triangle mesh file.
The extension of the endpoint and ACCEPT header media type are both used
to determine the format of the export.
Supported formats by extension and media type:
model/stl, model/x.stl-ascii: ASCII STL| project_id required | string |
| volume_id required | string |
| extension required | string |
Test if a point intersects with the bounding box of a given volume.
| project_id required | string |
| volume_id required | string |
| x | string X coordinate of point to test |
| y | string Y coordinate of point to test |
| z | string Z coordinate of point to test |