diff --git a/sphinx-doc/source/_static/api/index.html b/sphinx-doc/source/_static/api/index.html index 3fadb14e55..7feb12b45b 100644 --- a/sphinx-doc/source/_static/api/index.html +++ b/sphinx-doc/source/_static/api/index.html @@ -453,7 +453,7 @@ -
Documentation Powered by ReDoc
Documentation Powered by ReDoc
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

Responses

Get detailed information on a connector and its partners

Get detailed information on a connector and its partners

+

Apart from the connector ID, the physical X/Y/Z location and the confidence +value (a 5-star rating, -1 means not rated), the returned object also +contains an array of all partner nodes the connector links to. Each partner +entry in this list is an object with more details on this particular partner +link. Each partner object contains the ID of the link between connector and +treenode (link_id), its confidence (5-star rating), the relation ID and name +of the link (e.g. presynaptic_to) as well as the ID of the linked treenode +(partner_id) and the skeleton it belongs to (skeleton_id).

path Parameters
project_id
required
string
connector_id
required
string

Responses

favorite

Mark this project as a favorite.

Mark this project as a favorite.

path Parameters
project_id
required
string

Responses

Delete this project as a favorite.

Delete this project as a favorite.

path Parameters
project_id
required
string

Responses

fork

Attempt to create a new project based on the passed in project ID.

Attempt to create a new project based on the passed in project ID.

@@ -1361,6 +1369,10 @@ 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.

+

The returned confidence distribution is a histogram with 5 entries, each one +representing a confidence value in the range [1,5], with 5 being the most +confident. A confidence distribution like [0,0,0,3,9] states that there are +3 links with confidence 4 and 9 links with confidence 5.

path Parameters
project_id
required
string
Request Body schema: application/x-www-form-urlencoded
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")

@@ -1679,7 +1691,35 @@ virtual nodes are suppressed.

Responses

Unsuppress a virtual treenode.

Unsuppress a virtual treenode.

path Parameters
project_id
required
string
treenode_id
required
string
suppressed_id
required
string

Responses

user-project-tokens

List project tokens available for this project and user.

List project tokens available for this project and user.

-
path Parameters
project_id
required
string

Responses

volumes

Get a collection of all available volumes.

Get a collection of all available volumes.

+
path Parameters
project_id
required
string

Responses

useranalytics

Get information on the contributions individual users made in a

Get information on the contributions individual users made in a +particular time frame. This endpoint requires admin permissions. The +returned fields all contain lists where each entry relates to one day in the +query time frame by the requested user. The fields are the following:

+
    +
  • annotation_events: how many treenodes or connector nodes where +edited/added on a given day
    • +
  • annotation_timeaxis: dates for each annotation event +
  • review_events: how many node reviews were performed on a given day
    • +review_timeaxis: dates for each review event +
  • write_events: how many write events of any form (incl. +annotations/tags/renames) where made on a given day
    • +
  • write_timeaxis: dates for each write event
    • +
  • raw_write_events: a raw list of all write events of any kind
    • +
  • active_bouts: time segments in which a user was active that had no +pauses longer than the requested activity time threshold.
    • +
  • net_active_time: the active time in hours per day between the first event of +the first active bout and the last event of the last bout.
    • +
  • netactivetime_timeaxis: dates for each net active time entry
    • +
path Parameters
project_id
required
string
Request Body schema: application/x-www-form-urlencoded
userid
string

The id of the user to get information on

+
start
string

Start date of request time frame in the form YYYY-MM-DD. Defaults +to seven days ago from today.

+
end
string

End date of request time frame in the form YYYY-MM-DD. Defaults to +today/now.

+
max_inactivity
string

Number of minutes of inactivity, before a pause is assumed.

+
all_writes
string

Whether info ann all types of write events should be returned, +including annotating neurons, renaming neurons or editing tags. +True by default.

+

Responses

volumes

Get a collection of all available volumes.

Get a collection of all available volumes.

path Parameters
project_id
required
string

Project to operate in

Request Body schema: application/x-www-form-urlencoded
volume_ids
string

Only return specified volumes

Responses

Get a collection of all available volumes.

Get a collection of all available volumes.

@@ -1780,7 +1820,7 @@
STL
volume_id
required
string

The volume to update

Responses