Skip to main content
GET
Returns the spatial annotations recorded on a physical sample. Use the query parameters to filter by property, characterization source, or a spatial bounding box.
string
required
UUID of the physical sample
string
Filter to annotations with this property name
string
Filter to annotations from this characterization source type
number
Lower bound on the x coordinate for spatial filtering
number
Upper bound on the x coordinate for spatial filtering
number
Lower bound on the y coordinate for spatial filtering
number
Upper bound on the y coordinate for spatial filtering

Response

Returns an array of spatial annotation objects.
string
Annotation UUID
string
UUID of the physical sample the annotation belongs to
string
Name of the annotated property
number
Value of the annotated property
string
Unit for the property value, or null if not set
string
Characterization source type, or null if not set
string
Coordinate reference frame. One of sample_relative or stage_absolute.
string
Units for the coordinate values, or null if not set
number
X coordinate of the annotation, or null if not set
number
Y coordinate of the annotation, or null if not set
number
Z coordinate of the annotation, or null if not set
string
UUID of the data item the annotation is derived from, or null if not set
object
Arbitrary key-value metadata, or null if not set
string
ISO 8601 timestamp of the last update
string
Version string of the annotation record