ODM2 Models

ODM2 is organized with a “core” schema and multiple “extension” schemas that extend the functionality of the core. The following sections cover some overarching concepts for ODM2 and then focus on specific entities within the ODM2 Core schema and ODM2’s extension schemas.

ODM2Core entities

The following are entities in the ODM2 Core Schema:

odm2api.models.ActionBy(**kwargs)

odm2api.models.Actions(**kwargs)

Actions are performed by people and may have a result.

odm2api.models.Affiliations(**kwargs)

odm2api.models.DataSets(**kwargs)

Enables grouping of results into a larger dataset.

odm2api.models.FeatureActions(**kwargs)

Provides flexible linkage between Actions and the SamplingFeatures on which or at which they were performed.

odm2api.models.Methods(**kwargs)

The procedure used to perform an action.

odm2api.models.Organizations(**kwargs)

A group of people.

odm2api.models.People(**kwargs)

Individuals that perform actions.

odm2api.models.ProcessingLevels(**kwargs)

Levels to which data have been quality controlled.

odm2api.models.RelatedActions(**kwargs)

Enables specifying relationships among Actions (e.g., workflows, etc.)

odm2api.models.Results(**kwargs)

The result of an action.

odm2api.models.SamplingFeatures(**kwargs)

Where or on what an action was performed.

odm2api.models.TaxonomicClassifiers(**kwargs)

Terms for classifying results.

odm2api.models.Units(**kwargs)

Units of measure.

odm2api.models.Variables(**kwargs)

What was observed.

All ODM2 models

API descriptions for all ODM2 models (entities).

