namestring required
The name assigned to the new annotation.
descriptionstring
A short description about the new annotation.
startTimestring date-time required
When the annotation starts.
endTimestring date-time required
When the annotation ends.
assetsstring[]
The names of the assets to associate with this annotation.
tagsstring[]
The names of the tags to apply as label metadata. Tags do not satisfy the
run/asset/channel association requirement.
runIdstring
The ID of the run that this annotation is associated with.
assignToUserIdstring
The ID of the user that this annotation is assigned to.
organizationIdstring
The organization associated with this annotation. An organization ID is only required
if the user belongs to multiple organizations.
state'ANNOTATION_STATE_UNSPECIFIED' | 'ANNOTATION_STATE_OPEN' | 'ANNOTATION_STATE_FLAGGED' | 'ANNOTATION_STATE_RESOLVED'
annotationType'ANNOTATION_TYPE_UNSPECIFIED' | 'ANNOTATION_TYPE_DATA_REVIEW' | 'ANNOTATION_TYPE_PHASE'
createdByConditionIdstring
The ID of the rule condition that created this annotation.
legendConfigstring
A JSON string containing the axes configuration of the annotation's linked channels.
createdByRuleConditionVersionIdstring
The ID of the rule condition version that created this annotation.