Skip to content

AnnosaurusClient data models

Generated from vars_client.generated.annosaurus.models -- every field name and type here is exactly what the client returns/accepts. Do not hand-edit this file.

AnnotationCreateSC

vars_client.generated.annosaurus.models.annotation_create_s_c.AnnotationCreateSC

Field Type
activity Optional[str]
concept Optional[str]
duration_millis Optional[int]
elapsed_time_millis Optional[int]
group Optional[str]
imaged_moment_uuid Optional[UUID]
observation_timestamp Optional[str]
observation_uuid Optional[UUID]
observer Optional[str]
recorded_timestamp Optional[str]
timecode Optional[str]
video_reference_uuid Optional[UUID]

AnnotationSC

vars_client.generated.annosaurus.models.annotation_s_c.AnnotationSC

Field Type
activity Optional[str]
ancillary_data Optional[CachedAncillaryDatumSC]
associations Optional[list[AssociationSC]]
concept Optional[str]
duration_millis Optional[int]
elapsed_time_millis Optional[int]
group Optional[str]
image_references Optional[list[ImageReferenceSC]]
imaged_moment_uuid Optional[UUID]
last_updated Optional[str]
observation_timestamp Optional[str]
observation_uuid Optional[UUID]
observer Optional[str]
recorded_timestamp Optional[str]
timecode Optional[str]
video_reference_uuid Optional[UUID]

AnnotationUpdateSC

vars_client.generated.annosaurus.models.annotation_update_s_c.AnnotationUpdateSC

Field Type
activity Optional[str]
concept Optional[str]
duration_millis Optional[int]
elapsed_time_millis Optional[int]
group Optional[str]
observation_timestamp Optional[str]
observation_uuid Optional[UUID]
observer Optional[str]
recorded_timestamp Optional[str]
timecode Optional[str]
video_reference_uuid Optional[UUID]

AssociationSC

vars_client.generated.annosaurus.models.association_s_c.AssociationSC

Field Type
imaged_moment_uuid Optional[UUID]
last_updated_time Optional[str]
link_name Optional[str]
link_value Optional[str]
mime_type Optional[str]
observation_uuid Optional[UUID]
to_concept Optional[str]
uuid Optional[UUID]

AssociationUpdateSC

vars_client.generated.annosaurus.models.association_update_s_c.AssociationUpdateSC

Field Type
link_name Optional[str]
link_value Optional[str]
mime_type Optional[str]
observation_uuid Optional[UUID]
to_concept Optional[str]

AuthorizationSC

vars_client.generated.annosaurus.models.authorization_s_c.AuthorizationSC

Field Type
access_token Optional[str]
token_type Optional[str]

BadRequest

vars_client.generated.annosaurus.models.bad_request.BadRequest

Field Type
message Optional[str]
response_code Optional[int]

BulkAnnotationSC

vars_client.generated.annosaurus.models.bulk_annotation_s_c.BulkAnnotationSC

Field Type
activity Optional[str]
ancillary_data Optional[CachedAncillaryDatumSC]
associations Optional[list[AssociationSC]]
concept Optional[str]
duration_millis Optional[int]
elapsed_time_millis Optional[int]
group Optional[str]
image_references Optional[list[ImageReferenceSC]]
imaged_moment_uuid Optional[UUID]
observation_timestamp Optional[str]
observation_uuid Optional[UUID]
observer Optional[str]
recorded_timestamp Optional[str]
timecode Optional[str]
video_reference_uuid Optional[UUID]

CachedAncillaryDatumSC

vars_client.generated.annosaurus.models.cached_ancillary_datum_s_c.CachedAncillaryDatumSC

Field Type
altitude Optional[float]
crs Optional[str]
depth_meters Optional[float]
imaged_moment_uuid Optional[UUID]
last_updated_time Optional[str]
latitude Optional[float]
light_transmission Optional[float]
longitude Optional[float]
oxygen_ml_l Optional[float]
phi Optional[float]
pose_position_units Optional[str]
pressure_dbar Optional[float]
psi Optional[float]
recorded_timestamp Optional[str]
salinity Optional[float]
temperature_celsius Optional[float]
theta Optional[float]
uuid Optional[UUID]
x Optional[float]
y Optional[float]
z Optional[float]

CachedVideoReferenceInfoCreateSC

vars_client.generated.annosaurus.models.cached_video_reference_info_create_s_c.CachedVideoReferenceInfoCreateSC

Field Type
mission_contact Optional[str]
mission_id Optional[str]
platform_name Optional[str]
video_reference_uuid Optional[UUID]

CachedVideoReferenceInfoSC

vars_client.generated.annosaurus.models.cached_video_reference_info_s_c.CachedVideoReferenceInfoSC