class odm2api.models.ActionAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ActionID
ActionObj
AnnotationID
AnnotationObj
BridgeID
class odm2api.models.ActionBy(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ActionID
ActionObj
AffiliationID
AffiliationObj
BridgeID
IsActionLead
RoleDescription
class odm2api.models.ActionDirectives(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ActionID
ActionObj
BridgeID
DirectiveID
DirectiveObj
class odm2api.models.ActionExtensionPropertyValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ActionID
ActionObj
BridgeID
ExtensionPropertyObj
PropertyID
PropertyValue
class odm2api.models.Actions(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Actions are performed by people and may have a result.

ActionDescription
ActionID
ActionTypeCV
BeginDateTime
BeginDateTimeUTCOffset
EndDateTime
EndDateTimeUTCOffset
MethodID
MethodObj
class odm2api.models.Affiliations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AffiliationEndDate
AffiliationID
AffiliationStartDate
IsPrimaryOrganizationContact
OrganizationID
OrganizationObj
PersonID
PersonObj
PrimaryAddress
PrimaryEmail
PrimaryPhone
class odm2api.models.Annotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationCode
AnnotationDateTime
AnnotationID
AnnotationText
AnnotationTypeCV
AnnotationUTCOffset
AnnotatorID
AnnotatorObj
CitationID
CitationObj
class odm2api.models.AuthorLists(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AuthorOrder
BridgeID
CitationID
CitationObj
PersonID
PersonObj
class odm2api.models.CV[source]

Bases: object

Category = Column('category', String(length=255), table=None)
Definition = Column('definition', String(length=1000), table=None)
Name = Column('name', String(length=255), table=None, primary_key=True, nullable=False)
SourceVocabularyURI = Column('sourcevocabularyuri', String(length=255), table=None)
Term = Column('term', String(length=255), table=None, nullable=False)
class odm2api.models.CVActionType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVAggregationStatistic(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVAnnotationType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVCensorCode(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVDataQualityType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVDataSetType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVDeploymentType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVDirectiveType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVElevationDatum(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVEquipmentType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVMediumType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVMethodType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVOrganizationType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVPropertyDataType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVQualityCode(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVReferenceMaterialMedium(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVRelationshipType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVResultType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVSamplingFeatureGeoType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVSamplingFeatureType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVSiteType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVSpatialOffsetType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVSpeciation(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVSpecimenType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVStatus(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVTaxonomicClassifierType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVUnitsType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVVariableName(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CVVariableType(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base, odm2api.models.CV

Category
Definition
Name
SourceVocabularyURI
Term
class odm2api.models.CalibrationActions(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ActionID
ActionObj
CalibrationCheckValue
CalibrationEquation
InstrumentOutputVariableID
InstrumentOutputVariableObj
class odm2api.models.CalibrationReferenceEquipment(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ActionID
ActionObj
BridgeID
EquipmentID
EquipmentObj
class odm2api.models.CalibrationStandards(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ActionID
ActionObj
BridgeID
ReferenceMaterialID
ReferenceMaterialObj
class odm2api.models.CategoricalResultValueAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
ValueID
ValueObj
class odm2api.models.CategoricalResultValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

DataValue
ResultID
ResultObj
ValueDateTime
ValueDateTimeUTCOffset
ValueID
class odm2api.models.CategoricalResults(**kwargs)[source]

Bases: odm2api.models.Results

FeatureActionID
FeatureActionObj
ProcessingLevelID
ProcessingLevelObj
QualityCodeCV
ResultDateTime
ResultDateTimeUTCOffset
ResultID
ResultTypeCV
ResultUUID
SampledMediumCV
SpatialReferenceID
SpatialReferenceObj
StatusCV
TaxonomicClassifierID
TaxonomicClassifierObj
UnitsID
UnitsObj
ValidDateTime
ValidDateTimeUTCOffset
ValueCount
VariableID
VariableObj
XLocation
XLocationUnitsID
XLocationUnitsObj
YLocation
YLocationUnitsID
YLocationUnitsObj
ZLocation
ZLocationUnitsID
ZLocationUnitsObj
class odm2api.models.CitationExtensionPropertyValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
CitationID
CitationObj
ExtensionPropertyObj
PropertyID
PropertyValue
class odm2api.models.CitationExternalIdentifiers(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
CitationExternalIdentifier
CitationExternalIdentifierURI
CitationID
CitationObj
ExternalIdentifierSystemID
ExternalIdentifierSystemObj
class odm2api.models.Citations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

CitationID
PublicationYear
Publisher
Title
class odm2api.models.DataLoggerFileColumns(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AggregationStatisticCV
ColumnDescription
ColumnLabel
DataLoggerFileColumnID
DataLoggerFileID
DataLoggerFileObj
InstrumentOutputVariableID
InstrumentOutputVariableObj
MeasurementEquation
RecordingInterval
RecordingIntervalUnitsID
RecordingIntervalUnitsObj
ResultID
ResultObj
ScanInterval
ScanIntervalUnitsID
ScanIntervalUnitsObj
class odm2api.models.DataLoggerFiles(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

DataLoggerFileID
DataLoggerFileName
DataLoggerOutputFileDescription
ProgramID
ProgramObj
class odm2api.models.DataLoggerProgramFiles(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AffiliationID
AffiliationObj
ProgramDescription
ProgramID
ProgramName
ProgramVersion
class odm2api.models.DataQuality(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

DataQualityCode
DataQualityDescription
DataQualityID
DataQualityTypeCV
DataQualityValue
DataQualityValueUnitsID
UnitObj
class odm2api.models.DataSetCitations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
CitationID
CitationObj
DataSetID
DataSetObj
RelationshipTypeCV
class odm2api.models.DataSets(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Enables grouping of results into a larger dataset.

DataSetAbstract
DataSetCode
DataSetID
DataSetTitle
DataSetTypeCV
DataSetUUID
class odm2api.models.DataSetsResults(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
DataSetID
DataSetObj
ResultID
ResultObj
class odm2api.models.DerivationEquations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

DerivationEquation
DerivationEquationID
class odm2api.models.Directives(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

DirectiveDescription
DirectiveID
DirectiveTypeCV
class odm2api.models.Equipment(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

EquipmentCode
EquipmentDescription
EquipmentID
EquipmentInventoryNumber
EquipmentModelObj
EquipmentName
EquipmentOwnerID
EquipmentPurchaseDate
EquipmentPurchaseOrderNumber
EquipmentSerialNumber
EquipmentTypeCV
EquipmentVendorID
ModelID
OrganizationObj
PersonObj
class odm2api.models.EquipmentActions(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ActionID
ActionObj
BridgeID
EquipmentID
EquipmentObj
class odm2api.models.EquipmentAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
EquipmentID
EquipmentObj
class odm2api.models.EquipmentModels(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

IsInstrument
ModelDescription
ModelID
ModelManufacturerID
ModelName
ModelPartNumber
OrganizationObj
class odm2api.models.EquipmentUsed(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ActionID
ActionObj
BridgeID
EquipmentID
EquipmentObj
class odm2api.models.ExtensionProperties(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

PropertyDataTypeCV
PropertyDescription
PropertyID
PropertyName
PropertyUnitsID
UnitObj
class odm2api.models.ExternalIdentifierSystems(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ExternalIdentifierSystemDescription
ExternalIdentifierSystemID
ExternalIdentifierSystemName
ExternalIdentifierSystemURL
IdentifierSystemOrganizationID
IdentifierSystemOrganizationObj
class odm2api.models.FeatureActions(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Provides flexible linkage between Actions and the SamplingFeatures on which or at which they were performed.

ActionID
ActionObj
FeatureActionID
SamplingFeatureID
SamplingFeatureObj
class odm2api.models.InstrumentOutputVariables(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

EquipmentModelObj
InstrumentAccuracy
InstrumentMethodID
InstrumentOutputVariableID
InstrumentRawOutputUnitsID
InstrumentResolution
MethodObj
ModelID
OutputUnitObj
VariableID
VariableObj
class odm2api.models.MaintenanceActions(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ActionID
ActionObj
IsFactoryService
MaintenanceCode
MantenanceReason
class odm2api.models.MeasurementResultValueAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
ValueID
ValueObj
class odm2api.models.MeasurementResultValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

DataValue
ResultID
ResultObj
ValueDateTime
ValueDateTimeUTCOffset
ValueID
class odm2api.models.MeasurementResults(**kwargs)[source]

Bases: odm2api.models.Results

AggregationStatisticCV
CensorCodeCV
FeatureActionID
FeatureActionObj
ProcessingLevelID
ProcessingLevelObj
QualityCodeCV
ResultDateTime
ResultDateTimeUTCOffset
ResultID
ResultTypeCV
ResultUUID
SampledMediumCV
SpatialReferenceID
SpatialReferenceObj
StatusCV
TaxonomicClassifierID
TaxonomicClassifierObj
TimeAggregationInterval
TimeAggregationIntervalUnitsID
TimeAggregationIntervalUnitsObj
UnitsID
UnitsObj
ValidDateTime
ValidDateTimeUTCOffset
ValueCount
VariableID
VariableObj
XLocation
XLocationUnitsID
XLocationUnitsObj
YLocation
YLocationUnitsID
YLocationUnitsObj
ZLocation
ZLocationUnitsID
ZLocationUnitsObj
class odm2api.models.MethodAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
MethodID
MethodObj
class odm2api.models.MethodCitations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
CitationID
CitationObj
MethodID
MethodObj
RelationshipTypeCV
class odm2api.models.MethodExtensionPropertyValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExtensionPropertyObj
MethodID
MethodObj
PropertyID
PropertyValue
class odm2api.models.MethodExternalIdentifiers(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExternalIdentifierSystemID
ExternalIdentifierSystemObj
MethodExternalIdentifier
MethodExternalIdentifierURI
MethodID
MethodObj
class odm2api.models.Methods(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

The procedure used to perform an action.

MethodCode
MethodDescription
MethodID
MethodName
MethodTypeCV
OrganizationID
OrganizationObj
class odm2api.models.Models(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ModelCode
ModelDescription
ModelID
ModelName
class odm2api.models.Organizations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

A group of people.

OrganizationCode
OrganizationDescription
OrganizationID
OrganizationName
OrganizationObj
OrganizationTypeCV
ParentOrganizationID
class odm2api.models.People(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Individuals that perform actions.

PersonFirstName
PersonID
PersonLastName
PersonMiddleName
class odm2api.models.PersonExternalIdentifiers(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExternalIdentifierSystemID
ExternalIdentifierSystemObj
PersonExternalIdentifier
PersonExternalIdentifierURI
PersonID
PersonObj
class odm2api.models.PointCoverageResultValueAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
ValueID
ValueObj
class odm2api.models.PointCoverageResultValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

CensorCodeCV
DataValue
QualityCodeCV
ResultID
ResultObj
ValueDateTime
ValueDateTimeUTCOffset
ValueID
XLocation
XLocationUnitsID
XLocationUnitsObj
YLocation
YLocationUnitsID
YLocationUnitsobj
class odm2api.models.PointCoverageResults(**kwargs)[source]

Bases: odm2api.models.Results

AggregationStatisticCV
FeatureActionID
FeatureActionObj
IntendedXSpacing
IntendedXSpacingUnitsID
IntendedXSpacingUnitsObj
IntendedYSpacing
IntendedYSpacingUnitsID
IntendedYSpacingUnitsObj
ProcessingLevelID
ProcessingLevelObj
ResultDateTime
ResultDateTimeUTCOffset
ResultID
ResultTypeCV
ResultUUID
SampledMediumCV
SpatialReferenceID
SpatialReferenceObj
StatusCV
TaxonomicClassifierID
TaxonomicClassifierObj
TimeAggregationInterval
TimeAggregationIntervalUnitsID
UnitsID
UnitsObj
ValidDateTime
ValidDateTimeUTCOffset
ValueCount
VariableID
VariableObj
ZLocation
ZLocationUnitsID
ZLocationUnitsObj
class odm2api.models.ProcessingLevels(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Levels to which data have been quality controlled.

Definition
Explanation
ProcessingLevelCode
ProcessingLevelID
class odm2api.models.ProfileResultValueAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
ValueID
ValueObj
class odm2api.models.ProfileResultValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

CensorCodeCV
DataValue
QualityCodeCV
ResultID
ResultObj
TimeAggregationInterval
TimeAggregationIntervalUnitsID
TimeAggregationIntervalUnitsObj
ValueDateTime
ValueDateTimeUTCOffset
ValueID
ZAggregationInterval
ZLocation
ZLocationUnitsID
ZLocationUnitsObj
class odm2api.models.ProfileResults(**kwargs)[source]

Bases: odm2api.models.Results

AggregationStatisticCV
FeatureActionID
FeatureActionObj
IntendedTimeSpacing
IntendedTimeSpacingUnitsID
IntendedTimeSpacingUnitsObj
IntendedZSpacing
IntendedZSpacingUnitsID
IntendedZSpacingUnitsObj
ProcessingLevelID
ProcessingLevelObj
ResultDateTime
ResultDateTimeUTCOffset
ResultID
ResultTypeCV
ResultUUID
SampledMediumCV
SpatialReferenceID
SpatialReferenceObj
StatusCV
TaxonomicClassifierID
TaxonomicClassifierObj
UnitsID
UnitsObj
ValidDateTime
ValidDateTimeUTCOffset
ValueCount
VariableID
VariableObj
XLocation
XLocationUnitsID
XLocationUnitsObj
YLocation
YLocationUnitsID
YLocationUnitsObj
class odm2api.models.ReferenceMaterialExternalIdentifiers(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExternalIdentifierSystemID
ExternalIdentifierSystemObj
ReferenceMaterialExternalIdentifier
ReferenceMaterialExternalIdentifierURI
ReferenceMaterialID
ReferenceMaterialObj
class odm2api.models.ReferenceMaterialValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

CitationID
CitationObj
ReferenceMaterialAccuracy
ReferenceMaterialID
ReferenceMaterialObj
ReferenceMaterialValue
ReferenceMaterialValueID
UnitObj
UnitsID
VariableID
VariableObj
class odm2api.models.ReferenceMaterials(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

OrganizationObj
ReferenceMaterialCode
ReferenceMaterialExpirationDate
ReferenceMaterialID
ReferenceMaterialLotCode
ReferenceMaterialMediumCV
ReferenceMaterialOrganizationID
ReferenceMaterialPurchaseDate
SamplingFeatureID
SamplingFeatureObj
class odm2api.models.RelatedActions(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Enables specifying relationships among Actions (e.g., workflows, etc.)

ActionID
ActionObj
RelatedActionID
RelatedActionObj
RelationID
RelationshipTypeCV
class odm2api.models.RelatedAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
RelatedAnnotationID
RelatedAnnotationObj
RelationID
RelationshipTypeCV
class odm2api.models.RelatedCitations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

CitationID
CitationObj
RelatedCitationID
RelatedCitationObj
RelationID
RelationshipTypeCV
class odm2api.models.RelatedDataSets(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

DataSetID
DataSetObj
RelatedDataSetID
RelatedDataSetObj
RelationID
RelationshipTypeCV
VersionCode
class odm2api.models.RelatedEquipment(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

EquipmentID
EquipmentObj
RelatedEquipmentID
RelatedEquipmentObj
RelationID
RelationshipEndDateTime
RelationshipEndDateTimeUTCOffset
RelationshipStartDateTime
RelationshipStartDateTimeUTCOffset
RelationshipTypeCV
class odm2api.models.RelatedFeatures(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

RelatedFeatureID
RelatedFeatureObj
RelationID
RelationshipTypeCV
SamplingFeatureID
SamplingFeatureObj
SpatialOffsetID
SpatialOffsetObj
class odm2api.models.RelatedModels(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ModelID
ModelObj
RelatedID
RelatedModelID
RelatedModelObj
RelationshipTypeCV
class odm2api.models.RelatedResults(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

RelatedResultID
RelatedResultObj
RelatedResultSequenceNumber
RelationID
RelationshipTypeCV
ResultID
ResultObj
VersionCode
class odm2api.models.ResultAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BeginDateTime
BridgeID
EndDateTime
ResultID
ResultObj
class odm2api.models.ResultDerivationEquations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

DerivationEquationID
DerivationEquationsObj
ResultID
ResultsObj
class odm2api.models.ResultExtensionPropertyValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExtensionPropertyObj
PropertyID
PropertyValue
ResultID
ResultObj
class odm2api.models.ResultNormalizationValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

ReferenceMaterialValueID
ReferenceMaterialValueObj
ResultID
ResultsObj
class odm2api.models.Results(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

The result of an action.

FeatureActionID
FeatureActionObj
ProcessingLevelID
ProcessingLevelObj
ResultDateTime
ResultDateTimeUTCOffset
ResultID
ResultTypeCV
ResultUUID
SampledMediumCV
StatusCV
TaxonomicClassifierID
TaxonomicClassifierObj
UnitsID
UnitsObj
ValidDateTime
ValidDateTimeUTCOffset
ValueCount
VariableID
VariableObj
class odm2api.models.ResultsDataQuality(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
DataQualityID
DataQualityObj
ResultID
ResultObj
class odm2api.models.SamplingFeatureAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
SamplingFeatureID
SamplingFeatureObj
class odm2api.models.SamplingFeatureExtensionPropertyValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExtensionPropertyObj
PropertyID
PropertyValue
SamplingFeatureID
SamplingFeatureObj
class odm2api.models.SamplingFeatureExternalIdentifiers(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExternalIdentifierSystemID
ExternalIdentifierSystemObj
SamplingFeatureExternalIdentifier
SamplingFeatureExternalIdentifierURI
SamplingFeatureID
SamplingFeatureObj
class odm2api.models.SamplingFeatures(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Where or on what an action was performed.

ElevationDatumCV

The code for the vertical geodetic datum that specifies the zero point for the Sampling Feature Elevation

Type

str

Elevation_m

The elevation of the sampling feature in meters, or in the case of Specimen, the elevation from where the SamplingFeature.Specimen was collected

Type

float

FeatureGeometryWKT

The location geometry of the sampling feature on the Earth expressed as well known text (WKT). Can be a Point, Curve (profile, trajectory, etc.), Surface (flat polygons, etc.), or Solid/Volume (although often limited to 2D geometries).

Type

str

SamplingFeatureCode

A short but meaningful text identifier for the sampling feature.

Type

str

SamplingFeatureDescription

Text describing the sampling feature.

Type

str

SamplingFeatureGeotypeCV

Dimensionality of SamplingFeature; point2d, line2d, etc.

Type

str

SamplingFeatureID

Primary key identifier.

Type

int

SamplingFeatureName

Sampling Feature name (free text).

Type

str

SamplingFeatureTypeCV

CV term describing the type of sampling feature.

Type

str

SamplingFeatureUUID

A universally unique identifier for the sampling feature.

Type

str

class odm2api.models.SectionResultValueAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
ValueID
ValueObj
class odm2api.models.SectionResultValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AggregationStatisticCV
CensorCodeCV
DataValue
QualityCodeCV
ResultID
ResultObj
TimeAggregationInterval
TimeAggregationIntervalUnitsID
TimeAggregationIntervalUnitsObj
ValueDateTime
ValueDateTimeUTCOffset
ValueID
XAggregationInterval
XLocation
XLocationUnitsID
XLocationUnitsObj
ZAggregationInterval
ZLocation
ZLocationUnitsID
ZLocationUnitsObj
class odm2api.models.SectionResults(**kwargs)[source]

Bases: odm2api.models.Results

AggregationStatisticCV
FeatureActionID
FeatureActionObj
IntendedTimeSpacing
IntendedTimeSpacingUnitsID
IntendedTimeSpacingUnitsObj
IntendedXSpacing
IntendedXSpacingUnitsID
IntendedXSpacingUnitsObj
IntendedZSpacing
IntendedZSpacingUnitsID
IntendedZSpacingUnitsObj
ProcessingLevelID
ProcessingLevelObj
ResultDateTime
ResultDateTimeUTCOffset
ResultID
ResultTypeCV
ResultUUID
SampledMediumCV
SpatialReferenceID
SpatialReferenceObj
StatusCV
TaxonomicClassifierID
TaxonomicClassifierObj
UnitsID
UnitsObj
ValidDateTime
ValidDateTimeUTCOffset
ValueCount
VariableID
VariableObj
YLocation
YLocationUnitsID
YLocationUnitsObj
class odm2api.models.Simulations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Action
ActionID
DataSet
InputDataSetID
Model
ModelID
SimulationDescription
SimulationEndDateTime
SimulationEndDateTimeUTCOffset
SimulationID
SimulationName
SimulationStartDateTime
SimulationStartDateTimeUTCOffset
TimeStepUnitsID
TimeStepValue
Unit
class odm2api.models.Sites(**kwargs)[source]

Bases: odm2api.models.SamplingFeatures

ElevationDatumCV
Elevation_m
FeatureGeometryWKT
Latitude
Longitude
SamplingFeatureCode
SamplingFeatureDescription
SamplingFeatureGeotypeCV
SamplingFeatureID
SamplingFeatureName
SamplingFeatureTypeCV
SamplingFeatureUUID
SiteTypeCV
SpatialReferenceID
SpatialReferenceObj
class odm2api.models.SpatialOffsets(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Offset1UnitID
Offset1UnitObj
Offset1Value
Offset2UnitID
Offset2UnitObj
Offset2Value
Offset3UnitID
Offset3UnitObj
Offset3Value
SpatialOffsetID
SpatialOffsetTypeCV
class odm2api.models.SpatialReferenceExternalIdentifiers(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExternalIdentifierSystemID
ExternalIdentifierSystemObj
SpatialReferenceExternalIdentifier
SpatialReferenceExternalIdentifierURI
SpatialReferenceID
SpatialReferenceObj
class odm2api.models.SpatialReferences(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

SRSCode
SRSDescription
SRSName
SpatialReferenceID
class odm2api.models.SpecimenBatchPositions(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BatchPositionLabel
BatchPositionsNumber
FeatureActionID
FeatureActionObj
class odm2api.models.SpecimenTaxonomicClassifiers(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
CitationID
SamplingFeatureID
SpecimenObj
TaxonomicClassifierID
TaxonomicClassifierObj
class odm2api.models.Specimens(**kwargs)[source]

Bases: odm2api.models.SamplingFeatures

ElevationDatumCV
Elevation_m
FeatureGeometryWKT
IsFieldSpecimen
SamplingFeatureCode
SamplingFeatureDescription
SamplingFeatureGeotypeCV
SamplingFeatureID
SamplingFeatureName
SamplingFeatureTypeCV
SamplingFeatureUUID
SpecimenMediumCV
SpecimenTypeCV
class odm2api.models.SpectraResultValueAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
ValueID
ValueObj
class odm2api.models.SpectraResultValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

CensorCodeCV
DataValue
EmissionWavelength
ExcitationWavelength
QualityCodeCV
ResultID
ResultObj
TimeAggregationInterval
TimeAggregationIntervalUnitsID
TimeAggregationIntervalUnitsObj
ValueDateTime
ValueDateTimeUTCOffset
ValueID
WavelengthUnitsID
WavelengthUnitsObj
class odm2api.models.SpectraResults(**kwargs)[source]

Bases: odm2api.models.Results

AggregationStatisticCV
FeatureActionID
FeatureActionObj
IntendedWavelengthSpacing
IntendedWavelengthSpacingUnitsID
IntendedWavelengthSpacingUnitsObj
ProcessingLevelID
ProcessingLevelObj
ResultDateTime
ResultDateTimeUTCOffset
ResultID
ResultTypeCV
ResultUUID
SampledMediumCV
SpatialReferenceID
SpatialReferenceObj
StatusCV
TaxonomicClassifierID
TaxonomicClassifierObj
UnitsID
UnitsObj
ValidDateTime
ValidDateTimeUTCOffset
ValueCount
VariableID
VariableObj
XLocation
XLocationUnitsID
XLocationUnitsObj
YLocation
YLocationUnitsID
YLocationUnitsObj
ZLocation
ZLocationUnitsID
ZLocationUnitsObj
class odm2api.models.TaxonomicClassifierExternalIdentifiers(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExternalIdentifierSystemID
ExternalIdentifierSystemObj
TaxonomicClassifierExternalIdentifier
TaxonomicClassifierExternalIdentifierURI
TaxonomicClassifierID
TaxonomicClassifierObj
class odm2api.models.TaxonomicClassifiers(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Terms for classifying results.

ParentTaxonomicClassifierID
TaxonomicClassifierCommonName
TaxonomicClassifierDescription
TaxonomicClassifierID
TaxonomicClassifierName
TaxonomicClassifierTypeCV
parent
class odm2api.models.TimeSeriesResultValueAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
ValueID
ValueObj
class odm2api.models.TimeSeriesResultValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

CensorCodeCV
DataValue
QualityCodeCV
ResultID
ResultObj
TimeAggregationInterval
TimeAggregationIntervalUnitsID
TimeAggregationIntervalUnitsObj
ValueDateTime
ValueDateTimeUTCOffset
ValueID
get_columns()[source]
list_repr()[source]
class odm2api.models.TimeSeriesResults(**kwargs)[source]

Bases: odm2api.models.Results

AggregationStatisticCV
FeatureActionID
FeatureActionObj
IntendedTimeSpacing
IntendedTimeSpacingUnitsID
IntendedTimeSpacingUnitsObj
ProcessingLevelID
ProcessingLevelObj
ResultDateTime
ResultDateTimeUTCOffset
ResultID
ResultTypeCV
ResultUUID
SampledMediumCV
SpatialReferenceID
SpatialReferenceObj
StatusCV
TaxonomicClassifierID
TaxonomicClassifierObj
UnitsID
UnitsObj
ValidDateTime
ValidDateTimeUTCOffset
ValueCount
VariableID
VariableObj
XLocation
XLocationUnitsID
XLocationUnitsObj
YLocation
YLocationUnitsID
YLocationUnitsObj
ZLocation
ZLocationUnitsID
ZLocationUnitsObj
class odm2api.models.TrajectoryResultValueAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
ValueID
ValueObj
class odm2api.models.TrajectoryResultValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

CensorCodeCV
DataValue
QualityCodeCV
ResultID
ResultObj
TimeAggregationInterval
TimeAggregationIntervalUnitsID
TimeAggregationIntervalUnitsObj
TrajectoryDistance
TrajectoryDistanceAggregationInterval
TrajectoryDistanceUnitsID
ValueDateTime
ValueDateTimeUTCOffset
ValueID
XLocation
XLocationUnitsID
XLocationUnitsObj
YLocation
YLocationUnitsID
YLocationUnitsObj
ZLocation
ZLocationUnitsID
ZLocationUnitsObj
class odm2api.models.TrajectoryResults(**kwargs)[source]

Bases: odm2api.models.Results

AggregationStatisticCV
FeatureActionID
FeatureActionObj
IntendedTimeSpacing
IntendedTimeSpacingUnitsID
IntendedTimeSpacingUnitsObj
IntendedTrajectorySpacing
IntendedTrajectorySpacingUnitsID
IntendedTrajectorySpacingUnitsObj
ProcessingLevelID
ProcessingLevelObj
ResultDateTime
ResultDateTimeUTCOffset
ResultID
ResultTypeCV
ResultUUID
SampledMediumCV
SpatialReferenceID
SpatialReferenceObj
StatusCV
TaxonomicClassifierID
TaxonomicClassifierObj
UnitsID
UnitsObj
ValidDateTime
ValidDateTimeUTCOffset
ValueCount
VariableID
VariableObj
class odm2api.models.TransectResultValueAnnotations(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AnnotationID
AnnotationObj
BridgeID
ValueID
ValueObj
class odm2api.models.TransectResultValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

AggregationStatisticCV
CensorCodeCV
DataValue
QualityCodeCV
ResultID
ResultObj
TimeAggregationInterval
TimeAggregationIntervalUnitsID
TimeAggregationIntervalUnitsObj
TransectDistance
TransectDistanceAggregationInterval
TransectDistanceUnitsID
TransectDistanceUnitsObj
ValueDateTime
ValueDateTimeUTCOffset
ValueID
XLocation
XLocationUnitsID
XLocationUnitsObj
YLocation
YLocationUnitsID
YLocationUnitsObj
class odm2api.models.TransectResults(**kwargs)[source]

Bases: odm2api.models.Results

AggregationStatisticCV
FeatureActionID
FeatureActionObj
IntendedTimeSpacing
IntendedTimeSpacingUnitsID
IntendedTimeSpacingUnitsObj
IntendedTransectSpacing
IntendedTransectSpacingUnitsID
IntendedTransectSpacingUnitsObj
ProcessingLevelID
ProcessingLevelObj
ResultDateTime
ResultDateTimeUTCOffset
ResultID
ResultTypeCV
ResultUUID
SampledMediumCV
SpatialReferenceID
SpatialReferenceObj
StatusCV
TaxonomicClassifierID
TaxonomicClassifierObj
UnitsID
UnitsObj
ValidDateTime
ValidDateTimeUTCOffset
ValueCount
VariableID
VariableObj
ZLocation
ZLocationUnitsID
ZLocationUnitsObj
class odm2api.models.Units(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Units of measure.

UnitsAbbreviation
UnitsID
UnitsName
UnitsTypeCV
class odm2api.models.VariableExtensionPropertyValues(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExtensionPropertyObj
PropertyID
PropertyValue
VariableID
VariableObj
class odm2api.models.VariableExternalIdentifiers(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

BridgeID
ExternalIdentifierSystemID
ExternalIdentifierSystemObj
VariableExternalIdentifier
VariableExternalIdentifierURI
VariableID
VariableObj
class odm2api.models.Variables(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

What was observed.

NoDataValue
SpeciationCV
VariableCode
VariableDefinition
VariableID
VariableNameCV
VariableTypeCV
odm2api.models.is_hex(s)[source]
odm2api.models.setSchema(engine)[source]