|
- node_type
+ project_id
|
- Either 'connector', 'treenode' or 'location'
+ | Project containing node of interest
|
formData |
@@ -4624,9 +5226,9 @@ GET /{projec
|
- project_id
+ landmarkgroup_id
|
- The project the landmark group is part of.
+ | The ID of the landmark group.
|
path |
@@ -4640,9 +5242,9 @@ GET /{projec
|
|
- landmarkgroup_id
+ project_id
|
- The ID of the landmark group.
+ | The project the landmark group is part of.
|
path |
@@ -4761,13 +5363,12 @@ POST /{proje
|
- project_id
+ landmarkgroup_id
|
- The project the landmark group is part of.
- |
+ |
path |
- integer
+ string
|
@@ -4777,12 +5378,13 @@ POST /{proje
|
- landmarkgroup_id
+ project_id
|
- |
+ The project the landmark group is part of.
+ |
path |
- string
+ integer
|
@@ -4909,9 +5511,9 @@ DELETE /{pro
|
- project_id
+ landmarkgroup_id
|
- Project of landmark group
+ | The landmark group to link
|
path |
@@ -4925,9 +5527,9 @@ DELETE /{pro
|
|
- location_id
+ project_id
|
- Existing location ID
+ | Project of landmark group
|
path |
@@ -4941,9 +5543,9 @@ DELETE /{pro
|
|
- landmarkgroup_id
+ location_id
|
- The landmark group to link
+ | Existing location ID
|
path |
@@ -5010,9 +5612,9 @@ PUT /{projec
|
- project_id
+ landmarkgroup_id
|
- Project of landmark group
+ | The landmark group to link
|
path |
@@ -5026,9 +5628,9 @@ PUT /{projec
|
|
- location_id
+ project_id
|
- Existing location ID
+ | Project of landmark group
|
path |
@@ -5042,9 +5644,9 @@ PUT /{projec
|
|
- landmarkgroup_id
+ location_id
|
- The landmark group to link
+ | Existing location ID
|
path |
@@ -5119,9 +5721,9 @@ GET /{projec
|
- project_id
+ landmarkgroup_id
|
- Project of landmark groups
+ | The starting landmark group
|
path |
@@ -5135,9 +5737,9 @@ GET /{projec
|
|
- landmarkgroup_id
+ project_id
|
- The starting landmark group
+ | Project of landmark groups
|
path |
@@ -5237,9 +5839,9 @@ DELETE /{pro
|
- project_id
+ landmark_id
|
- The project the landmark is part of.
+ | The ID of the landmark.
|
path |
@@ -5253,9 +5855,9 @@ DELETE /{pro
|
|
- landmark_id
+ project_id
|
- The ID of the landmark.
+ | The project the landmark is part of.
|
path |
@@ -5330,9 +5932,9 @@ GET /{projec
|
- project_id
+ landmark_id
|
- The project the landmark is part of.
+ | The ID of the landmark.
|
path |
@@ -5346,9 +5948,9 @@ GET /{projec
|
|
- landmark_id
+ project_id
|
- The ID of the landmark.
+ | The project the landmark is part of.
|
path |
@@ -5436,9 +6038,9 @@ POST /{proje
|
- project_id
+ landmark_id
|
- The project the landmark is part of.
+ | The ID of the landmark.
|
path |
@@ -5452,9 +6054,9 @@ POST /{proje
|
|
- landmark_id
+ project_id
|
- The ID of the landmark.
+ | The project the landmark is part of.
|
path |
@@ -5556,9 +6158,9 @@ DELETE /{pro
|
|
- project_id
+ landmark_id
|
- Project of landmark group
+ | The landmark to unlink from
|
path |
@@ -5572,9 +6174,9 @@ DELETE /{pro
|
|
- landmark_id
+ project_id
|
- The landmark to unlink from
+ | Project of landmark group
|
path |
@@ -5665,9 +6267,9 @@ PUT /{projec
|
- project_id
+ landmark_id
|
- Project of landmark group
+ | The landmark to link
|
path |
@@ -5681,9 +6283,9 @@ PUT /{projec
|
|
- landmark_id
+ project_id
|
- The landmark to link
+ | Project of landmark group
|
path |
@@ -5813,9 +6415,9 @@ DELETE /{pro
|
- project_id
+ landmark_id
|
- Project of landmark group
+ | The landmark to unlink
|
path |
@@ -5829,9 +6431,9 @@ DELETE /{pro
|
|
- landmark_id
+ project_id
|
- The landmark to unlink
+ | Project of landmark group
|
path |
@@ -6165,12 +6767,13 @@ POST /{proje
|
- project_id
+ neuron_id
|
- |
+ ID of neuron to rename
+ |
path |
- string
+ integer
|
@@ -6180,13 +6783,12 @@ POST /{proje
|
- neuron_id
+ project_id
|
- ID of neuron to rename
- |
+ |
path |
- integer
+ string
|
@@ -6493,6 +7095,36 @@ POST /{proje
|
|
+
+ |
+ n_last_edited_skeletons_limit
+ |
+ Maximum number of most recently edited skeletons.
+ |
+ formData |
+
+ integer
+
+
+ |
+
+ |
+
+
+ |
+ hidden_last_editor_id
+ |
+ No nodes edited last by this user will be retuned.
+ |
+ formData |
+
+ integer
+
+
+ |
+
+ |
+
@@ -6756,21 +7388,26 @@ POST /{proje
-
-
+
+
- List points, optionally constrained by various properties.
- GET /{project_id}/points/
+ List all available point clouds or optionally a sub set.
+ GET /{project_id}/pointclouds/
Tags:
- points
+ pointclouds
- List points, optionally constrained by various properties.
+ List all available point clouds or optionally a sub set.
-
+
+
+
+ application/x-www-form-urlencoded
+
+
@@ -6787,7 +7424,7 @@ GET /{projec
|
project_id
|
- Project of points
+ | Project of the returned point clouds
|
path |
@@ -6799,6 +7436,81 @@ GET /{projec
|
+
+ |
+ simple
+ |
+ Wheter or not only ID and name should be returned
+ |
+ formData |
+
+ bool
+
+
+ |
+
+ |
+
+
+ |
+ with_images
+ |
+ Wheter linked images should returned as well.
+ |
+ formData |
+
+ bool
+
+
+ |
+
+ |
+
+
+ |
+ with_points
+ |
+ Wheter linked points should returned as well.
+ |
+ formData |
+
+ bool
+
+
+ |
+
+ |
+
+
+ |
+ sample_ratio
+ |
+ Number in [0,1] to optionally sample point cloud
+ |
+ formData |
+
+ number
+
+
+ |
+
+ |
+
+
+ |
+ pointcloud_ids
+ |
+ A list of point cloud IDs to which the query is constrained.
+ |
+ path |
+
+ string[]
+
+
+ |
+
+ |
+
@@ -6826,16 +7538,16 @@ GET /{projec
-
+
- Add a new point. Expect at least the location as parameters.
- PUT /{project_id}/points/
+ List all available point clouds or optionally a sub set.
+ POST /{project_id}/pointclouds/
Tags:
- points
+ pointclouds
- Add a new point. Expect at least the location as parameters.
+ List all available point clouds or optionally a sub set.
@@ -6861,7 +7573,7 @@ PUT /{projec
|
project_id
|
- Project of points
+ | Project of the returned point clouds
|
path |
@@ -6875,61 +7587,58 @@ PUT /{projec
| |
|
- location_x
+ simple
|
- X coordinate
+ | Wheter or not only ID and name should be returned
|
formData |
- float
+ bool
|
-
|
|
- location_y
+ with_images
|
- Y coordinate
+ | Wheter linked images should returned as well.
|
formData |
- float
+ bool
|
-
|
|
- location_z
+ with_points
|
- Z coordinate
+ | Wheter linked points should returned as well.
|
formData |
- float
+ bool
|
-
|
|
- radius
+ sample_ratio
|
- Optional radius
+ | Number in [0,1] to optionally sample point cloud
|
formData |
- float
+ number
|
@@ -6938,13 +7647,13 @@ PUT /{projec
|
- confidence
+ pointcloud_ids
|
- Optional confidence in [0,5]
+ | A list of point cloud IDs to which the query is constrained.
|
- formData |
+ path |
- integer
+ string[]
|
@@ -6958,11 +7667,11 @@ PUT /{projec
- -
- 200 OK
+
-
+ 201 Created
- -
+
-
@@ -6978,22 +7687,25 @@ PUT /{projec
-
-
-
+
- Delete one particular point.
- DELETE /{project_id}/points/{point_id}/
+ Create a new pointcloud by providing.
+ PUT /{project_id}/pointclouds/
Tags:
- points
+ pointclouds
- Delete one particular point.
+ Create a new pointcloud by providing.
-
+
+
+
+ application/x-www-form-urlencoded
+
+
@@ -7008,9 +7720,9 @@ DELETE /{pro
|
- point_id
+ project_id
|
- ID of point
+ | Project of the new point cloud
|
path |
@@ -7024,13 +7736,13 @@ DELETE /{pro
|
|
- project_id
+ name
|
- Project point is part of
+ | Name of the new point cloud
|
- path |
+ formData |
- integer
+ string
|
@@ -7038,68 +7750,30 @@ DELETE /{pro
-
-
-
-
-
-
-
- -
- 204 No Content
-
-
- -
-
-
-
-
-
-
-
-
- Return details on one particular point.
- GET /{project_id}/points/{point_id}/
- Tags:
- points
-
-
-
- Return details on one particular point.
-
-
-
-
-
-
-
-
- |
- |
- |
- |
- |
-
-
-
|
- point_id
+ description
|
- ID of point
+ | Description of the new point cloud
|
- path |
+ formData |
- integer
+ string
+
+
+ |
+
+ |
+
+
+ |
+ points
+ |
+ Points of point cloud in project space. Can be a stringified JSON array.
+ |
+ formData |
+
+ string[]
|
@@ -7109,18 +7783,17 @@ GET /{projec
|
- project_id
+ group_id
|
- Project point is part of
+ | A group for which this point cloud will be visible exclusivly.
|
- path |
+ formData |
integer
|
-
|
@@ -7150,26 +7823,22 @@ GET /{projec
-
+
+
+
- Update one particular point.
- POST /{project_id}/points/{point_id}/
+ Delete a point cloud.
+ DELETE /{project_id}/pointclouds/{pointcloud_id}/
Tags:
- points
+ pointclouds
- Update one particular point.
- Requires at least one field to change.
+ Delete a point cloud.
-
-
-
- application/x-www-form-urlencoded
-
-
+
@@ -7184,13 +7853,12 @@ POST /{proje
|
- point_id
+ project_id
|
- ID of point
- |
+ |
path |
- integer
+ string
|
@@ -7200,13 +7868,12 @@ POST /{proje
|
- project_id
+ pointcloud_id
|
- Project point is part of
- |
+ |
path |
- integer
+ string
|
@@ -7214,81 +7881,6 @@ POST /{proje
-
- |
- location_x
- |
- X coordinate
- |
- formData |
-
- float
-
-
- |
-
- |
-
-
- |
- location_y
- |
- Y coordinate
- |
- formData |
-
- float
-
-
- |
-
- |
-
-
- |
- location_z
- |
- Z coordinate
- |
- formData |
-
- float
-
-
- |
-
- |
-
-
- |
- radius
- |
- Optional radius
- |
- formData |
-
- float
-
-
- |
-
- |
-
-
- |
- confidence
- |
- Optional confidence in [0,5]
- |
- formData |
-
- integer
-
-
- |
-
- |
-
@@ -7296,11 +7888,11 @@ POST /{proje
- -
- 201 Created
+
-
+ 204 No Content
- -
+
-
@@ -7316,29 +7908,46 @@ POST /{proje
-
-
-
+
- Get a collection of available samplers.
- GET /{project_id}/samplers/
+ Return a point cloud.
+ GET /{project_id}/pointclouds/{pointcloud_id}/
Tags:
- samplers
+ pointclouds
- 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.
+ Return a point cloud.
+ parameters:
+
+ - name: project_id
+ description: Project of the returned point cloud
+ type: integer
+ paramType: path
+ required: true
+ - name: simple
+ description: Wheter or not only ID and name should be returned
+ type: bool
+ paramType: form
+ required: false
+ defaultValue: false
+ - name: with_images
+ description: Wheter linked images should returned as well.
+ type: bool
+ paramType: form
+ required: false
+ defaultValue: false
+ - name: with_points
+ description: Wheter linked points should returned as well.
+ type: bool
+ paramType: form
+ required: false
+ defaultValue: false
+
-
-
-
- application/x-www-form-urlencoded
-
-
+
@@ -7368,47 +7977,17 @@ GET /{projec
|
- skeleton_ids
- |
- Optional skeleton IDs to constrain result set to.
- |
- formData |
-
- integer
-
-
- |
-
- |
-
-
- |
- with_domains
- |
- Optional flag to include all domains of all result sampler results.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_intervals
+ pointcloud_id
|
- Optional flag to include all intervals of all domains. Implies with_domains.
- |
- formData |
+ |
+ path |
- boolean
+ string
|
+
|
@@ -7439,26 +8018,39 @@ GET /{projec
-
-
+
+
- Create a new sampler for a skeleton.
- POST /{project_id}/samplers/add
+ Return a point cloud.
+ GET /{project_id}/pointclouds/{pointcloud_id}/images/{image_id}/
Tags:
- samplers
+ pointclouds
- Create a new sampler for a skeleton.
+ Return a point cloud.
+ parameters:
+
+ - name: project_id
+ description: Project of the returned point cloud image
+ type: integer
+ paramType: path
+ required: true
+ - name: pointcloud_id
+ description: Point cloud this image is linked to
+ type: integer
+ paramType: path
+ required: true
+ - name: image_id
+ description: The image to load
+ type: integer
+ paramType: path
+ required: true
+
-
-
-
- application/x-www-form-urlencoded
-
-
+
@@ -7473,7 +8065,7 @@ POST /{proje
|
- project_id
+ image_id
|
|
path |
@@ -7488,13 +8080,12 @@ POST /{proje
|
- skeleton_id
+ project_id
|
- Skeleton this sampelr is for
- |
- formData |
+ |
+ path |
- integer
+ string
|
@@ -7504,44 +8095,12 @@ POST /{proje
|
- interval_length
+ pointcloud_id
|
- Length of a intervals with domains (nm).
- |
- formData |
+ |
+ path |
- integer
-
-
- |
-
-
- |
-
-
- |
- interval_error
- |
- Maximum allowed error for a single interval.
- |
- formData |
-
- float
-
-
- |
-
- |
-
-
- |
- review_required
- |
- Whether reviews should be enforced in this sampler
- |
- formData |
-
- boolean
+ string
|
@@ -7549,15 +8108,70 @@ POST /{proje
+
+
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ List points, optionally constrained by various properties.
+ GET /{project_id}/points/
+ Tags:
+ points
+
+
+
+ List points, optionally constrained by various properties.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
|
- create_interval_boundaries
+ project_id
|
- Whether new nodes for interval boundaries should be created.
+ | Project of points
|
- formData |
+ path |
- boolean
+ integer
|
@@ -7565,21 +8179,6 @@ POST /{proje
-
- |
- leaf_segment_handling
- |
- How leaf segments should be handled, can be 'ignore', 'merge' or 'short-interval'.
- |
- formData |
-
- string
-
-
- |
-
- |
-
@@ -7587,11 +8186,11 @@ POST /{proje
- -
- 201 Created
+
-
+ 200 OK
- -
+
-
@@ -7607,20 +8206,16 @@ POST /{proje
-
-
-
+
- Get a list of connectors that already have a state associated with them.
- GET /{project_id}/samplers/connectors/
+ Add a new point. Expect at least the location as parameters.
+ PUT /{project_id}/points/
Tags:
- samplers
+ points
- 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.
+ Add a new point. Expect at least the location as parameters.
@@ -7646,10 +8241,11 @@ GET /{projec
|
project_id
|
- |
+ Project of points
+ |
path |
- string
+ integer
|
@@ -7659,39 +8255,72 @@ GET /{projec
|
- interval_id
+ location_x
|
- The interval all results should be part of
+ | X coordinate
|
formData |
- integer
+ float
|
+
|
|
- connector_id
+ location_y
|
- The connector to get sampler information for
+ | Y coordinate
|
formData |
- integer
+ float
|
+
|
|
- state_id
+ location_z
|
- The state all result sets have to have.
+ | Z coordinate
+ |
+ formData |
+
+ float
+
+
+ |
+
+
+ |
+
+
+ |
+ radius
+ |
+ Optional radius
+ |
+ formData |
+
+ float
+
+
+ |
+
+ |
+
+
+ |
+ confidence
+ |
+ Optional confidence in [0,5]
|
formData |
@@ -7730,17 +8359,17 @@ GET /{projec
-
-
+
+
- Get a list of all available connectors states and their IDs.
- GET /{project_id}/samplers/connectors/states/
+ Delete one particular point.
+ DELETE /{project_id}/points/{point_id}/
Tags:
- samplers
+ points
- Get a list of all available connectors states and their IDs.
+ Delete one particular point.
@@ -7757,14 +8386,31 @@ GET /{projec
|
+
+ |
+ point_id
+ |
+ ID of point
+ |
+ path |
+
+ integer
+
+
+ |
+
+
+ |
+
|
project_id
|
- |
+ Project point is part of
+ |
path |
- string
+ integer
|
@@ -7779,11 +8425,11 @@ GET /{projec
- -
- 200 OK
+
-
+ 204 No Content
- -
+
-
@@ -7799,18 +8445,16 @@ GET /{projec
-
-
-
+
- Get a list of all available interval states.
- GET /{project_id}/samplers/domains/intervals/states/
+ Return details on one particular point.
+ GET /{project_id}/points/{point_id}/
Tags:
- samplers
+ points
- Get a list of all available interval states.
+ Return details on one particular point.
@@ -7827,14 +8471,31 @@ GET /{projec
+
+ |
+ point_id
+ |
+ ID of point
+ |
+ path |
+
+ integer
+
+
+ |
+
+
+ |
+
|
project_id
|
- |
+ Project point is part of
+ |
path |
- string
+ integer
|
@@ -7869,19 +8530,18 @@ GET /{projec
-
-
-
+
- Set state of sampler connector
- POST /{project_id}/samplers/domains/intervals/{interval_id}/connectors/{connector_id}/set-state
+ Update one particular point.
+ POST /{project_id}/points/{point_id}/
Tags:
- samplers
+ points
- Set state of sampler connector
-
+ Update one particular point.
+ Requires at least one field to change.
+
@@ -7904,11 +8564,11 @@ POST /{proje
|
- interval_id
+ point_id
|
- Interval the connector is part of
+ | ID of point
|
- formData |
+ path |
integer
@@ -7922,10 +8582,11 @@ POST /{proje
|
project_id
|
- |
+ Project point is part of
+ |
path |
- string
+ integer
|
@@ -7935,25 +8596,69 @@ POST /{proje
|
|
- connector_id
+ location_x
|
- Connector to set state of
+ | X coordinate
|
formData |
- integer
+ float
|
-
|
|
- state_id
+ location_y
|
- The new state
+ | Y coordinate
+ |
+ formData |
+
+ float
+
+
+ |
+
+ |
+
+
+ |
+ location_z
+ |
+ Z coordinate
+ |
+ formData |
+
+ float
+
+
+ |
+
+ |
+
+
+ |
+ radius
+ |
+ Optional radius
+ |
+ formData |
+
+ float
+
+
+ |
+
+ |
+
+
+ |
+ confidence
+ |
+ Optional confidence in [0,5]
|
formData |
@@ -7962,7 +8667,6 @@ POST /{proje
|
-
|
@@ -7993,21 +8697,28 @@ POST /{proje
-
-
+
+
- Get details on a particular interval.
- GET /{project_id}/samplers/domains/intervals/{interval_id}/details
+ Get a collection of available samplers.
+ GET /{project_id}/samplers/
Tags:
samplers
- Get details on a particular interval.
+ 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.
-
+
+
+
+ application/x-www-form-urlencoded
+
+
@@ -8022,7 +8733,7 @@ GET /{projec
|
- interval_id
+ project_id
|
|
path |
@@ -8037,17 +8748,47 @@ GET /{projec
|
- project_id
+ skeleton_ids
|
- |
- path |
+ Optional skeleton IDs to constrain result set to.
+ |
+ formData |
- string
+ integer
+
+
+ |
+
+ |
+
+
+ |
+ with_domains
+ |
+ Optional flag to include all domains of all result sampler results.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ with_intervals
+ |
+ Optional flag to include all intervals of all domains. Implies with_domains.
+ |
+ formData |
+
+ boolean
|
-
|
@@ -8078,17 +8819,17 @@ GET /{projec
-
-
+
+
- Set state of an interval.
- POST /{project_id}/samplers/domains/intervals/{interval_id}/set-state
+ Create a new sampler for a skeleton.
+ POST /{project_id}/samplers/add
Tags:
samplers
- Set state of an interval.
+ Create a new sampler for a skeleton.
@@ -8112,9 +8853,24 @@ POST /{proje
|
- interval_id
+ project_id
|
- Interval to update state of
+ | |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ skeleton_id
+ |
+ Skeleton this sampelr is for
|
formData |
@@ -8128,12 +8884,60 @@ POST /{proje
|
|
- project_id
+ interval_length
|
- |
- path |
+ Length of a intervals with domains (nm).
+ |
+ formData |
- string
+ integer
+
+
+ |
+
+
+ |
+
+
+ |
+ interval_error
+ |
+ Maximum allowed error for a single interval.
+ |
+ formData |
+
+ float
+
+
+ |
+
+ |
+
+
+ |
+ review_required
+ |
+ Whether reviews should be enforced in this sampler
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+
+ |
+
+
+ |
+ create_interval_boundaries
+ |
+ Whether new nodes for interval boundaries should be created.
+ |
+ formData |
+
+ boolean
|
@@ -8141,6 +8945,36 @@ POST /{proje
+
+ |
+ leaf_segment_handling
+ |
+ How leaf segments should be handled, can be 'ignore', 'merge' or 'short-interval'.
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ merge_limit
+ |
+ 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.
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
@@ -8169,21 +9003,28 @@ POST /{proje
-
-
+
+
- Get a list of all available domain types.
- GET /{project_id}/samplers/domains/types/
+ Get a list of connectors that already have a state associated with them.
+ GET /{project_id}/samplers/connectors/
Tags:
samplers
- Get a list of all available domain types.
-
-
+ 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.
-
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
@@ -8211,6 +9052,51 @@ GET /{projec
+
+ |
+ interval_id
+ |
+ The interval all results should be part of
+ |
+ formData |
+
+ integer
+
+
+ |
+
+ |
+
+
+ |
+ connector_id
+ |
+ The connector to get sampler information for
+ |
+ formData |
+
+ integer
+
+
+ |
+
+ |
+
+
+ |
+ state_id
+ |
+ The state all result sets have to have.
+ |
+ formData |
+
+ integer
+
+
+ |
+
+ |
+
@@ -8239,17 +9125,17 @@ GET /{projec
-
-
+
+
- Get details on a particular domain.
- GET /{project_id}/samplers/domains/{domain_id}/details
+ Get a list of all available connectors states and their IDs.
+ GET /{project_id}/samplers/connectors/states/
Tags:
samplers
- Get details on a particular domain.
+ Get a list of all available connectors states and their IDs.
@@ -8266,21 +9152,6 @@ GET /{projec
-
- |
- domain_id
- |
- |
- path |
-
- string
-
-
- |
-
-
- |
-
project_id
@@ -8324,26 +9195,21 @@ GET /{projec
-
-
+
+
- Get a collection of available sampler domains intervals.
- GET /{project_id}/samplers/domains/{domain_id}/intervals/
+ Get a list of all available interval states.
+ GET /{project_id}/samplers/domains/intervals/states/
Tags:
samplers
- Get a collection of available sampler domains intervals.
+ Get a list of all available interval states.
-
-
-
- application/x-www-form-urlencoded
-
-
+
@@ -8356,22 +9222,6 @@ GET /{projec
-
- |
- domain_id
- |
- Domain to list intervals for
- |
- formData |
-
- integer
-
-
- |
-
-
- |
-
project_id
@@ -8415,21 +9265,26 @@ GET /{projec
-
-
+
+
- Create all intervals in a particular domain.
- POST /{project_id}/samplers/domains/{domain_id}/intervals/add-all
+ Set state of sampler connector
+ POST /{project_id}/samplers/domains/intervals/{interval_id}/connectors/{connector_id}/set-state
Tags:
samplers
- Create all intervals in a particular domain.
+ Set state of sampler connector
-
+
+
+
+ application/x-www-form-urlencoded
+
+
@@ -8444,12 +9299,13 @@ POST /{proje
|
- domain_id
+ interval_id
|
- |
- path |
+ Interval the connector is part of
+ |
+ formData |
- string
+ integer
|
@@ -8472,6 +9328,38 @@ POST /{proje
+
+ |
+ connector_id
+ |
+ Connector to set state of
+ |
+ formData |
+
+ integer
+
+
+ |
+
+
+ |
+
+
+ |
+ state_id
+ |
+ The new state
+ |
+ formData |
+
+ integer
+
+
+ |
+
+
+ |
+
@@ -8500,17 +9388,17 @@ POST /{proje
-
-
+
+
- Get a list of all available sampler states and their IDs.
- GET /{project_id}/samplers/states/
+ Get details on a particular interval.
+ GET /{project_id}/samplers/domains/intervals/{interval_id}/details
Tags:
samplers
- Get a list of all available sampler states and their IDs.
+ Get details on a particular interval.
@@ -8527,6 +9415,21 @@ GET /{projec
|
+
+ |
+ interval_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
project_id
@@ -8570,21 +9473,17 @@ GET /{projec
-
-
+
+
- Delete a sampler if permissions allow it.
- POST /{project_id}/samplers/{sampler_id}/delete
+ Set state of an interval.
+ POST /{project_id}/samplers/domains/intervals/{interval_id}/set-state
Tags:
samplers
- 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
- <delete_created_nodes> parameter.
+ Set state of an interval.
@@ -8608,12 +9507,13 @@ POST /{proje
|
- sampler_id
+ interval_id
|
- |
- path |
+ Interval to update state of
+ |
+ formData |
- string
+ integer
|
@@ -8636,22 +9536,6 @@ POST /{proje
-
- |
- delete_created_nodes
- |
- Optional flag to disable automatic removal of untouched
- nodes created for this sampler's intervals.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
|
@@ -8680,26 +9564,21 @@ POST /{proje
-
-
+
+
- Get a collection of available sampler domains.
- GET /{project_id}/samplers/{sampler_id}/domains/
+ Get a list of all available domain types.
+ GET /{project_id}/samplers/domains/types/
Tags:
samplers
- Get a collection of available sampler domains.
+ Get a list of all available domain types.
-
-
-
- application/x-www-form-urlencoded
-
-
+
@@ -8714,23 +9593,7 @@ GET /{projec
|
- sampler_id
- |
- Sampler to list domains for
- |
- formData |
-
- integer
-
-
- |
-
-
- |
-
-
- |
- project_id
+ project_id
|
|
path |
@@ -8771,26 +9634,21 @@ GET /{projec
-
-
+
+
- Create a new domain for a sampler.
- POST /{project_id}/samplers/{sampler_id}/domains/add
+ Get details on a particular domain.
+ GET /{project_id}/samplers/domains/{domain_id}/details
Tags:
samplers
- Create a new domain for a sampler.
+ Get details on a particular domain.
-
-
-
- application/x-www-form-urlencoded
-
-
+
@@ -8805,13 +9663,12 @@ POST /{proje
|
- sampler_id
+ domain_id
|
- Sampeler the new domain is part of
- |
- formData |
+ |
+ path |
- integer
+ string
|
@@ -8834,11 +9691,71 @@ POST /{proje
+
+
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Get a collection of available sampler domains intervals.
+ GET /{project_id}/samplers/domains/{domain_id}/intervals/
+ Tags:
+ samplers
+
+
+
+ Get a collection of available sampler domains intervals.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
|
- domain_type_id
+ domain_id
|
- The type of the new domain
+ | Domain to list intervals for
|
formData |
@@ -8852,13 +9769,12 @@ POST /{proje
|
|
- start_node_id
+ project_id
|
- Start node of domain
- |
- formData |
+ |
+ path |
- integer
+ string
|
@@ -8866,15 +9782,69 @@ POST /{proje
+
+
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Create all intervals in a particular domain.
+ POST /{project_id}/samplers/domains/{domain_id}/intervals/add-all
+ Tags:
+ samplers
+
+
+
+ Create all intervals in a particular domain.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
|
- end_node_ids
+ domain_id
|
- A list of all end nodes for the new domain
- |
- formData |
+ |
+ path |
- string[]
+ string
|
@@ -8884,17 +9854,17 @@ POST /{proje
|
- parent_interval_id
+ project_id
|
- Optional parent inerval ID.
- |
- formData |
+ |
+ path |
- integer
+ string
|
+
|
@@ -8925,17 +9895,17 @@ POST /{proje
-
-
+
+
- Create a new domain for a sampler.
- POST /{project_id}/samplers/{sampler_id}/domains/add-all
+ Get a list of all available sampler states and their IDs.
+ GET /{project_id}/samplers/states/
Tags:
samplers
- Create a new domain for a sampler.
+ Get a list of all available sampler states and their IDs.
@@ -8952,21 +9922,6 @@ POST /{proje
-
- |
- sampler_id
- |
- |
- path |
-
- string
-
-
- |
-
-
- |
-
project_id
@@ -8989,11 +9944,11 @@ POST /{proje
- -
- 201 Created
+
-
+ 200 OK
- -
+
-
@@ -9010,21 +9965,17 @@ POST /{proje
-
-
+
+
- Return a sparse connectivity matrix representation for the given skeleton
- POST /{project_id}/skeleton/connectivity_matrix
+ Get details on a particular sampler.
+ GET /{project_id}/samplers/{sampler_id}/
Tags:
- skeleton
+ samplers
- 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.
+ Get details on a particular sampler.
@@ -9048,9 +9999,9 @@ POST /{proje
|
- project_id
+ sampler_id
|
- Project of skeletons
+ | The sampler to return.
|
path |
@@ -9059,46 +10010,43 @@ POST /{proje
|
-
|
|
- rows
+ project_id
|
- IDs of row skeletons
+ | The project to operate in.
|
- formData |
+ path |
- string[]
+ integer
|
-
|
|
- columns
+ with_domains
|
- IDs of column skeletons
+ | Optional flag to include all domains of all result sampler results.
|
formData |
- string[]
+ boolean
|
-
|
|
- with_locations
+ with_intervals
|
- Whether or not to return locations of connectors
+ | Optional flag to include all intervals of all domains. Implies with_domains.
|
formData |
@@ -9116,11 +10064,11 @@ POST /{proje
- -
- 201 Created
+
-
+ 200 OK
- -
+
-
@@ -9136,24 +10084,25 @@ POST /{proje
-
-
-
+
- List skeletons matching filtering criteria.
- GET /{project_id}/skeletons/
+ Set fields of a particular sampler.
+ POST /{project_id}/samplers/{sampler_id}/
Tags:
- skeletons
+ samplers
- List skeletons matching filtering criteria.
- The result set is the intersection of skeletons matching criteria (the
- criteria are conjunctive) unless stated otherwise.
+ Set fields of a particular sampler.
-
+
+
+
+ application/x-www-form-urlencoded
+
+
@@ -9168,26 +10117,11 @@ GET /{projec
|
- project_id
- |
- |
- path |
-
- string
-
-
- |
-
-
- |
-
-
- |
- created_by
+ sampler_id
|
- Filter for user ID of the skeletons' creator.
+ | The sampler to return.
|
- query |
+ path |
integer
@@ -9198,11 +10132,11 @@ GET /{projec
|
|
- reviewed_by
+ project_id
|
- Filter for user ID of the skeletons' reviewer.
+ | The project to operate in.
|
- query |
+ path |
integer
@@ -9213,44 +10147,13 @@ GET /{projec
|
|
- from_date
- |
- Filter for skeletons with nodes created after this date.
- |
- query |
-
- string
-
-
- |
-
- |
-
-
- |
- to_date
- |
- Filter for skeletons with nodes created before this date.
- |
- query |
-
- string
-
-
- |
-
- |
-
-
- |
- nodecount_gt
+ leaf_handling_mode
|
- Filter for skeletons with more nodes than this threshold. Removes
- all other criteria.
+ | Optional flag to include all domains of all result sampler results.
|
- query |
+ formData |
- integer
+ boolean
|
@@ -9264,11 +10167,11 @@ GET /{projec
- -
- 200 OK
+
-
+ 201 Created
- -
+
-
@@ -9285,36 +10188,21 @@ GET /{projec
-
-
+
+
- Get a compact treenode representation of a list of skeletons, optionally
- POST /{project_id}/skeletons/compact-detail
+ Delete a sampler if permissions allow it.
+ POST /{project_id}/samplers/{sampler_id}/delete
Tags:
- skeletons
+ samplers
- 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.
+ 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
+ <delete_created_nodes> parameter.
@@ -9338,7 +10226,7 @@ POST /{proje
|
- project_id
+ sampler_id
|
|
path |
@@ -9353,115 +10241,25 @@ POST /{proje
|
-
+ project_id
|
|
- formData |
+ path |
string
|
+
|
|
- with_connectors
- |
- Whether linked connectors should be returned.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_tags
- |
- Whether tags should be returned.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_history
- |
- Whether history information should be returned for each treenode and connector.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_merge_history
- |
- Whether the history of arbors merged into the requested skeleton should be returned. Only used if history is returned.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_reviews
- |
- Whether a node index should be returned that maps node IDs to the
- list of reviews done on them, respects history parameter.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_annotations
- |
- Whether the list of linked annotations should be returned. If history
- should be returned, returns all link versions.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_user_info
+ delete_created_nodes
|
- Whether all result elements should contain also the creator ID.
+ | Optional flag to disable automatic removal of untouched
+ nodes created for this sampler's intervals.
|
formData |
@@ -9500,24 +10298,17 @@ POST /{proje
-
-
+
+
- Get a synaptic graph between skeletons compartmentalized by confidence.
- POST /{project_id}/skeletons/confidence-compartment-subgraph
+ Get a collection of available sampler domains.
+ GET /{project_id}/samplers/{sampler_id}/domains/
Tags:
- skeletons
+ samplers
- 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 #}.
+ Get a collection of available sampler domains.
@@ -9541,12 +10332,13 @@ POST /{proje
|
- project_id
+ sampler_id
|
- |
- path |
-
- string
+ | Sampler to list domains for
+ |
+ formData |
+
+ integer
|
@@ -9556,13 +10348,12 @@ POST /{proje
|
- skeleton_ids[]
+ project_id
|
- IDs of the skeletons to graph
- |
- formData |
+ |
+ path |
- string[]
+ string
|
@@ -9570,11 +10361,71 @@ POST /{proje
+
+ |
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Create a new domain for a sampler.
+ POST /{project_id}/samplers/{sampler_id}/domains/add
+ Tags:
+ samplers
+
+
+
+ Create a new domain for a sampler.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
|
- confidence_threshold
+ sampler_id
|
- Confidence value below which to segregate compartments
+ | Sampeler the new domain is part of
|
formData |
@@ -9583,43 +10434,61 @@ POST /{proje
|
+
|
|
- bandwidth
+ project_id
|
- Bandwidth in nanometers
+ | |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ domain_type_id
+ |
+ The type of the new domain
|
formData |
- number
+ integer
|
+
|
|
- cable_spread
+ start_node_id
|
- Cable spread in nanometers
+ | Start node of domain
|
formData |
- number
+ integer
|
+
|
|
- expand[]
+ end_node_ids
|
- IDs of the skeletons to expand
+ | A list of all end nodes for the new domain
|
formData |
@@ -9628,17 +10497,18 @@ POST /{proje
|
+
|
|
- link_types[]
+ parent_interval_id
|
- IDs of link types to respect
+ | Optional parent inerval ID.
|
formData |
- string[]
+ integer
|
@@ -9673,31 +10543,21 @@ POST /{proje
-
-
+
+
- Retrieve a list of down/up-stream partners of a set of skeletons.
- POST /{project_id}/skeletons/connectivity
+ Create a new domain for a sampler.
+ POST /{project_id}/samplers/{sampler_id}/domains/add-all
Tags:
- skeletons
+ samplers
- 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.
+ Create a new domain for a sampler.
-
-
-
- application/x-www-form-urlencoded
-
-
+
@@ -9712,7 +10572,7 @@ POST /{proje
|
- project_id
+ sampler_id
|
|
path |
@@ -9727,28 +10587,10 @@ POST /{proje
|
- source_skeleton_ids[]
- |
- IDs of the skeletons whose partners to find
- |
- formData |
-
- string[]
-
-
- |
-
-
- |
-
-
- |
- boolean_op
+ project_id
|
- Whether to find partners of any source skeleton ("OR") or partners
- common to all source skeletons ("AND")
- |
- formData |
+ |
+ path |
string
@@ -9758,22 +10600,6 @@ POST /{proje
|
-
- |
- with_nodes
- |
- Whether to return detailed connectivity information that includes
- partner sites.
- |
- formData |
-
- voolean
-
-
- |
-
- |
-
@@ -9802,18 +10628,17 @@ POST /{proje
-
-
+
+
- Import a neuron modeled by a skeleton from an uploaded file.
- POST /{project_id}/skeletons/import
+ List all available NBLAST configurations.
+ GET /{project_id}/similarity/configs/
Tags:
- skeletons
+ similarity
- Import a neuron modeled by a skeleton from an uploaded file.
- Currently only SWC representation is supported.
+ List all available NBLAST configurations.
@@ -9822,18 +10647,6 @@ POST /{proje
application/x-www-form-urlencoded
-
-
- A skeleton representation file to import.
-
-
-
-
@@ -9851,41 +10664,27 @@ POST /{proje
|
project_id
|
- |
- path |
-
- string
-
-
- |
-
-
- |
-
-
- |
- neuron_id
- |
- If specified, the imported skeleton will model this existing neuron.
+ | Project of the returned configurations
|
- formData |
+ path |
integer
|
+
|
|
- name
+ simple
|
- If specified, the name of a new neuron will be set to this.
+ | Wheter or not only ID and name should be returned
|
formData |
- string
+ bool
|
@@ -9899,11 +10698,11 @@ POST /{proje
- -
- 201 Created
+
-
+ 200 OK
- -
+
-
@@ -9919,28 +10718,22 @@ POST /{proje
-
-
-
+
- Get a list of all skeletons that intersect with the passed in bounding
- GET /{project_id}/skeletons/in-bounding-box
+ Create a new similarity/NBLAST configuration either by providing
+ PUT /{project_id}/similarity/configs/
Tags:
- skeletons
+ similarity
- Get a list of all skeletons that intersect with the passed in bounding
- box. Optionally, only a subsed of passed in skeletons can be tested against.
+ 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.
-
-
-
- application/x-www-form-urlencoded
-
-
+
@@ -9968,15 +10761,2463 @@ GET /{projec
-
- |
- limit
- |
- Limit the number of returned nodes.
- |
- formData |
-
- integer
+
+ |
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Delete a NBLAST configuration.
+ DELETE /{project_id}/similarity/configs/{config_id}/
+ Tags:
+ similarity
+
+
+
+ Delete a NBLAST configuration.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ config_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 204 No Content
+
+
+ -
+
+
+
+
+
+
+
+
+ Delete a NBLAST configuration.
+ GET /{project_id}/similarity/configs/{config_id}/
+ Tags:
+ similarity
+
+
+
+ Delete a NBLAST configuration.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ config_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ List all available NBLAST similarity tasks.
+ GET /{project_id}/similarity/queries/
+ Tags:
+ similarity
+
+
+
+ List all available NBLAST similarity tasks.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ Project of the returned similarities
+ |
+ path |
+
+ integer
+
+
+ |
+
+
+ |
+
+
+ |
+ config_id
+ |
+ Return only similarities linked to this config
+ |
+ formData |
+
+ integer
+
+
+ |
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Compare two sets of objects (skeletons or point clouds) and return an
+ POST /{project_id}/similarity/queries/similarity
+ Tags:
+ similarity
+
+
+
+ Compare two sets of objects (skeletons or point clouds) and return an
+ NBLAST scoring based on an existing NBLAST configuration.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ Project to operate in
+ |
+ path |
+
+ integer
+
+
+ |
+
+
+ |
+
+
+ |
+ config_id
+ |
+ ID of the new NBLAST configuration to use
+ |
+ formData |
+
+ integer
+
+
+ |
+
+
+ |
+
+
+ |
+ query_ids
+ |
+ Set of objects (skeletons or point clouds) to query similarity for.
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+ |
+ target_ids
+ |
+ Set of objects (skeletons or point clouds) or point clouds to compare against.
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+ |
+ target_type
+ |
+ Type of target objects, 'skeleton' or 'pointcloud'.
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ name
+ |
+ Name for the similarity lookup task
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ normalized
+ |
+ Whether and how scores should be normalized.
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ use_alpha
+ |
+ Whether to consider local directions in the similarity computation
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ query_type_id
+ |
+ Type of query data
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ target_type_id
+ |
+ Type of query data
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ query_meta
+ |
+ Extra data for the selected query type. A JSON encoded string is expected.
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ target_meta
+ |
+ Extra data for the selected target type. A JSON encoded string is expected.
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ remove_target_duplicates
+ |
+ Remove all target objects that appear also in the query.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ simplify
+ |
+ Whether or not to simplify neurons and remove parts below a specified branch point level.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ required_branches
+ |
+ The required branch levels if neurons should be simplified.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Delete a NBLAST similarity task.
+ DELETE /{project_id}/similarity/queries/{similarity_id}/
+ Tags:
+ similarity
+
+
+
+ Delete a NBLAST similarity task.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ similarity_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 204 No Content
+
+
+ -
+
+
+
+
+
+
+
+
+ Get a particular similarity query result.
+ GET /{project_id}/similarity/queries/{similarity_id}/
+ Tags:
+ similarity
+
+
+
+ Get a particular similarity query result.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ similarity_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Return a sparse connectivity matrix representation for the given skeleton
+ POST /{project_id}/skeleton/connectivity_matrix
+ Tags:
+ skeleton
+
+
+
+ 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.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ Project of skeletons
+ |
+ path |
+
+ integer
+
+
+ |
+
+
+ |
+
+
+ |
+ rows
+ |
+ IDs of row skeletons
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+ |
+ columns
+ |
+ IDs of column skeletons
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+ |
+ with_locations
+ |
+ Whether or not to return locations of connectors
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ List skeletons matching filtering criteria.
+ GET /{project_id}/skeletons/
+ Tags:
+ skeletons
+
+
+
+ List skeletons matching filtering criteria.
+ The result set is the intersection of skeletons matching criteria (the
+ criteria are conjunctive) unless stated otherwise.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ created_by
+ |
+ Filter for user ID of the skeletons' creator.
+ |
+ query |
+
+ integer
+
+
+ |
+
+ |
+
+
+ |
+ reviewed_by
+ |
+ Filter for user ID of the skeletons' reviewer.
+ |
+ query |
+
+ integer
+
+
+ |
+
+ |
+
+
+ |
+ from_date
+ |
+ Filter for skeletons with nodes created after this date.
+ |
+ query |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ to_date
+ |
+ Filter for skeletons with nodes created before this date.
+ |
+ query |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ nodecount_gt
+ |
+ Filter for skeletons with more nodes than this threshold. Removes
+ all other criteria.
+ |
+ query |
+
+ integer
+
+
+ |
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Get the cable length of a set of skeletons.
+ POST /{project_id}/skeletons/cable-length
+ Tags:
+ skeletons
+
+
+
+ Get the cable length of a set of skeletons.
+ Returns a mapping from skeleton ID to cable length.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ Project of landmark
+ |
+ path |
+
+ integer
+
+
+ |
+
+
+ |
+
+
+ |
+ skeleton_ids[]
+ |
+ IDs of the skeletons whose partners to find
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Get a compact treenode representation of a list of skeletons, optionally
+ POST /{project_id}/skeletons/compact-detail
+ Tags:
+ skeletons
+
+
+
+ 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.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+
+ |
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ with_connectors
+ |
+ Whether linked connectors should be returned.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ with_tags
+ |
+ Whether tags should be returned.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ with_history
+ |
+ Whether history information should be returned for each treenode and connector.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ with_merge_history
+ |
+ Whether the history of arbors merged into the requested skeleton should be returned. Only used if history is returned.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ with_reviews
+ |
+ Whether a node index should be returned that maps node IDs to the
+ list of reviews done on them, respects history parameter.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ with_annotations
+ |
+ Whether the list of linked annotations should be returned. If history
+ should be returned, returns all link versions.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ with_user_info
+ |
+ Whether all result elements should contain also the creator ID.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Get a synaptic graph between skeletons compartmentalized by confidence.
+ POST /{project_id}/skeletons/confidence-compartment-subgraph
+ Tags:
+ skeletons
+
+
+
+ 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 #}.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ skeleton_ids[]
+ |
+ IDs of the skeletons to graph
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+ |
+ confidence_threshold
+ |
+ Confidence value below which to segregate compartments
+ |
+ formData |
+
+ integer
+
+
+ |
+
+ |
+
+
+ |
+ bandwidth
+ |
+ Bandwidth in nanometers
+ |
+ formData |
+
+ number
+
+
+ |
+
+ |
+
+
+ |
+ cable_spread
+ |
+ Cable spread in nanometers
+ |
+ formData |
+
+ number
+
+
+ |
+
+ |
+
+
+ |
+ expand[]
+ |
+ IDs of the skeletons to expand
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+ |
+
+
+ |
+ link_types[]
+ |
+ IDs of link types to respect
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Retrieve a list of down/up-stream partners of a set of skeletons.
+ POST /{project_id}/skeletons/connectivity
+ Tags:
+ skeletons
+
+
+
+ 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.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ source_skeleton_ids[]
+ |
+ IDs of the skeletons whose partners to find
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+ |
+ boolean_op
+ |
+ Whether to find partners of any source skeleton ("OR") or partners
+ common to all source skeletons ("AND")
+ |
+ formData |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ with_nodes
+ |
+ Whether to return detailed connectivity information that includes
+ partner sites.
+ |
+ formData |
+
+ voolean
+
+
+ |
+
+ |
+
+
+ |
+ link_types,
+ |
+ A list of allowed link types: incoming, outgoing, abutting,
+ gapjunction, tightjunction, desmosome, attachment, close_object.
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Get the number of synapses per type for r a set of skeletons.
+ GET /{project_id}/skeletons/connectivity-counts
+ Tags:
+ skeletons
+
+
+
+ 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.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ Project of work in
+ |
+ path |
+
+ integer
+
+
+ |
+
+
+ |
+
+
+ |
+ count_partner_links
+ |
+ Whether to count partner links or links to a connector.
+ |
+ path |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ source_relations[]
+ |
+ A list of pre-connector relations that have to be used
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+ |
+
+
+ |
+ target_relations[]
+ |
+ A list of post-connector relations that have to be used
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+ |
+
+
+ |
+ skeleton_ids[]
+ |
+ IDs of the skeletons whose partners to count
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+ Get the number of synapses per type for r a set of skeletons.
+ POST /{project_id}/skeletons/connectivity-counts
+ Tags:
+ skeletons
+
+
+
+ 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.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ Project of work in
+ |
+ path |
+
+ integer
+
+
+ |
+
+
+ |
+
+
+ |
+ count_partner_links
+ |
+ Whether to count partner links or links to a connector.
+ |
+ path |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ source_relations[]
+ |
+ A list of pre-connector relations that have to be used
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+ |
+
+
+ |
+ target_relations[]
+ |
+ A list of post-connector relations that have to be used
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+ |
+
+
+ |
+ skeleton_ids[]
+ |
+ IDs of the skeletons whose partners to count
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Return a CSV file that represents the connectivity matrix of a set of row
+ POST /{project_id}/skeletons/connectivity_matrix/csv
+ Tags:
+ skeletons
+
+
+
+ Return a CSV file that represents the connectivity matrix of a set of row
+ skeletons and a set of column skeletons.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ Project of skeletons
+ |
+ path |
+
+ integer
+
+
+ |
+
+
+ |
+
+
+ |
+ rows
+ |
+ IDs of row skeletons
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+ |
+ columns
+ |
+ IDs of column skeletons
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Import a neuron modeled by a skeleton from an uploaded file.
+ POST /{project_id}/skeletons/import
+ Tags:
+ skeletons
+
+
+
+ Import a neuron modeled by a skeleton from an uploaded file.
+ Currently only SWC representation is supported.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+ A skeleton representation file to import.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ neuron_id
+ |
+ If specified, the imported skeleton will model this existing neuron.
+ |
+ formData |
+
+ integer
+
+
+ |
+
+ |
+
+
+ |
+ name
+ |
+ If specified, the name of a new neuron will be set to this.
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Get a list of all skeletons that intersect with the passed in bounding
+ GET /{project_id}/skeletons/in-bounding-box
+ Tags:
+ skeletons
+
+
+
+ Get a list of all skeletons that intersect with the passed in bounding
+ box. Optionally, only a subsed of passed in skeletons can be tested against.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ limit
+ |
+ Limit the number of returned nodes.
+ |
+ formData |
+
+ integer
+
+
+ |
+
+ |
+
+
+ |
+ minx
+ |
+ Minimum world space X coordinate
+ |
+ formData |
+
+ float
+
+
+ |
+
+
+ |
+
+
+ |
+ miny
+ |
+ Minimum world space Y coordinate
+ |
+ formData |
+
+ float
+
+
+ |
+
+
+ |
+
+
+ |
+ minz
+ |
+ Minimum world space Z coordinate
+ |
+ formData |
+
+ float
+
+
+ |
+
+
+ |
+
+
+ |
+ maxx
+ |
+ Maximum world space X coordinate
+ |
+ formData |
+
+ float
+
+
+ |
+
+
+ |
+
+
+ |
+ maxy
+ |
+ Maximum world space Y coordinate
+ |
+ formData |
+
+ float
+
+
+ |
+
+
+ |
+
+
+ |
+ maxz
+ |
+ Maximum world space Z coordinate
+ |
+ formData |
+
+ float
+
+
+ |
+
+
+ |
+
+
+ |
+ min_nodes
+ |
+ A minimum number of nodes per result skeleton
+ |
+ formData |
+
+ float
+
+
+ |
+
+ |
+
+
+ |
+ min_cable
+ |
+ A minimum number of cable length per result skeleton
+ |
+ formData |
+
+ float
+
+
+ |
+
+ |
+
+
+ |
+ volume_id
+ |
+ Alternative to manual bounding box definition. The bounding box of the
+ volume is used.
+ |
+ formData |
+
+ integer
+
+
+ |
+
+ |
+
+
+ |
+ skeleton_ids
+ |
+ An optional list of skeleton IDs that should only be tested againt. If
+ used, the result will only contain skeletons of this set.
+ |
+ formData |
+
+ string[]
+
+
+ |
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+ Get a list of all skeletons that intersect with the passed in bounding
+ POST /{project_id}/skeletons/in-bounding-box
+ Tags:
+ skeletons
+
+
+
+ Get a list of all skeletons that intersect with the passed in bounding
+ box. Optionally, only a subsed of passed in skeletons can be tested against.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ limit
+ |
+ Limit the number of returned nodes.
+ |
+ formData |
+
+ integer
|
@@ -10071,66 +13312,172 @@ GET /{projec
| formData |
- float
+ float
+
+
+ |
+
+
+ |
+
+
+ |
+ min_nodes
+ |
+ A minimum number of nodes per result skeleton
+ |
+ formData |
+
+ float
+
+
+ |
+
+ |
+
+
+ |
+ min_cable
+ |
+ A minimum number of cable length per result skeleton
+ |
+ formData |
+
+ float
+
+
+ |
+
+ |
+
+
+ |
+ volume_id
+ |
+ Alternative to manual bounding box definition. The bounding box of the
+ volume is used.
+ |
+ formData |
+
+ integer
|
-
|
|
- min_nodes
+ skeleton_ids
|
- A minimum number of nodes per result skeleton
+ | An optional list of skeleton IDs that should only be tested againt. If
+ used, the result will only contain skeletons of this set.
|
formData |
- float
+ string[]
|
|
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Return relationship between label IDs and skeleton IDs
+ GET /{project_id}/skeletons/node-labels
+ Tags:
+ skeletons
+
+
+
+ Return relationship between label IDs and skeleton IDs
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
|
- min_cable
+ project_id
|
- A minimum number of cable length per result skeleton
- |
- formData |
+ |
+ path |
- float
+ string
|
+
|
|
- volume_id
+ label_ids[]
|
- Alternative to manual bounding box definition. The bounding box of the
- volume is used.
+ | IDs of the labels to find skeletons associated with
|
formData |
- integer
+ string[]
|
+
|
|
- skeleton_ids
+ label_names[]
|
- An optional list of skeleton IDs that should only be tested againt. If
- used, the result will only contain skeletons of this set.
+ | Alternative to label_ids to pass in a list label names.
|
formData |
@@ -10139,6 +13486,7 @@ GET /{projec
|
+
|
@@ -10168,17 +13516,16 @@ GET /{projec
-
+
- Get a list of all skeletons that intersect with the passed in bounding
- POST /{project_id}/skeletons/in-bounding-box
+ Return relationship between label IDs and skeleton IDs
+ POST /{project_id}/skeletons/node-labels
Tags:
skeletons
- Get a list of all skeletons that intersect with the passed in bounding
- box. Optionally, only a subsed of passed in skeletons can be tested against.
+ Return relationship between label IDs and skeleton IDs
@@ -10217,28 +13564,107 @@ POST /{proje
|
- limit
+ label_ids[]
|
- Limit the number of returned nodes.
+ | IDs of the labels to find skeletons associated with
|
formData |
- integer
+ string[]
|
+
|
|
- minx
+ label_names[]
|
- Minimum world space X coordinate
+ | Alternative to label_ids to pass in a list label names.
|
formData |
- float
+ string[]
+
+
+ |
+
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Retrieve the review status for a collection of skeletons.
+ POST /{project_id}/skeletons/review-status
+ Tags:
+ skeletons
+
+
+
+ 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.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
|
@@ -10248,13 +13674,13 @@ POST /{proje
|
- miny
+ skeleton_ids[]
|
- Minimum world space Y coordinate
+ | IDs of the skeletons to retrieve.
|
formData |
- float
+ string[]
|
@@ -10264,45 +13690,101 @@ POST /{proje
|
- minz
+ whitelist
|
- Minimum world space Z coordinate
+ | ID of the user whose reviewer team to use to filter reviews
+ (exclusive to user_ids)
|
formData |
- float
+ integer
|
-
|
|
- maxx
+ user_ids[]
|
- Maximum world space X coordinate
+ | IDs of the users whose reviews should be counted (exclusive
+ to whitelist)
|
formData |
- float
+ string[]
|
-
|
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Get the number of samplers associated with each skeleton in the passed in
+ POST /{project_id}/skeletons/sampler-count
+ Tags:
+ skeletons
+
+
+
+ Get the number of samplers associated with each skeleton in the passed in
+ last.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
|
- maxy
+ project_id
|
- Maximum world space Y coordinate
+ | Project of skeleton
|
- formData |
+ path |
- float
+ integer
|
@@ -10312,13 +13794,13 @@ POST /{proje
|
- maxz
+ skeleton_ids
|
- Maximum world space Z coordinate
+ | IDs of the skeleton to get the sampler count for.
|
- formData |
+ path |
- float
+ string[]
|
@@ -10326,42 +13808,103 @@ POST /{proje
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Find skeletons within a given L-infinity distance of a treenode.
+ POST /{project_id}/skeletons/within-spatial-distance
+ Tags:
+ skeletons
+
+
+
+ Find skeletons within a given L-infinity distance of a treenode.
+ Returns at most 100 results.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
|
- min_nodes
+ project_id
|
- A minimum number of nodes per result skeleton
- |
- formData |
+ |
+ path |
- float
+ string
|
+
|
|
- min_cable
+ treenode_id
|
- A minimum number of cable length per result skeleton
+ | ID of the origin treenode to search around
|
formData |
- float
+ integer
|
+
|
|
- volume_id
+ distance
|
- Alternative to manual bounding box definition. The bounding box of the
- volume is used.
+ | L-infinity distance in nanometers within which to search
|
formData |
@@ -10374,14 +13917,14 @@ POST /{proje
|
|
- skeleton_ids
+ size_mode
|
- An optional list of skeleton IDs that should only be tested againt. If
- used, the result will only contain skeletons of this set.
+ | Whether to return skeletons with only one node in the search area
+ (1) or more than one node in the search area (0).
|
formData |
- string[]
+ integer
|
@@ -10416,26 +13959,21 @@ POST /{proje
-
-
+
+
- Return relationship between label IDs and skeleton IDs
- POST /{project_id}/skeletons/node-labels
+ Get the cable length for a skeleton
+ GET /{project_id}/skeletons/{skeleton_id}/cable-length
Tags:
skeletons
- Return relationship between label IDs and skeleton IDs
+ Get the cable length for a skeleton
-
-
-
- application/x-www-form-urlencoded
-
-
+
@@ -10450,12 +13988,13 @@ POST /{proje
|
- project_id
+ skeleton_id
|
- |
+ IDs of the skeleton to get the cable length for
+ |
path |
- string
+ integer
|
@@ -10465,13 +14004,13 @@ POST /{proje
|
- label_ids[]
+ project_id
|
- IDs of the labels to find skeletons associated with
+ | Project of landmark
|
- formData |
+ path |
- string[]
+ integer
|
@@ -10486,11 +14025,11 @@ POST /{proje
- -
- 201 Created
+
-
+ 200 OK
- -
+
-
@@ -10507,20 +14046,36 @@ POST /{proje
-
-
+
+
- Retrieve the review status for a collection of skeletons.
- POST /{project_id}/skeletons/review-status
+ Get a compact treenode representation of a skeleton, optionally with the
+ GET /{project_id}/skeletons/{skeleton_id}/compact-detail
Tags:
skeletons
- 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.
+ 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.
@@ -10544,45 +14099,122 @@ POST /{proje
|
- project_id
+ skeleton_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ project_id
+ |
+ |
+ path |
+
+ string
+
+
+ |
+
+
+ |
+
+
+ |
+ with_connectors
+ |
+ Whether linked connectors should be returned.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ with_tags
+ |
+ Whether tags should be returned.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ with_history
+ |
+ Whether history information should be returned for each treenode and
+ connector.
+ |
+ formData |
+
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ with_merge_history
|
- |
- path |
+ Whether the history of arbors merged into the requested skeleton should
+ be returned. Only used if history is returned.
+ |
+ formData |
- string
+ boolean
|
-
|
|
- skeleton_ids[]
+ with_reviews
|
- IDs of the skeletons to retrieve.
+ | Whether a node index should be returned that maps node IDs to the
+ list of reviews done on them, respects history parameter.
|
formData |
- string[]
+ boolean
|
-
|
|
- whitelist
+ with_annotations
|
- ID of the user whose reviewer team to use to filter reviews
- (exclusive to user_ids)
+ | Whether the list of linked annotations should be returned. If history
+ should be returned, returns all link versions.
|
formData |
- integer
+ boolean
|
@@ -10591,14 +14223,28 @@ POST /{proje
|
- user_ids[]
+ with_user_info
|
- IDs of the users whose reviews should be counted (exclusive
- to whitelist)
+ | Whether all result elements should contain also the creator ID.
|
formData |
- string[]
+ boolean
+
+
+ |
+
+ |
+
+
+ |
+ ordered
+ |
+ Whether result skeletons should be ordered by ID.
+ |
+ formData |
+
+ boolean
|
@@ -10612,11 +14258,11 @@ POST /{proje
- -
- 201 Created
+
-
+ 200 OK
- -
+
-
@@ -10633,18 +14279,20 @@ POST /{proje
-
-
+
+
- Find skeletons within a given L-infinity distance of a treenode.
- POST /{project_id}/skeletons/within-spatial-distance
+ List nodes in a skeleton with labels matching a query.
+ POST /{project_id}/skeletons/{skeleton_id}/find-labels
Tags:
skeletons
- Find skeletons within a given L-infinity distance of a treenode.
- Returns at most 100 results.
+ 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.
@@ -10668,7 +14316,7 @@ POST /{proje
|
- project_id
+ skeleton_id
|
|
path |
@@ -10683,13 +14331,12 @@ POST /{proje
|
- treenode_id
+ project_id
|
- ID of the origin treenode to search around
- |
- formData |
+ |
+ path |
- integer
+ string
|
@@ -10699,9 +14346,9 @@ POST /{proje
|
- distance
+ treenode_id
|
- L-infinity distance in nanometers within which to search
+ | ID of the origin treenode for path length distances
|
formData |
@@ -10710,22 +14357,23 @@ POST /{proje
|
+
|
|
- size_mode
+ label_regex
|
- Whether to return skeletons with only one node in the search area
- (1) or more than one node in the search area (0).
+ | Regular expression query to match labels
|
formData |
- integer
+ string
|
+
|
@@ -10756,17 +14404,17 @@ POST /{proje
-
-
+
+
- Get the cable length for a skeleton
- GET /{project_id}/skeletons/{skeleton_id}/cable-length
+ Export a morphology-only skeleton in neuroglancer's binary format.
+ GET /{project_id}/skeletons/{skeleton_id}/neuroglancer
Tags:
skeletons
- Get the cable length for a skeleton
+ Export a morphology-only skeleton in neuroglancer's binary format.
@@ -10787,11 +14435,10 @@ GET /{projec
|
skeleton_id
|
- IDs of the skeleton to get the cable length for
- |
+ |
path |
- integer
+ string
|
@@ -10803,11 +14450,10 @@ GET /{projec
|
project_id
|
- Project of landmark
- |
+ |
path |
- integer
+ string
|
@@ -10843,45 +14489,21 @@ GET /{projec
-
-
+
+
- Get a compact treenode representation of a skeleton, optionally with the
- GET /{project_id}/skeletons/{skeleton_id}/compact-detail
+ Get information on a skeleton's treenodes, reviews and labels.
+ GET /{project_id}/skeletons/{skeleton_id}/node-overview
Tags:
skeletons
- 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.
+ Get information on a skeleton's treenodes, reviews and labels.
-
-
-
- application/x-www-form-urlencoded
-
-
+
@@ -10898,10 +14520,11 @@ GET /{projec
|
skeleton_id
|
- |
+ The skeleton to get information on
+ |
path |
- string
+ integer
|
@@ -10913,10 +14536,11 @@ GET /{projec
|
project_id
|
- |
+ The project to operate in
+ |
path |
- string
+ integer
|
@@ -10924,113 +14548,117 @@ GET /{projec
+
+
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ List open leaf nodes in a skeleton.
+ POST /{project_id}/skeletons/{skeleton_id}/open-leaves
+ Tags:
+ skeletons
+
+
+
+ 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.
+
+
+
+
+
+
+ application/x-www-form-urlencoded
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
|
- with_connectors
- |
- Whether linked connectors should be returned.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_tags
- |
- Whether tags should be returned.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_history
- |
- Whether history information should be returned for each treenode and
- connector.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_merge_history
- |
- Whether the history of arbors merged into the requested skeleton should
- be returned. Only used if history is returned.
- |
- formData |
-
- boolean
-
-
- |
-
- |
-
-
- |
- with_reviews
+ skeleton_id
|
- Whether a node index should be returned that maps node IDs to the
- list of reviews done on them, respects history parameter.
- |
- formData |
+ |
+ path |
- boolean
+ string
|
+
|
|
- with_annotations
+ project_id
|
- Whether the list of linked annotations should be returned. If history
- should be returned, returns all link versions.
- |
- formData |
+ |
+ path |
- boolean
+ string
|
+
|
|
- with_user_info
+ treenode_id
|
- Whether all result elements should contain also the creator ID.
+ | ID of the origin treenode for path length distances
|
formData |
- boolean
+ integer
|
+
|
@@ -11040,11 +14668,11 @@ GET /{projec
- -
- 200 OK
+
-
+ 201 Created
- -
+
-
@@ -11061,20 +14689,19 @@ GET /{projec
-
-
+
+
- List nodes in a skeleton with labels matching a query.
- POST /{project_id}/skeletons/{skeleton_id}/find-labels
+ Export skeleton as a set of segments with per-node review information.
+ POST /{project_id}/skeletons/{skeleton_id}/review
Tags:
skeletons
- 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.
+ 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.
@@ -11128,13 +14755,82 @@ POST /{proje
|
- treenode_id
+ subarbor_node_id
|
- ID of the origin treenode for path length distances
+ | If provided, only the subarbor starting at this treenode is returned.
|
formData |
integer
+
+
+ |
+
+ |
+
+
+
+
+
+
+
+
+ -
+ 201 Created
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Retrieve ID and location of the skeleton's root treenode.
+ GET /{project_id}/skeletons/{skeleton_id}/root
+ Tags:
+ skeletons
+
+
+
+ Retrieve ID and location of the skeleton's root treenode.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
+
+ |
+ skeleton_id
+ |
+ |
+ path |
+
+ string
|
@@ -11144,11 +14840,10 @@ POST /{proje
|
- label_regex
+ project_id
|
- Regular expression query to match labels
- |
- formData |
+ |
+ path |
string
@@ -11165,11 +14860,11 @@ POST /{proje
- -
- 201 Created
+
-
+ 200 OK
- -
+
-
@@ -11186,17 +14881,17 @@ POST /{proje
-
-
+
+
- Export a morphology-only skeleton in neuroglancer's binary format.
- GET /{project_id}/skeletons/{skeleton_id}/neuroglancer
+ Get the number of samplers associated with this skeleton.
+ GET /{project_id}/skeletons/{skeleton_id}/sampler-count
Tags:
skeletons
- Export a morphology-only skeleton in neuroglancer's binary format.
+ Get the number of samplers associated with this skeleton.
@@ -11217,10 +14912,11 @@ GET /{projec
|
skeleton_id
|
- |
+ ID of the skeleton to get the sampler count for.
+ |
path |
- string
+ integer
|
@@ -11232,10 +14928,11 @@ GET /{projec
|
project_id
|
- |
+ Project of skeleton
+ |
path |
- string
+ integer
|
@@ -11271,24 +14968,17 @@ GET /{projec
-
-
+
+
- List open leaf nodes in a skeleton.
- POST /{project_id}/skeletons/{skeleton_id}/open-leaves
+ Get the largest skeletons based on cable length.
+ GET /{project_id}/stats/cable-length
Tags:
- skeletons
+ stats
- 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.
+ Get the largest skeletons based on cable length.
@@ -11312,7 +15002,7 @@ POST /{proje
|
- skeleton_id
+ project_id
|
|
path |
@@ -11327,28 +15017,82 @@ POST /{proje
|
- project_id
+ n_skeletoons
|
- |
- path |
+ How many skeletons should be returned
+ |
+ formData |
- string
+ integer
|
-
|
+
+ |
+
+
+
+
+
+ -
+ 200 OK
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+ Get the total number of edited nodes per user.
+ GET /{project_id}/stats/editor
+ Tags:
+ stats
+
+
+
+ Get the total number of edited nodes per user.
+
+
+
+
+
+
+
+
+ |
+ |
+ |
+ |
+ |
+
+
+
|
- treenode_id
- |
- ID of the origin treenode for path length distances
- |
- formData |
+ project_id
+
+ |
+ path |
- integer
+ string
|
@@ -11363,11 +15107,11 @@ POST /{proje
- -
- 201 Created
+
-
+ 200 OK
- -
+
-
@@ -11384,19 +15128,17 @@ POST /{proje
-
-
+
+
- Export skeleton as a set of segments with per-node review information.
- POST /{project_id}/skeletons/{skeleton_id}/review
+ Get the total number of created nodes per user.
+ GET /{project_id}/stats/nodecount
Tags:
- skeletons
+ stats
- 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.
+ Get the total number of created nodes per user.
@@ -11418,21 +15160,6 @@ POST /{proje
-
- |
- skeleton_id
- |
- |
- path |
-
- string
-
-
- |
-
-
- |
-
project_id
@@ -11450,13 +15177,13 @@ POST /{proje
|
|
- subarbor_node_id
+ with_imports
|
- If provided, only the subarbor starting at this treenode is returned.
+ | Whether data added through imports should be respected.
|
formData |
- integer
+ boolean
|
@@ -11470,11 +15197,11 @@ POST /{proje
- -
- 201 Created
+
-
+ 200 OK
- -
+
-
@@ -11491,21 +15218,30 @@ POST /{proje
-
-
+
+
- Retrieve ID and location of the skeleton's root treenode.
- GET /{project_id}/skeletons/{skeleton_id}/root
+ Get per user contribution statistics
+ GET /{project_id}/stats/user-history
Tags:
- skeletons
+ stats
- Retrieve ID and location of the skeleton's root treenode.
+ 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.
-
+
+
+
+ application/x-www-form-urlencoded
+
+
@@ -11520,7 +15256,7 @@ GET /{projec
|
- skeleton_id
+ project_id
|
|
path |
@@ -11535,17 +15271,47 @@ GET /{projec
|
- project_id
+ start_date
|
- |
- path |
+ If provided (YYYY-MM-DD), only statistics from this day on are returned (inclusive).
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ end_date
+ |
+ If provided (YYYY-MM-DD), only statistics to this day on are returned (inclusive).
+ |
+ formData |
+
+ string
+
+
+ |
+
+ |
+
+
+ |
+ time_zone
+ |
+ Optional time zone for the date range, e.g. "US/Eastern"
+ |
+ formData |
string
|
-
|
@@ -11576,21 +15342,26 @@ GET /{projec
-
- | | | | | | | | | | | |