Skip to main content
POST
Creates a spatial annotation on a physical sample. An annotation captures a property value at a location on the sample.
string
required
UUID of the physical sample
string
required
Name of the property being annotated
number
required
Value of the annotated property
string
Coordinate reference frame. One of sample_relative or stage_absolute.
string
Units for the coordinate values
number
X coordinate of the annotation
number
Y coordinate of the annotation
number
Z coordinate of the annotation
string
Unit for the property value
string
Characterization source type
string
UUID of the data item the annotation is derived from
object
Arbitrary key-value metadata for the annotation

Response

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