CAcatmaid
annotations

Query entities based on various constraints

Changed on

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.

posthttp://localhost:8000/{project_id}/annotations/query-targets

Request

Path parameters

project_idstring required

Query parameters

annotation_date_startstring

The earliest YYYY-MM-DD date result elements have been annotated at.

annotation_date_endstring

The latest YYYY-MM-DD date result elements have been annotated at.

Request body application/x-www-form-urlencoded

namestring

The name (or a part of it) of result elements.

name_exactstring

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_sensitivestring

Whether the name has to match the exact letter case provided. False by default.

annotated_bystring

A result element was annotated by a user with this ID.

annotated_withstring

A comma separated list of annotation IDs which all annotate the result elements.

not_annotated_withstring

A comma separated list of annotation IDs which don't annotate the result elements.

sub_annotated_withstring

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_annotationsstring

Indicate if annotations of result elements should be returned.

typesstring

Allowed result types. Multple types can be passed with multiple parameters. Defaults to 'neuron' and 'annotation'.

sort_bystring

Indicates how results are sorted.

sort_dirstring

Indicates sorting direction.

range_startstring

The first result element index.

range_lengthstring

The number of results

annotation_referencestring

Whether annoation references are IDs or names, can be 'id' or 'name.

with_timestampsstring

Whether to return also the annotation time for each entity.

import_onlystring

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_nonexistingstring

Whether non-existing query annotations should be ignored instead of raising an error.

with_namestring

Whether to return the name of each entity.

with_typestring

Whether to return the type of each entity.

Response

Created

Changes