This document describes some key fields of the Data Warehouse data model and fields that may require further clarification. A full model for responses, containing all possible fields, can be found from api.laji.fi OpenApi (swagger) specification.
Document
documentId
URI
Id of the Document
collectionId
URI
Id of the Collection
sourceId
URI
Id of the Source
secureLevel
Enum
NONE, 1KM-100KM, HIGHEST
secureReasons
Array(Enum)
Reason the document was secured
partial
boolean
Is the document in it’s original form or has something been detached from it/has this document been detached from some other document, because of data concealment.
editorUserIds
Array(String)
Owners of the document
linkings.editors
Array(Person)
FinBIF Persons that the user id’s have been attached to
keywords
Array(String)
Alternative ids, project names, etc. (Exists also
createdDate
Date
Created at the original source (not always known)
modifiedDate
Date
Last modified at the original source (not always known)
loadDate
Date
Last loaded to FinBIF DW
firstLoadDate
Date
First time loaded to FinBIF DW
facts
Array(Fact)
Document facts
media
Array(Media)
Document media (specimen labels, etc.)
quality.issue
Quality
General issues about the document, marked by DW or the original source.
annotations
Array(Annotation)
Annotations (quality control markings) made about the document.
Gathering
gatheringId
URI
Gathering id
team
Array(String)
Names of the observers
observerUserIds
Array(String)
Observer user ids
linkings.observers
Array(Person)
FinBIF Persons that the user id’s have been attached to
eventDate.begin
Date
Begin date
eventDate.end
Date
End date
hourBegin/End
Int
Time of day, hour: begin/end. Stored as reported. Assume the observer has used the local timezone at the time of making the observation,
minutesBegin/end
Int
Time of day, minutes: begin/end.
displayDateTime
String
Date and times formatted to sortable and human readable format.
higherGeography
String
Verbatim from the source (continent etc.)
country
String
Verbatim country from the source
biogeographicalProvince
String
Verbatim biogeographical province from the source
province
String
Verbatim administrative province from the source
municipality
String
Verbatim municipality from the source
locality
String
Verbatim locality from the source (village, river, etc.)
media
Array(Media)
Gathering media (habitat images, trip photos, etc.)
quality.issue
Quality
General issues about the gathering event (not time, geo). Marked by DW or the original source.
quality.timeIssue
Quality
Issuses about dates, times. Marked by DW or the original source.
quality.locationIssue
Quality
Issues about coordinates, other geo-information. Marked by DW or the original source.
facts
Array(Fact)
Gathering facts
interpretations
Interpretations
Geo related interpretations (see bellow)
conversions
Conversions
Coordinate and time conversions (see bellow)
Gathering.interpretations
coordinateAccuracy
Int
DW interprets accuracy of coordinates in meters based on geography, coordinates or coordintesVerbatim. The figure is indicative.
sourceOfCoordinates
Enum
How the DW resolved coordinates (that can be found from conversions-object)
country
URI
Interpreted country id (/area endpoint).
sourceOfCountry
Enum
How the country was interpreted
biogeographicalProvince
URI
Interpreted biogeographical province id (/area). This is a single province (for example using coordinate center point).
sourceOfBiogeographicalProvince
Enum
How the bio-province was interpreted
biogeographicalProvinces
Array(URI)
Ids all all the bio-provinces that touch the coordinate area
finnishMunicipality
URI
Interpreted Finnish municipality id (/area). This is a single municipality (for example using coordinate center point).
sourceOfFinnishMunicipality
Enum
How the municipality was interpreted
finnishMunicipalities
Array(URI)
Ids all all the municipalities that touch the coordinate area
countryDisplayname
String
Name of the interpreted country in Finnish
biogeographicalProvinceDisplayname
String
Name of the interpreted bio-province in Finnish + abbreviation in Latin
municipalityDisplayname
String
Name of the interpreted municipality in Finnish
In case the coordinates have been concealed, coordinate accuracy indicates the accuracy of the coarsed coordinates, not the accuracy of the original coordinates.
100km x 100km; left lower corner of the grid; only if area entirely inside the gird
ykj50km.lat,lon
Int
50km x 50km; only if area entirely inside the gird
ykj10km.lat,lon
Int
10km x 10km; only if area entirely inside the gird
ykj1km.lat,lon
Int
1km x 1km; only if area entirely inside the gird
ykj100kmCenter.lat,lon
Int
100km x 100km; left lower corner of the grid; based on coordinate center point even if area not entirely inside the grid
ykj50kmCenter.lat,lon
Int
50km x 50km; even if area not entirely inside the grid
ykj10kmCenter.lat,lon
Int
10km x 10km; even if area not entirely inside the grid
ykj1kmCenter.lat,lon
Int
1km x 1km; even if area not entirely inside the grid
eurefWKT
String(WKT)
Original geography or bounding box/point in WKT format, ETRS-TM35FIN coordinates
ykjWKT
String(WKT)
Original geography or bounding box/point in WKT format, YKJ, yhtenäiskoordinaatit
wgs84WKT
String(WKT)
Original geography or bounding box/point in WKT format, WGS84 coordinates
boundingBoxAreaInSquareMeters
Int
Area of the bounding box in square meters
Unit
unitId
URI
Unit id
taxonVerbatim
String
Species/taxon scientific, vernacular or other name as reported by the original data source
author
String
Scientific name author, reported by the original data source. Not used at the moment for anything by the DW.
reportedTaxonId
URI
FinBIF taxon id, reported by the original source. Either taxonVerbatim or reportedTaxonId must be given. If both are given, reportedTaxonId is used (for taxon linking).
interpretations.annotatedTaxonId
URI
FinBIF taxon id, resolved by the DW based on annotation data (quality markings of taxon experts, users).
linkings.taxon
Taxon
FinBIF taxon, if the occurrence could be linked to taxonomy (based on taxonVerbatim or reportedTaxonId, annotations). Limited taxon model; use /taxa endpoint to get full data model of the taxon if more fields needed.
linkings.originalTaxon
Taxon
Same as above, but will ignore annotation data.
abundanceString
String
As reported by the original source
interpretations.individualCount
Int
Individual count interpreted from the abundanceString (for example “n. 12-15” = 12, “1m2f” = 3)
recordBasis
Enum
(specimen, song, footprint, etc)
superRecordBasis
Enum
Derived from recordBasis: observation, specimen machine obsevation
lifeStage
Enum
Life stage (combines plant, animal life stages)
sex
Enum
wild
Boolean
Did the occurrence exist in the wild? Default is null = not known. Based on the original data source.
det
String
Name of person who made the identification (as reported by the original data source).
media
Array(Media)
Media about the occurrence
reportedTaxonConfidence
Enum
As reported by the original data source / original observer
quality.issue
Quality
General issues (non identification, reliability related) with the occurrence, marked by the original data source or the DW.
quality.taxon
TaxonQuality
Interpreted quality of the occurrence, by the DW
annotations
Aray(Annotation)
Annotations (quality control markings) made about the occurrence.
facts
Array(Fact)
Unit facts
Coordinates
latMin,latMax,lonMin,lonMax
Double
Bounding box
type
Enum
Coordinate system
accuracyInMeters
Int
As reported by the original source. (For example source reports a WGS84 point and accuracy 1000m)
Media
mediaType
Enum
IMAGE|AUDIO|VIDEO
author
String
copyrightOwner
String
caption
String
licenseId
URI
Intellectual rights license (metadata/range/ MY.intellectualRightsEnum endpoint)
licenseAbbreviation
String
Other license abbreviation if not found among FinBIF metadata
fullURL
URI
URI of the full image
thumbnailURL
URI
URI of a thumbnail (not required but highly recommended)
squareThumbnailURL
URI
URI of a square thumbnail (not required)
Fact
fact
String
Name / id of the variable, as reported by the original source
value
String
Value, as reported by the original source
integerValue
Int
Derived from value
decimalValue
Double
Derived from value
Person
id
URI
FinBIF person id
userId
String
User id in original data source
fullName
String
Person full name in FinBIF
Quality
Occurrences/gatherings/documents that have issues are not shown by default.
issue
Enum
Type of issue
source
Enum
Source of issue (original source or DW)
message
String
Notes
TaxonReliability
reliability
Enum
Reliability of the occurrence as interpreted by the DW