Field Type
last_updated Optional[str]
mission_contact Optional[str]
mission_id Optional[str]
platform_name Optional[str]
uuid Optional[UUID]
video_reference_uuid Optional[UUID]

CachedVideoReferenceInfoUpdateSC

vars_client.generated.annosaurus.models.cached_video_reference_info_update_s_c.CachedVideoReferenceInfoUpdateSC

Field Type
mission_contact Optional[str]
mission_id Optional[str]
platform_name Optional[str]
video_reference_uuid Optional[UUID]

ConceptAssociationRequest

vars_client.generated.annosaurus.models.concept_association_request.ConceptAssociationRequest

Field Type
link_name Optional[str]
video_reference_uuids Optional[list[UUID]]

ConceptAssociationRequestSC

vars_client.generated.annosaurus.models.concept_association_request_s_c.ConceptAssociationRequestSC

Field Type
link_name Optional[str]
video_reference_uuids Optional[list[UUID]]

ConceptAssociationResponseSC

vars_client.generated.annosaurus.models.concept_association_response_s_c.ConceptAssociationResponseSC

Field Type
concept_association_request Optional[ConceptAssociationRequestSC]
concept_associations Optional[list[ConceptAssociationSC]]

ConceptAssociationSC

vars_client.generated.annosaurus.models.concept_association_s_c.ConceptAssociationSC

Field Type
concept Optional[str]
link_name Optional[str]
link_value Optional[str]
mime_type Optional[str]
to_concept Optional[str]
uuid Optional[UUID]
video_reference_uuid Optional[UUID]

ConceptCount

vars_client.generated.annosaurus.models.concept_count.ConceptCount

Field Type
concept Optional[str]
count Optional[int]

ConcurrentRequest

vars_client.generated.annosaurus.models.concurrent_request.ConcurrentRequest

Field Type
end_timestamp Optional[str]
start_timestamp Optional[str]
video_reference_uuids Optional[list[UUID]]

ConcurrentRequestCountSC

vars_client.generated.annosaurus.models.concurrent_request_count_s_c.ConcurrentRequestCountSC

Field Type
concurrent_request Optional[ConcurrentRequestSC]
count Optional[int]

ConcurrentRequestSC

vars_client.generated.annosaurus.models.concurrent_request_s_c.ConcurrentRequestSC

Field Type
end_timestamp Optional[str]
start_timestamp Optional[str]
video_reference_uuids Optional[list[UUID]]

ConstraintRequest

vars_client.generated.annosaurus.models.constraint_request.ConstraintRequest

Field Type
between Optional[list[str]]
column Optional[str]
contains Optional[str]
equals Optional[str]
in_ Optional[list[str]]
isnull Optional[bool]
like Optional[str]
max Optional[float]
min Optional[float]
minmax Optional[list[float]]
notlike Optional[str]

Count

vars_client.generated.annosaurus.models.count.Count

Field Type
count Optional[int]

CountForVideoReferenceSC

vars_client.generated.annosaurus.models.count_for_video_reference_s_c.CountForVideoReferenceSC

Field Type
count Optional[int]
video_reference_uuid Optional[UUID]

DeleteCountSC

vars_client.generated.annosaurus.models.delete_count_s_c.DeleteCountSC

Field Type
ancillary_data_count Optional[int]
association_count Optional[int]
error_message Optional[str]
image_reference_count Optional[int]
imaged_moment_count Optional[int]
observation_count Optional[int]
video_reference_uuid Optional[UUID]

DepthHistogramSC

vars_client.generated.annosaurus.models.depth_histogram_s_c.DepthHistogramSC

Field Type
bins_max Optional[list[int]]
bins_min Optional[list[int]]
values Optional[list[int]]

GeographicRangeSC

vars_client.generated.annosaurus.models.geographic_range_s_c.GeographicRangeSC

Field Type
max_depth_meters Optional[float]
max_latitude Optional[float]
max_longitude Optional[float]
min_depth_meters Optional[float]
min_latitude Optional[float]
min_longitude Optional[float]

HealthStatus

vars_client.generated.annosaurus.models.health_status.HealthStatus

Field Type
application Optional[str]
available_processors Optional[int]
description Optional[str]
free_memory Optional[int]
jdk_version Optional[str]
max_memory Optional[int]
total_memory Optional[int]
version Optional[str]

ImageCreateSC

vars_client.generated.annosaurus.models.image_create_s_c.ImageCreateSC

Field Type
description Optional[str]
elapsed_time_millis Optional[int]
format Optional[str]
height_pixels Optional[int]
recorded_timestamp Optional[str]
timecode Optional[str]
url Optional[str]
video_reference_uuid Optional[UUID]
width_pixels Optional[int]

