Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::NodeQueryParams Struct Reference

Query parameters for the GET /datastorage/nodes endpoint. More...

#include <mitkNodeQueryParams.h>

Collaboration diagram for mitk::NodeQueryParams:

Public Attributes

int limit
 Maximum number of results to return (valid range: 1–1000). More...
 
int offset
 Number of results to skip for pagination. More...
 
Hierarchy hierarchy
 Hierarchy filter mode. More...
 
std::optional< std::string > path
 Filter by path-based lookup. More...
 
std::optional< std::string > dataType
 Filter by MITK data type name. More...
 
std::optional< std::string > parentUid
 Filter by parent node UID (use "null" for root nodes). More...
 
std::vector< PropertyFilter > propertyFilters
 Property-based filter criteria. More...
 
std::optional< std::string > context
 Renderer context name for property lookups. More...
 
PropertyScope propertyScope
 Scope for property filter evaluation. More...
 
std::vector< std::string > fields
 Fields to include in the response (empty means all fields). More...
 
std::optional< SortSpec > sort
 Optional sort specification. More...
 

Detailed Description

Query parameters for the GET /datastorage/nodes endpoint.

Encapsulates all supported query parameters including pagination, hierarchy filtering, system field filters, property filters, field selection, and sorting.

See also
DataStorageBridge::GetNodes, PropertyFilter, SortSpec, Hierarchy

Definition at line 95 of file mitkNodeQueryParams.h.

Member Data Documentation

◆ context

std::optional<std::string> mitk::NodeQueryParams::context

Renderer context name for property lookups.

Definition at line 108 of file mitkNodeQueryParams.h.

◆ dataType

std::optional<std::string> mitk::NodeQueryParams::dataType

Filter by MITK data type name.

Definition at line 103 of file mitkNodeQueryParams.h.

◆ fields

std::vector<std::string> mitk::NodeQueryParams::fields

Fields to include in the response (empty means all fields).

Definition at line 111 of file mitkNodeQueryParams.h.

◆ hierarchy

Hierarchy mitk::NodeQueryParams::hierarchy

Hierarchy filter mode.

Definition at line 100 of file mitkNodeQueryParams.h.

◆ limit

int mitk::NodeQueryParams::limit

Maximum number of results to return (valid range: 1–1000).

Definition at line 97 of file mitkNodeQueryParams.h.

◆ offset

int mitk::NodeQueryParams::offset

Number of results to skip for pagination.

Definition at line 98 of file mitkNodeQueryParams.h.

◆ parentUid

std::optional<std::string> mitk::NodeQueryParams::parentUid

Filter by parent node UID (use "null" for root nodes).

Definition at line 104 of file mitkNodeQueryParams.h.

◆ path

std::optional<std::string> mitk::NodeQueryParams::path

Filter by path-based lookup.

Definition at line 102 of file mitkNodeQueryParams.h.

◆ propertyFilters

std::vector<PropertyFilter> mitk::NodeQueryParams::propertyFilters

Property-based filter criteria.

Definition at line 106 of file mitkNodeQueryParams.h.

◆ propertyScope

PropertyScope mitk::NodeQueryParams::propertyScope

Scope for property filter evaluation.

Definition at line 109 of file mitkNodeQueryParams.h.

◆ sort

std::optional<SortSpec> mitk::NodeQueryParams::sort

Optional sort specification.

Definition at line 113 of file mitkNodeQueryParams.h.


The documentation for this struct was generated from the following file: