nodes

Retrieve all nodes intersecting a bounding box

Changed on

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}

posthttp://localhost:8000/{project_id}/nodes/

Request

Path parameters

project_idstring required

Request body application/x-www-form-urlencoded

treenode_idsstring

Whether linked connectors should be returned.

connector_idsstring

Whether tags should be returned.

limitstring

Limit the number of returned nodes.

leftstring required

Minimum world space X coordinate

topstring required

Minimum world space Y coordinate

z1string required

Minimum world space Z coordinate

rightstring required

Maximum world space X coordinate

bottomstring required

Maximum world space Y coordinate

z2string required

Maximum world space Z coordinate

formatstring

Either "json" (default) or "msgpack", optional.

with_relation_mapstring

Whether an ID to name mapping for the used relations should be included and which extent it should have.

with_originstring

Whether the origin for each skeleton should be looked up and returned. This will show which skeletons are imported.

n_largest_skeletons_limitstring

Maximum number of the largest skeletons in view

n_last_edited_skeletons_limitstring

Maximum number of most recently edited skeletons.

hidden_last_editor_idstring

No nodes edited last by this user will be retuned.

min_skeleton_lengthstring

Optional minimum skeleton length, no returned node is of a shorter skeleton.

orderstring

Either empty, cable-asc or cable-desc. Will return in a particular order. By default, no ordering is applied.

Response

Created

Changes