ImageReferenceSC

vars_client.generated.annosaurus.models.image_reference_s_c.ImageReferenceSC

Field Type
description Optional[str]
format Optional[str]
height_pixels Optional[int]
imaged_moment_uuid Optional[UUID]
last_updated_time Optional[str]
url Optional[str]
uuid Optional[UUID]
width_pixels Optional[int]

ImageSC

vars_client.generated.annosaurus.models.image_s_c.ImageSC

Field Type
description Optional[str]
elapsed_time_millis Optional[int]
format Optional[str]
height_pixels Optional[int]
image_reference_uuid Optional[UUID]
imaged_moment_uuid Optional[UUID]
recorded_timestamp Optional[str]
timecode Optional[str]
url Optional[str]
video_reference_uuid Optional[UUID]
width_pixels Optional[int]

ImageUpdateSC

vars_client.generated.annosaurus.models.image_update_s_c.ImageUpdateSC

Field Type
description Optional[str]
elapsed_time_millis Optional[int]
format Optional[str]
height_pixels Optional[int]
recorded_timestamp Optional[str]
timecode Optional[str]
url Optional[str]
video_reference_uuid Optional[UUID]
width_pixels Optional[int]

ImagedMomentSC

vars_client.generated.annosaurus.models.imaged_moment_s_c.ImagedMomentSC

Field Type
ancillary_data Optional[CachedAncillaryDatumSC]
elapsed_time_millis Optional[int]
image_references Optional[list[ImageReferenceSC]]
last_updated_time Optional[str]
observations Optional[list[ObservationSC]]
recorded_timestamp Optional[str]
timecode Optional[str]
uuid Optional[UUID]
video_reference_uuid Optional[UUID]

ImagedMomentTimestampUpdateSC

vars_client.generated.annosaurus.models.imaged_moment_timestamp_update_s_c.ImagedMomentTimestampUpdateSC

Field Type
annotation_count Optional[int]
timestamps_updated Optional[int]

IndexSC

vars_client.generated.annosaurus.models.index_s_c.IndexSC

Field Type
elapsed_time_millis Optional[int]
last_updated Optional[str]
recorded_timestamp Optional[str]
timecode Optional[str]
uuid Optional[UUID]
video_reference_uuid Optional[UUID]

IndexUpdateSC

vars_client.generated.annosaurus.models.index_update_s_c.IndexUpdateSC

Field Type
elapsed_time_millis Optional[int]
recorded_timestamp Optional[str]
timecode Optional[str]
uuid Optional[UUID]

Metadata

vars_client.generated.annosaurus.models.metadata.Metadata

Field Type
column_class_name Optional[str]
column_label Optional[str]
column_name Optional[str]
column_size Optional[int]
column_type Optional[str]

MoveImagedMoments

vars_client.generated.annosaurus.models.move_imaged_moments.MoveImagedMoments

Field Type
imaged_moment_uuids Optional[list[UUID]]
video_reference_start_timestamp Optional[str]
video_reference_uuid Optional[UUID]

MultiRequest

vars_client.generated.annosaurus.models.multi_request.MultiRequest

Field Type
video_reference_uuids Optional[list[UUID]]

MultiRequestCountSC

vars_client.generated.annosaurus.models.multi_request_count_s_c.MultiRequestCountSC

Field Type
count Optional[int]
multi_request Optional[MultiRequestSC]

MultiRequestSC

vars_client.generated.annosaurus.models.multi_request_s_c.MultiRequestSC

Field Type
video_reference_uuids Optional[list[UUID]]

NotFound

vars_client.generated.annosaurus.models.not_found.NotFound

Field Type
message Optional[str]
response_code Optional[int]

ObservationSC

vars_client.generated.annosaurus.models.observation_s_c.ObservationSC

Field Type
activity Optional[str]
associations Optional[list[AssociationSC]]
concept Optional[str]
duration_millis Optional[int]
group Optional[str]
last_updated_time Optional[str]
observation_timestamp Optional[str]
observer Optional[str]
uuid Optional[UUID]

ObservationUpdateSC

vars_client.generated.annosaurus.models.observation_update_s_c.ObservationUpdateSC

Field Type
activity Optional[str]
concept Optional[str]
duration_millis Optional[int]
group Optional[str]
imaged_moment_uuid Optional[UUID]
observation_timestamp Optional[str]
observer Optional[str]

ObservationsUpdate

vars_client.generated.annosaurus.models.observations_update.ObservationsUpdate

Field Type
activity Optional[str]
concept Optional[str]
group Optional[str]
observation_uuids Optional[list[UUID]]
observer Optional[str]

QueryConstraints

vars_client.generated.annosaurus.models.query_constraints.QueryConstraints

Field Type
activities Optional[list[str]]
concepts Optional[list[str]]
data Optional[bool]
groups Optional[list[str]]
limit Optional[int]
link_name Optional[str]
link_value Optional[str]
max_depth Optional[float]
max_lat Optional[float]
max_lon Optional[float]
max_timestamp Optional[str]
min_depth Optional[float]
min_lat Optional[float]
min_lon Optional[float]
min_timestamp Optional[str]
mission_contacts Optional[list[str]]
mission_id Optional[str]
observers Optional[list[str]]
offset Optional[int]
platform_name Optional[str]
video_reference_uuids Optional[list[UUID]]

QueryConstraintsResponseSC_Count

vars_client.generated.annosaurus.models.query_constraints_response_s_c_count.QueryConstraintsResponseSC_Count

Field Type
content Optional[Count]
query_constraints Optional[QueryConstraintsSC]

QueryConstraintsResponseSC_DepthHistogramSC

vars_client.generated.annosaurus.models.query_constraints_response_s_c_depth_histogram_s_c.QueryConstraintsResponseSC_DepthHistogramSC

Field Type
content Optional[DepthHistogramSC]
query_constraints Optional[QueryConstraintsSC]

QueryConstraintsResponseSC_GeographicRangeSC

vars_client.generated.annosaurus.models.query_constraints_response_s_c_geographic_range_s_c.QueryConstraintsResponseSC_GeographicRangeSC

Field Type
content Optional[GeographicRangeSC]
query_constraints Optional[QueryConstraintsSC]

QueryConstraintsResponseSC_Seq_AnnotationSC

vars_client.generated.annosaurus.models.query_constraints_response_s_c_seq_annotation_s_c.QueryConstraintsResponseSC_Seq_AnnotationSC

Field Type
content Optional[list[AnnotationSC]]
query_constraints Optional[QueryConstraintsSC]

QueryConstraintsResponseSC_TimeHistogramSC

vars_client.generated.annosaurus.models.query_constraints_response_s_c_time_histogram_s_c.QueryConstraintsResponseSC_TimeHistogramSC

Field Type
content Optional[TimeHistogramSC]
query_constraints Optional[QueryConstraintsSC]

QueryConstraintsSC

vars_client.generated.annosaurus.models.query_constraints_s_c.QueryConstraintsSC

Field Type
activities Optional[list[str]]
concepts Optional[list[str]]
data Optional[bool]
groups Optional[list[str]]
limit Optional[int]
link_name Optional[str]
link_value Optional[str]
max_depth Optional[float]
max_lat Optional[float]
max_lon Optional[float]
max_timestamp Optional[str]
min_depth Optional[float]
min_lat Optional[float]
min_lon Optional[float]
min_timestamp Optional[str]
mission_contacts Optional[list[str]]
mission_id Optional[str]
observers Optional[list[str]]
offset Optional[int]
platform_name Optional[str]
video_reference_uuids Optional[list[UUID]]

QueryRequest

vars_client.generated.annosaurus.models.query_request.QueryRequest

Field Type
concurrent_observations Optional[bool]
distinct Optional[bool]
limit Optional[int]
offset Optional[int]
order_by Optional[list[str]]
related_associations Optional[bool]
select Optional[list[str]]
strict Optional[bool]
where Optional[list[ConstraintRequest]]

RenameConcept

vars_client.generated.annosaurus.models.rename_concept.RenameConcept

Field Type
new Optional[str]
old Optional[str]

RenameCountSC

vars_client.generated.annosaurus.models.rename_count_s_c.RenameCountSC

Field Type
count Optional[int]
new_concept Optional[str]
old_concept Optional[str]

ServerError

vars_client.generated.annosaurus.models.server_error.ServerError

Field Type
message Optional[str]
response_code Optional[int]

TimeHistogramSC

vars_client.generated.annosaurus.models.time_histogram_s_c.TimeHistogramSC

Field Type
bins_max Optional[list[str]]
bins_min Optional[list[str]]
values Optional[list[int]]

Unauthorized

vars_client.generated.annosaurus.models.unauthorized.Unauthorized

Field Type
message Optional[str]
response_code Optional[int]

VideoTimestampSC

vars_client.generated.annosaurus.models.video_timestamp_s_c.VideoTimestampSC

Field Type
elapsed_time_millis Optional[int]
recorded_timestamp Optional[str]
timecode Optional[str]
video_reference_uuid Optional[UUID]

WindowRequestSC

vars_client.generated.annosaurus.models.window_request_s_c.WindowRequestSC

Field Type
imaged_moment_uuid Optional[UUID]
video_reference_uuids Optional[list[UUID]]
window_millis Optional[int]