{"openapi":"3.1.0","info":{"title":"Taxon API","description":"This API provides access to taxa (name usages) indexed by ChecklistBank for GBIF.\nIt exposes taxonomic data from registered checklist datasets including scientific names,\nsynonymy, vernacular names, geographic distributions, media, bibliographic references and\nmeasurements or facts. Taxon keys are scoped to individual datasets and are not necessarily globally unique.\n","termsOfService":"https://www.gbif.org/terms","version":"v2"},"servers":[{"url":"https://api.gbif.org/v2/","description":"Production"},{"url":"https://api.gbif-test.org/v2/","description":"Test"}],"tags":[{"name":"Tree","description":"Taxonomic tree navigation"},{"name":"Taxon","description":"Taxa indexed by ChecklistBank for GBIF"},{"name":"Checklist","description":"Checklist dataset operations \u2014 import metrics and cache management"}],"paths":{"/taxon/{datasetKey}/{taxonKey}":{"get":{"tags":["Taxon"],"summary":"Get a single taxon name usage","description":"Returns the simplified name usage for the given taxon key within a dataset, including its scientific name, rank, taxonomic status, and classification identifiers.","operationId":"getTaxon","parameters":[{"name":"datasetKey","in":"path","description":"UUID for the dataset key","required":true,"schema":{"type":"string","format":"uuid"},"example":"2d59e5db-57ad-41ff-97d6-11f5fb264527"},{"name":"taxonKey","in":"path","description":"Taxon key scoped within the dataset","required":true,"schema":{"type":"string"},"example":"CXA"}],"responses":{"200":{"description":"Taxon name usage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameUsage"}}}},"404":{"description":"Taxon not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameUsage"}}}}}}},"/taxon/{datasetKey}/{taxonKey}/related":{"get":{"tags":["Taxon"],"summary":"Get name usages for this taxon from other datasets","description":"Returns name usages matching this taxon from other checklist datasets registered in ChecklistBank. Results can be filtered by dataset type, specific dataset keys, or publisher keys.","operationId":"getRelatedUsages","parameters":[{"name":"datasetKey","in":"path","description":"UUID for the dataset key","required":true,"schema":{"type":"string","format":"uuid"},"example":"2d59e5db-57ad-41ff-97d6-11f5fb264527"},{"name":"taxonKey","in":"path","description":"Taxon key scoped within the dataset","required":true,"schema":{"type":"string"},"example":"CXA"},{"name":"datasetType","in":"query","description":"Optional dataset type filter, repeatable: e.g. `?datasetType=article&datasetType=nomenclatural`","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","enum":["NOMENCLATURAL","TAXONOMIC","PHYLOGENETIC","ARTICLE","LEGAL","THEMATIC","IDENTIFICATION","OTHER"]}}},{"name":"datasetKey","in":"query","description":"Optional dataset key filter, repeatable: e.g. `?datasetKey=7ddf754f-d193-4cc9-b351-99906754a03b&datasetKey=2d59e5db-57ad-41ff-97d6-11f5fb264527`","required":false,"explode":true,"schema":{"type":"array","items":{"type":"uuid"}}},{"name":"publisherKey","in":"query","description":"Optional publisher key filter, repeatable: e.g. `?publisherKey=<uuid>&publisherKey=<uuid>`","required":false,"explode":true,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}],"responses":{"200":{"description":"Related name usages","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NameUsage"}}}}},"404":{"description":"Taxon not found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NameUsage"}}}}}}}},"/taxon/{datasetKey}/{taxonKey}/info":{"get":{"tags":["Taxon"],"summary":"Get full taxon information","description":"Returns the comprehensive name usage information for the given taxon, aggregating all related data: synonymy (homotypic, heterotypic, misapplied), classification, vernacular names, geographic distributions, media, bibliographic references, and measurements or facts.","operationId":"getTaxonInfo","parameters":[{"name":"datasetKey","in":"path","description":"UUID for the dataset key","required":true,"schema":{"type":"string","format":"uuid"},"example":"2d59e5db-57ad-41ff-97d6-11f5fb264527"},{"name":"taxonKey","in":"path","description":"Taxon key scoped within the dataset","required":true,"schema":{"type":"string"},"example":"CXA"}],"responses":{"200":{"description":"Full taxon information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameUsageInfo"}}}},"404":{"description":"Taxon not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameUsageInfo"}}}}}}},"/taxon/{datasetKey}/{taxonKey}/breakdown":{"get":{"tags":["Taxon"],"summary":"Get descendant species count breakdown","description":"Returns a breakdown by all descendant taxa sharing the highest major Linnean rank down to genus at most, counting the number of accepted species within each group.","operationId":"getTaxonBreakdown","parameters":[{"name":"datasetKey","in":"path","description":"UUID for the dataset key","required":true,"schema":{"type":"string","format":"uuid"},"example":"2d59e5db-57ad-41ff-97d6-11f5fb264527"},{"name":"taxonKey","in":"path","description":"Taxon key scoped within the dataset","required":true,"schema":{"type":"string"},"example":"CXA"}],"responses":{"200":{"description":"Taxonomic breakdown","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxonBreakdown"}}}},"404":{"description":"Taxon not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxonBreakdown"}}}}}}},"/taxon/tree/{datasetKey}":{"get":{"tags":["Tree"],"summary":"Get root taxa of a dataset","description":"Returns the top-level (root) accepted taxa of the given checklist dataset, i.e. taxa with no parent. Results are paginated.","operationId":"getRootTaxa","parameters":[{"name":"datasetKey","in":"path","description":"UUID for the dataset key","required":true,"schema":{"type":"string","format":"uuid"},"example":"2d59e5db-57ad-41ff-97d6-11f5fb264527"},{"name":"limit","in":"query","description":"Controls the number of results in the page. Using too high a value will be overwritten with the default maximum threshold, depending on the service. Sensible defaults are used so this may be omitted.","schema":{"type":"integer","format":"int32","minimum":0}},{"name":"offset","in":"query","description":"Determines the offset for the search results. A limit of 20 and offset of 40 will get the third page of 20 results. Some services have a maximum offset.","schema":{"type":"integer","format":"int32","minimum":0}}],"responses":{"200":{"description":"Root taxa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagingResponseTreeUsage"}}}}}}},"/taxon/tree/{datasetKey}/{taxonKey}":{"get":{"tags":["Tree"],"summary":"Get the classification for a taxon","description":"Returns the ordered list of ancestor taxa from the root of the classification down to the given taxon, inclusive of the taxon itself - unless they are synonyms.","operationId":"getClassification","parameters":[{"name":"datasetKey","in":"path","description":"UUID for the dataset key","required":true,"schema":{"type":"string","format":"uuid"},"example":"2d59e5db-57ad-41ff-97d6-11f5fb264527"},{"name":"taxonKey","in":"path","description":"Taxon key scoped within the dataset, accepting also synonyms in which case we return the classification of their accepted parent","required":true,"schema":{"type":"string"},"example":"CXA"}],"responses":{"200":{"description":"Classification path","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TreeUsage"}}}}},"404":{"description":"Taxon not found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TreeUsage"}}}}}}}},"/taxon/tree/{datasetKey}/{taxonKey}/children":{"get":{"tags":["Tree"],"summary":"Get direct children of a taxon","description":"Returns the direct accepted child taxa of the given taxon. Synonyms are excluded. Results are paginated.","operationId":"getChildren","parameters":[{"name":"datasetKey","in":"path","description":"UUID for the dataset key","required":true,"schema":{"type":"string","format":"uuid"},"example":"2d59e5db-57ad-41ff-97d6-11f5fb264527"},{"name":"taxonKey","in":"path","description":"Taxon key scoped within the dataset","required":true,"schema":{"type":"string"},"example":"CXA"},{"name":"limit","in":"query","description":"Controls the number of results in the page. Using too high a value will be overwritten with the default maximum threshold, depending on the service. Sensible defaults are used so this may be omitted.","schema":{"type":"integer","format":"int32","minimum":0}},{"name":"offset","in":"query","description":"Determines the offset for the search results. A limit of 20 and offset of 40 will get the third page of 20 results. Some services have a maximum offset.","schema":{"type":"integer","format":"int32","minimum":0}}],"responses":{"200":{"description":"Child taxa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagingResponseTreeUsage"}}}},"404":{"description":"Taxon not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagingResponseTreeUsage"}}}}}}},"/taxon/suggest/{datasetKey}":{"get":{"tags":["Searching names","Taxon"],"summary":"Suggestion service for name usages","description":"Prefix search of name usages covering the scientific and vernacular names.\n\nResults are ordered by relevance by default as this search usually returns a lot of results.","operationId":"suggestNames","parameters":[{"name":"datasetKey","in":"path","description":"UUID for the dataset key","required":true,"schema":{"type":"string","format":"uuid"},"example":"2d59e5db-57ad-41ff-97d6-11f5fb264527"},{"name":"taxonID","in":"query","description":"Filters by any of the higher Linnean rank keys. Note this is within the respective checklist and not searching NUB keys across all checklists.","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"taxonRank","in":"query","description":"Filters by taxonomic rank as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/rank.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["SUPERDOMAIN","DOMAIN","SUBDOMAIN","INFRADOMAIN","EMPIRE","REALM","SUBREALM","SUPERKINGDOM","KINGDOM","SUBKINGDOM","INFRAKINGDOM","SUPERPHYLUM","PHYLUM","SUBPHYLUM","INFRAPHYLUM","PARVPHYLUM","MICROPHYLUM","NANOPHYLUM","CLAUDIUS","GIGACLASS","MEGACLASS","SUPERCLASS","CLASS","SUBCLASS","INFRACLASS","SUBTERCLASS","PARVCLASS","SUPERDIVISION","DIVISION","SUBDIVISION","INFRADIVISION","SUPERLEGION","LEGION","SUBLEGION","INFRALEGION","MEGACOHORT","SUPERCOHORT","COHORT","SUBCOHORT","INFRACOHORT","GIGAORDER","MAGNORDER","GRANDORDER","MIRORDER","SUPERORDER","ORDER","NANORDER","HYPOORDER","MINORDER","SUBORDER","INFRAORDER","PARVORDER","SUPERSECTION_ZOOLOGY","SECTION_ZOOLOGY","SUBSECTION_ZOOLOGY","FALANX","GIGAFAMILY","MEGAFAMILY","GRANDFAMILY","SUPERFAMILY","EPIFAMILY","FAMILY","SUBFAMILY","INFRAFAMILY","SUPERTRIBE","TRIBE","SUBTRIBE","INFRATRIBE","SUPRAGENERIC_NAME","SUPERGENUS","GENUS","SUBGENUS","INFRAGENUS","SUPERSECTION_BOTANY","SECTION_BOTANY","SUBSECTION_BOTANY","SUPERSERIES","SERIES","SUBSERIES","INFRAGENERIC_NAME","SPECIES_AGGREGATE","SPECIES","INFRASPECIFIC_NAME","GREX","KLEPTON","SUBSPECIES","CULTIVAR_GROUP","CONVARIETY","INFRASUBSPECIFIC_NAME","PROLES","NATIO","ABERRATION","MORPH","SUPERVARIETY","VARIETY","SUBVARIETY","SUPERFORM","FORM","SUBFORM","PATHOVAR","BIOVAR","CHEMOVAR","MORPHOVAR","PHAGOVAR","SEROVAR","CHEMOFORM","FORMA_SPECIALIS","LUSUS","CULTIVAR","MUTATIO","STRAIN","OTHER","UNRANKED"]}}},{"name":"taxonomicStatus","in":"query","description":"Filters by the taxonomic status as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/taxonomicstatus.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["ACCEPTED","PROVISIONALLY_ACCEPTED","SYNONYM","AMBIGUOUS_SYNONYM","MISAPPLIED","BARE_NAME"]}}},{"name":"extinct","in":"query","description":"Filters by extinction status.","schema":{"type":"boolean"}},{"name":"environment","in":"query","description":"Filters by environment values as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/environment.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["BRACKISH","FRESHWATER","MARINE","TERRESTRIAL"]}}},{"name":"taxonomicGroup","in":"query","description":"Filters for name usages with a specific taxonomic group as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/taxgroup.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Viruses","Prokaryotes","Bacteria","Archaea","Eukaryotes","Protists","Plants","Algae","Bryophytes","Pteridophytes","Angiosperms","Gymnosperms","Fungi","Ascomycetes","Basidiomycetes","Pseudofungi","OtherFungi","Animals","Arthropods","Insects","Coleoptera","Diptera","Lepidoptera","Hymenoptera","Hemiptera","Orthoptera","Trichoptera","OtherInsects","Arachnids","Crustacean","OtherArthropods","Molluscs","Gastropods","Bivalves","OtherMolluscs","Chordates","OtherAnimals"]}}},{"name":"nomenclaturalCode","in":"query","description":"Filters by the nomenclatural code as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/nomcode.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["BACTERIAL","BOTANICAL","CULTIVARS","PHYTO","VIRUS","ZOOLOGICAL","PHYLO"]}}},{"name":"nameType","in":"query","description":"Filters by the name type as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/nametype.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["SCIENTIFIC","VIRUS","HYBRID_FORMULA","INFORMAL","OTU","PLACEHOLDER","NO_NAME"]}}},{"name":"author","in":"query","description":"Filters for name usages with a specific author.","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"year","in":"query","description":"Filters for name usages with a specific publication year.","explode":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"origin","in":"query","description":"Filters for name usages with a specific origin as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/datasetorigin.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["SOURCE","DENORMED_CLASSIFICATION","VERBATIM_PARENT","VERBATIM_ACCEPTED","VERBATIM_BASIONYM","AUTONYM","IMPLICIT_NAME","MISSING_ACCEPTED","BASIONYM_PLACEHOLDER","EX_AUTHOR_SYNONYM","USER","OTHER"]}}},{"name":"issue","in":"query","description":"A specific indexing issue as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/issue.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["NOT_INTERPRETED","ESCAPED_CHARACTERS","REFERENCE_ID_INVALID","ID_NOT_UNIQUE","URL_INVALID","PARTIAL_DATE","PREVIOUS_LINE_SKIPPED","SELF_REFERENCED_RELATION","UNPARSABLE_NAME","PARTIALLY_PARSABLE_NAME","UNPARSABLE_AUTHORSHIP","DOUBTFUL_NAME","INCONSISTENT_AUTHORSHIP","INCONSISTENT_NAME","PARSED_NAME_DIFFERS","UNUSUAL_NAME_CHARACTERS","MULTI_WORD_EPITHET","UPPERCASE_EPITHET","CONTAINS_REFERENCE","NULL_EPITHET","BLACKLISTED_EPITHET","SUBSPECIES_ASSIGNED","LC_MONOMIAL","INDETERMINED","HIGHER_RANK_BINOMIAL","QUESTION_MARKS_REMOVED","REPL_ENCLOSING_QUOTE","MISSING_GENUS","NOMENCLATURAL_STATUS_INVALID","AUTHORSHIP_CONTAINS_NOMENCLATURAL_NOTE","CONFLICTING_NOMENCLATURAL_STATUS","NOMENCLATURAL_CODE_INVALID","BASIONYM_AUTHOR_MISMATCH","BASIONYM_DERIVED","HOMOTYPIC_CONSOLIDATION_UNRESOLVED","CHAINED_BASIONYM","NAME_NOT_UNIQUE","POTENTIAL_CHRESONYM","PUBLISHED_BEFORE_GENUS","BASIONYM_ID_INVALID","RANK_INVALID","UNMATCHED_NAME_BRACKETS","TRUNCATED_NAME","DUPLICATE_NAME","NAME_VARIANT","AUTHORSHIP_CONTAINS_TAXONOMIC_NOTE","TYPE_STATUS_INVALID","LAT_LON_INVALID","ALTITUDE_INVALID","COUNTRY_INVALID","TAXON_VARIANT","TAXON_ID_INVALID","NAME_ID_INVALID","PARENT_ID_INVALID","ACCEPTED_ID_INVALID","ACCEPTED_NAME_MISSING","PARENT_SPECIES_MISSING","TAXONOMIC_STATUS_INVALID","PROVISIONAL_STATUS_INVALID","ENVIRONMENT_INVALID","IS_EXTINCT_INVALID","NAME_CONTAINS_EXTINCT_SYMBOL","GEOTIME_INVALID","SCRUTINIZER_DATE_INVALID","CHAINED_SYNONYM","PARENT_CYCLE","SYNONYM_PARENT","CLASSIFICATION_RANK_ORDER_INVALID","CLASSIFICATION_NOT_APPLIED","PARENT_NAME_MISMATCH","DERIVED_TAXONOMIC_STATUS","TAXONOMIC_STATUS_DOUBTFUL","SYNONYM_DATA_MOVED","SYNONYM_DATA_REMOVED","REFTYPE_INVALID","ACCORDING_TO_CONFLICT","VERNACULAR_NAME_INVALID","VERNACULAR_LANGUAGE_INVALID","VERNACULAR_SEX_INVALID","VERNACULAR_COUNTRY_INVALID","VERNACULAR_NAME_TRANSLITERATED","DISTRIBUTION_INVALID","DISTRIBUTION_AREA_INVALID","DISTRIBUTION_STATUS_INVALID","DISTRIBUTION_GAZETEER_INVALID","MEDIA_CREATED_DATE_INVALID","UNPARSABLE_YEAR","UNLIKELY_YEAR","MULTIPLE_PUBLISHED_IN_REFERENCES","UNPARSABLE_REFERENCE","UNPARSABLE_REFERENCE_TYPE","UNMATCHED_REFERENCE_BRACKETS","CITATION_CONTAINER_TITLE_UNPARSED","CITATION_DETAILS_UNPARSED","CITATION_AUTHORS_UNPARSED","CITATION_UNPARSED","UNPARSABLE_TREATMENT","UNPARSABLE_TREAMENT_FORMAT","ESTIMATE_INVALID","ESTIMATE_TYPE_INVALID","INVISIBLE_CHARACTERS","HOMOGLYPH_CHARACTERS","RELATED_NAME_MISSING","DIACRITIC_CHARACTERS","MULTI_WORD_MONOMIAL","WRONG_MONOMIAL_CASE","AUTHORSHIP_REMOVED","DOI_NOT_FOUND","DOI_UNRESOLVED","TYPE_MATERIAL_SEX_INVALID","IDENTIFIER_WITHOUT_SCOPE","HOMOTYPIC_CONSOLIDATION","SYNC_OUTSIDE_TARGET","MULTIPLE_BASIONYMS","PUBLISHED_YEAR_CONFLICT","MULTILINE_RECORD","NOTHO_INVALID","ORIGINAL_SPELLING_INVALID","UNINOMIAL_FIELD_MISPLACED","INFRAGENERIC_FIELD_MISPLACED","ORDINAL_INVALID","GENDER_INVALID","GENDER_AGREEMENT_NOT_APPLICABLE","NOTHO_NOT_APPLICABLE","VERNACULAR_PREFERRED","DOI_INVALID","RANK_NAME_SUFFIX_CONFLICT","AUTHORSHIP_UNLIKELY","NAME_PHRASE_UNLIKELY","VERNACULAR_NAME_UNLIKELY","PARENT_GENUS_MISSING","NO_SPECIES_INCLUDED","SYNONYM_RANK_DIFFERS","SYNONYM_WITH_TAXON_PROPERTY","NOMINOTYPICAL_AUTHORSHIP_DIFFERS","NOMENCLATURAL_CODE_DIFFERS","MISSING_AUTHORSHIP","MISSPELLING_CONSOLIDATION","BAD_BASIONYM_AUTHORSHIP","DISTRIBUTION_GAZETTEER_CONFLICT","MATCHING_AMBIGUOUS","MATCHING_NONE","MATCHING_UNSUPPORTED","MATCHING_HIGHERRANK","DUPLICATE_DISTRIBUTIONS","DUPLICATE_MEDIA","DUPLICATE_VERNACULAR_NAMES","DUPLICATE_ESTIMATES","DUPLICATE_TAXON_PROPERTIES"]}}},{"name":"q","in":"query","description":"Simple full text search parameter. The value for this parameter can be a simple word or a phrase. Wildcards are not supported","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Controls the number of results in the page. Using too high a value will be overwritten with the default maximum threshold, depending on the service. Sensible defaults are used so this may be omitted.","schema":{"type":"integer","format":"int32","minimum":0}},{"name":"offset","in":"query","description":"Determines the offset for the search results. A limit of 20 and offset of 40 will get the third page of 20 results. Some services have a maximum offset.","schema":{"type":"integer","format":"int32","minimum":0}}],"responses":{"200":{"description":"Name usages found","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NameUsageSuggestResult"}}}}}}}},"/taxon/search/{datasetKey}":{"get":{"tags":["Searching names","Taxon"],"summary":"Full text search over name usages","description":"Full-text search of name usages covering the scientific and vernacular names.\n\nResults are ordered by relevance by default as this search usually returns a lot of results.","operationId":"searchNames","parameters":[{"name":"datasetKey","in":"path","description":"UUID for the dataset key","required":true,"schema":{"type":"string","format":"uuid"},"example":"2d59e5db-57ad-41ff-97d6-11f5fb264527"},{"name":"taxonID","in":"query","description":"Filters by any of the higher Linnean rank keys. Note this is within the respective checklist and not searching NUB keys across all checklists.","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"taxonRank","in":"query","description":"Filters by taxonomic rank as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/rank.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["SUPERDOMAIN","DOMAIN","SUBDOMAIN","INFRADOMAIN","EMPIRE","REALM","SUBREALM","SUPERKINGDOM","KINGDOM","SUBKINGDOM","INFRAKINGDOM","SUPERPHYLUM","PHYLUM","SUBPHYLUM","INFRAPHYLUM","PARVPHYLUM","MICROPHYLUM","NANOPHYLUM","CLAUDIUS","GIGACLASS","MEGACLASS","SUPERCLASS","CLASS","SUBCLASS","INFRACLASS","SUBTERCLASS","PARVCLASS","SUPERDIVISION","DIVISION","SUBDIVISION","INFRADIVISION","SUPERLEGION","LEGION","SUBLEGION","INFRALEGION","MEGACOHORT","SUPERCOHORT","COHORT","SUBCOHORT","INFRACOHORT","GIGAORDER","MAGNORDER","GRANDORDER","MIRORDER","SUPERORDER","ORDER","NANORDER","HYPOORDER","MINORDER","SUBORDER","INFRAORDER","PARVORDER","SUPERSECTION_ZOOLOGY","SECTION_ZOOLOGY","SUBSECTION_ZOOLOGY","FALANX","GIGAFAMILY","MEGAFAMILY","GRANDFAMILY","SUPERFAMILY","EPIFAMILY","FAMILY","SUBFAMILY","INFRAFAMILY","SUPERTRIBE","TRIBE","SUBTRIBE","INFRATRIBE","SUPRAGENERIC_NAME","SUPERGENUS","GENUS","SUBGENUS","INFRAGENUS","SUPERSECTION_BOTANY","SECTION_BOTANY","SUBSECTION_BOTANY","SUPERSERIES","SERIES","SUBSERIES","INFRAGENERIC_NAME","SPECIES_AGGREGATE","SPECIES","INFRASPECIFIC_NAME","GREX","KLEPTON","SUBSPECIES","CULTIVAR_GROUP","CONVARIETY","INFRASUBSPECIFIC_NAME","PROLES","NATIO","ABERRATION","MORPH","SUPERVARIETY","VARIETY","SUBVARIETY","SUPERFORM","FORM","SUBFORM","PATHOVAR","BIOVAR","CHEMOVAR","MORPHOVAR","PHAGOVAR","SEROVAR","CHEMOFORM","FORMA_SPECIALIS","LUSUS","CULTIVAR","MUTATIO","STRAIN","OTHER","UNRANKED"]}}},{"name":"taxonomicStatus","in":"query","description":"Filters by the taxonomic status as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/taxonomicstatus.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["ACCEPTED","PROVISIONALLY_ACCEPTED","SYNONYM","AMBIGUOUS_SYNONYM","MISAPPLIED","BARE_NAME"]}}},{"name":"extinct","in":"query","description":"Filters by extinction status.","schema":{"type":"boolean"}},{"name":"environment","in":"query","description":"Filters by environment values as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/environment.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["BRACKISH","FRESHWATER","MARINE","TERRESTRIAL"]}}},{"name":"taxonomicGroup","in":"query","description":"Filters for name usages with a specific taxonomic group as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/taxgroup.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["Viruses","Prokaryotes","Bacteria","Archaea","Eukaryotes","Protists","Plants","Algae","Bryophytes","Pteridophytes","Angiosperms","Gymnosperms","Fungi","Ascomycetes","Basidiomycetes","Pseudofungi","OtherFungi","Animals","Arthropods","Insects","Coleoptera","Diptera","Lepidoptera","Hymenoptera","Hemiptera","Orthoptera","Trichoptera","OtherInsects","Arachnids","Crustacean","OtherArthropods","Molluscs","Gastropods","Bivalves","OtherMolluscs","Chordates","OtherAnimals"]}}},{"name":"nomenclaturalCode","in":"query","description":"Filters by the nomenclatural code as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/nomcode.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["BACTERIAL","BOTANICAL","CULTIVARS","PHYTO","VIRUS","ZOOLOGICAL","PHYLO"]}}},{"name":"nameType","in":"query","description":"Filters by the name type as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/nametype.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["SCIENTIFIC","VIRUS","HYBRID_FORMULA","INFORMAL","OTU","PLACEHOLDER","NO_NAME"]}}},{"name":"author","in":"query","description":"Filters for name usages with a specific author.","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"year","in":"query","description":"Filters for name usages with a specific publication year.","explode":true,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"name":"origin","in":"query","description":"Filters for name usages with a specific origin as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/datasetorigin.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["SOURCE","DENORMED_CLASSIFICATION","VERBATIM_PARENT","VERBATIM_ACCEPTED","VERBATIM_BASIONYM","AUTONYM","IMPLICIT_NAME","MISSING_ACCEPTED","BASIONYM_PLACEHOLDER","EX_AUTHOR_SYNONYM","USER","OTHER"]}}},{"name":"issue","in":"query","description":"A specific indexing issue as defined in ChecklistBanks vocabulary: https://api.checklistbank.org/vocab/issue.","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["NOT_INTERPRETED","ESCAPED_CHARACTERS","REFERENCE_ID_INVALID","ID_NOT_UNIQUE","URL_INVALID","PARTIAL_DATE","PREVIOUS_LINE_SKIPPED","SELF_REFERENCED_RELATION","UNPARSABLE_NAME","PARTIALLY_PARSABLE_NAME","UNPARSABLE_AUTHORSHIP","DOUBTFUL_NAME","INCONSISTENT_AUTHORSHIP","INCONSISTENT_NAME","PARSED_NAME_DIFFERS","UNUSUAL_NAME_CHARACTERS","MULTI_WORD_EPITHET","UPPERCASE_EPITHET","CONTAINS_REFERENCE","NULL_EPITHET","BLACKLISTED_EPITHET","SUBSPECIES_ASSIGNED","LC_MONOMIAL","INDETERMINED","HIGHER_RANK_BINOMIAL","QUESTION_MARKS_REMOVED","REPL_ENCLOSING_QUOTE","MISSING_GENUS","NOMENCLATURAL_STATUS_INVALID","AUTHORSHIP_CONTAINS_NOMENCLATURAL_NOTE","CONFLICTING_NOMENCLATURAL_STATUS","NOMENCLATURAL_CODE_INVALID","BASIONYM_AUTHOR_MISMATCH","BASIONYM_DERIVED","HOMOTYPIC_CONSOLIDATION_UNRESOLVED","CHAINED_BASIONYM","NAME_NOT_UNIQUE","POTENTIAL_CHRESONYM","PUBLISHED_BEFORE_GENUS","BASIONYM_ID_INVALID","RANK_INVALID","UNMATCHED_NAME_BRACKETS","TRUNCATED_NAME","DUPLICATE_NAME","NAME_VARIANT","AUTHORSHIP_CONTAINS_TAXONOMIC_NOTE","TYPE_STATUS_INVALID","LAT_LON_INVALID","ALTITUDE_INVALID","COUNTRY_INVALID","TAXON_VARIANT","TAXON_ID_INVALID","NAME_ID_INVALID","PARENT_ID_INVALID","ACCEPTED_ID_INVALID","ACCEPTED_NAME_MISSING","PARENT_SPECIES_MISSING","TAXONOMIC_STATUS_INVALID","PROVISIONAL_STATUS_INVALID","ENVIRONMENT_INVALID","IS_EXTINCT_INVALID","NAME_CONTAINS_EXTINCT_SYMBOL","GEOTIME_INVALID","SCRUTINIZER_DATE_INVALID","CHAINED_SYNONYM","PARENT_CYCLE","SYNONYM_PARENT","CLASSIFICATION_RANK_ORDER_INVALID","CLASSIFICATION_NOT_APPLIED","PARENT_NAME_MISMATCH","DERIVED_TAXONOMIC_STATUS","TAXONOMIC_STATUS_DOUBTFUL","SYNONYM_DATA_MOVED","SYNONYM_DATA_REMOVED","REFTYPE_INVALID","ACCORDING_TO_CONFLICT","VERNACULAR_NAME_INVALID","VERNACULAR_LANGUAGE_INVALID","VERNACULAR_SEX_INVALID","VERNACULAR_COUNTRY_INVALID","VERNACULAR_NAME_TRANSLITERATED","DISTRIBUTION_INVALID","DISTRIBUTION_AREA_INVALID","DISTRIBUTION_STATUS_INVALID","DISTRIBUTION_GAZETEER_INVALID","MEDIA_CREATED_DATE_INVALID","UNPARSABLE_YEAR","UNLIKELY_YEAR","MULTIPLE_PUBLISHED_IN_REFERENCES","UNPARSABLE_REFERENCE","UNPARSABLE_REFERENCE_TYPE","UNMATCHED_REFERENCE_BRACKETS","CITATION_CONTAINER_TITLE_UNPARSED","CITATION_DETAILS_UNPARSED","CITATION_AUTHORS_UNPARSED","CITATION_UNPARSED","UNPARSABLE_TREATMENT","UNPARSABLE_TREAMENT_FORMAT","ESTIMATE_INVALID","ESTIMATE_TYPE_INVALID","INVISIBLE_CHARACTERS","HOMOGLYPH_CHARACTERS","RELATED_NAME_MISSING","DIACRITIC_CHARACTERS","MULTI_WORD_MONOMIAL","WRONG_MONOMIAL_CASE","AUTHORSHIP_REMOVED","DOI_NOT_FOUND","DOI_UNRESOLVED","TYPE_MATERIAL_SEX_INVALID","IDENTIFIER_WITHOUT_SCOPE","HOMOTYPIC_CONSOLIDATION","SYNC_OUTSIDE_TARGET","MULTIPLE_BASIONYMS","PUBLISHED_YEAR_CONFLICT","MULTILINE_RECORD","NOTHO_INVALID","ORIGINAL_SPELLING_INVALID","UNINOMIAL_FIELD_MISPLACED","INFRAGENERIC_FIELD_MISPLACED","ORDINAL_INVALID","GENDER_INVALID","GENDER_AGREEMENT_NOT_APPLICABLE","NOTHO_NOT_APPLICABLE","VERNACULAR_PREFERRED","DOI_INVALID","RANK_NAME_SUFFIX_CONFLICT","AUTHORSHIP_UNLIKELY","NAME_PHRASE_UNLIKELY","VERNACULAR_NAME_UNLIKELY","PARENT_GENUS_MISSING","NO_SPECIES_INCLUDED","SYNONYM_RANK_DIFFERS","SYNONYM_WITH_TAXON_PROPERTY","NOMINOTYPICAL_AUTHORSHIP_DIFFERS","NOMENCLATURAL_CODE_DIFFERS","MISSING_AUTHORSHIP","MISSPELLING_CONSOLIDATION","BAD_BASIONYM_AUTHORSHIP","DISTRIBUTION_GAZETTEER_CONFLICT","MATCHING_AMBIGUOUS","MATCHING_NONE","MATCHING_UNSUPPORTED","MATCHING_HIGHERRANK","DUPLICATE_DISTRIBUTIONS","DUPLICATE_MEDIA","DUPLICATE_VERNACULAR_NAMES","DUPLICATE_ESTIMATES","DUPLICATE_TAXON_PROPERTIES"]}}},{"name":"searchType","in":"query","description":"The type of search to perform (e.g. FUZZY or WORDS).","schema":{"type":"string","enum":["WORDS","EXACT","FUZZY"]}},{"name":"searchContent","in":"query","description":"Restricts full-text search to specific fields. Defaults to scientific name only.","schema":{"type":"string","enum":["SCIENTIFIC","AUTHORSHIP","VERNACULAR"]}},{"name":"sortBy","in":"query","description":"Determines the sort order of results. Defaults to RELEVANCE.","schema":{"type":"string","enum":["NAME","TAXONOMIC","RELEVANCE"]}},{"name":"reverse","in":"query","description":"If true, reverses the sort order.","schema":{"type":"boolean"}},{"name":"q","in":"query","description":"Simple full text search parameter. The value for this parameter can be a simple word or a phrase. Wildcards are not supported","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Controls the number of results in the page. Using too high a value will be overwritten with the default maximum threshold, depending on the service. Sensible defaults are used so this may be omitted.","schema":{"type":"integer","format":"int32","minimum":0}},{"name":"offset","in":"query","description":"Determines the offset for the search results. A limit of 20 and offset of 40 will get the third page of 20 results. Some services have a maximum offset.","schema":{"type":"integer","format":"int32","minimum":0}},{"name":"facet","in":"query","description":"A facet name used to retrieve the most frequent values for a field. This parameter may be repeated to request multiple facets.","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"facetMinCount","in":"query","description":"Used in combination with the facet parameter. Set `facetMinCount={#}` to exclude facets with a count less than `{#}`.","schema":{"type":"integer","format":"int32"}},{"name":"facetMultiselect","in":"query","description":"Used in combination with the facet parameter. Set `facetMultiselect=true` to still return counts for values that are not currently filtered.","schema":{"type":"boolean"}},{"name":"facetLimit","in":"query","description":"Facet parameters allow paging requests using the parameters facetOffset and facetLimit","schema":{"type":"integer","format":"int32"}},{"name":"facetOffset","in":"query","description":"Facet parameters allow paging requests using the parameters facetOffset and facetLimit","schema":{"type":"integer","format":"int32","minimum":0}}],"responses":{"200":{"description":"Name usages found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponseNameUsageSearchResultNameUsageSearchParameter"}}}}}}},"/dataset/{datasetKey}/metrics":{"get":{"tags":["Checklist"],"summary":"Get import metrics for a checklist dataset","description":"Returns counts and statistics from the latest successful import of the given checklist dataset, including record counts by type (taxa, synonyms, vernacular names, distributions, media, references) and breakdowns by rank, nomenclatural code, name type, taxonomic status, and origin.","operationId":"getDatasetMetrics","parameters":[{"name":"datasetKey","in":"path","description":"UUID for the dataset key","required":true,"schema":{"type":"string","format":"uuid"},"example":"2d59e5db-57ad-41ff-97d6-11f5fb264527"}],"responses":{"200":{"description":"Dataset metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChecklistMetrics"}}}},"404":{"description":"Dataset not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChecklistMetrics"}}}}}}}},"components":{"schemas":{"NameUsage":{"type":"object","description":"Simplified taxon usage containing core taxonomic information","properties":{"taxonID":{"type":"string","description":"The unique identifier for this taxon","example":2435099},"scientificName":{"type":"string","description":"The scientific name without authorship","example":"Abies alba"},"scientificNameAuthorship":{"type":"string","description":"The authorship information for the scientific name","example":"Mill."},"taxonRank":{"type":"string","description":"The taxonomic rank of the taxon","enum":["SUPERDOMAIN","DOMAIN","SUBDOMAIN","INFRADOMAIN","EMPIRE","REALM","SUBREALM","SUPERKINGDOM","KINGDOM","SUBKINGDOM","INFRAKINGDOM","SUPERPHYLUM","PHYLUM","SUBPHYLUM","INFRAPHYLUM","PARVPHYLUM","MICROPHYLUM","NANOPHYLUM","CLAUDIUS","GIGACLASS","MEGACLASS","SUPERCLASS","CLASS","SUBCLASS","INFRACLASS","SUBTERCLASS","PARVCLASS","SUPERDIVISION","DIVISION","SUBDIVISION","INFRADIVISION","SUPERLEGION","LEGION","SUBLEGION","INFRALEGION","MEGACOHORT","SUPERCOHORT","COHORT","SUBCOHORT","INFRACOHORT","GIGAORDER","MAGNORDER","GRANDORDER","MIRORDER","SUPERORDER","ORDER","NANORDER","HYPOORDER","MINORDER","SUBORDER","INFRAORDER","PARVORDER","SUPERSECTION_ZOOLOGY","SECTION_ZOOLOGY","SUBSECTION_ZOOLOGY","FALANX","GIGAFAMILY","MEGAFAMILY","GRANDFAMILY","SUPERFAMILY","EPIFAMILY","FAMILY","SUBFAMILY","INFRAFAMILY","SUPERTRIBE","TRIBE","SUBTRIBE","INFRATRIBE","SUPRAGENERIC_NAME","SUPERGENUS","GENUS","SUBGENUS","INFRAGENUS","SUPERSECTION_BOTANY","SECTION_BOTANY","SUBSECTION_BOTANY","SUPERSERIES","SERIES","SUBSERIES","INFRAGENERIC_NAME","SPECIES_AGGREGATE","SPECIES","INFRASPECIFIC_NAME","GREX","KLEPTON","SUBSPECIES","CULTIVAR_GROUP","CONVARIETY","INFRASUBSPECIFIC_NAME","PROLES","NATIO","ABERRATION","MORPH","SUPERVARIETY","VARIETY","SUBVARIETY","SUPERFORM","FORM","SUBFORM","PATHOVAR","BIOVAR","CHEMOVAR","MORPHOVAR","PHAGOVAR","SEROVAR","CHEMOFORM","FORMA_SPECIALIS","LUSUS","CULTIVAR","MUTATIO","STRAIN","OTHER","UNRANKED"],"example":"SPECIES"},"label":{"type":"string","description":"HTML formatted name with authorship and extinct dagger if applicable","example":"<i>Abies alba</i> Mill."},"datasetKey":{"type":"string","format":"uuid","description":"The identifier for the dataset","example":"7ddf754f-d193-4cc9-b351-99906754a03b"},"acceptedNameUsageID":{"type":"string","description":"The identifier of the accepted taxon (for synonyms)","example":2435098},"parentNameUsageID":{"type":"string","description":"The identifier of the parent taxon in the classification","example":2435001},"taxonomicStatus":{"type":"string","description":"The taxonomic status of the taxon (e.g., accepted, synonym)","enum":["ACCEPTED","PROVISIONALLY_ACCEPTED","SYNONYM","AMBIGUOUS_SYNONYM","MISAPPLIED","BARE_NAME"],"example":"accepted"},"nomenclaturalCode":{"type":"string","description":"The nomenclatural code governing the taxon name","example":"BOTANICAL"},"extinct":{"type":"boolean","description":"Indicates whether the taxon is extinct","example":false},"references":{"type":"string","format":"uri","description":"A link to a webpage for this name on the original, external site (dc:references)","example":"https://www.speciesplus.net/#/taxon_concepts/10836"},"threatStatus":{"type":"string","description":"The IUCN Red List threat status for this taxon. Only populated when this usage appears in a RelatedInfo.redlist context. Values follow IUCN Red List categories: EX (Extinct), EW (Extinct in the Wild), CR (Critically Endangered), EN (Endangered), VU (Vulnerable), NT (Near Threatened), LC (Least Concern), DD (Data Deficient), NE (Not Evaluated).","example":"LC"},"citesAppendix":{"type":"string","description":"The CITES appendix under which this taxon is listed. Only populated when this usage appears in a RelatedInfo.cites context. Appendix I: species threatened with extinction; Appendix II: species not necessarily threatened but requiring trade controls; Appendix III: species protected in at least one country.","example":"II"}},"required":["datasetKey","label","scientificName","taxonID","taxonRank","taxonomicStatus"]},"ClassificationUsage":{"type":"object","description":"Extremely simple taxon usage containing only the name and taxonID. Suitable for long classification lists.","properties":{"taxonID":{"type":"string","description":"The unique identifier for this taxon","example":2435099},"scientificName":{"type":"string","description":"The scientific name without authorship","example":"Abies alba"},"scientificNameAuthorship":{"type":"string","description":"The authorship information for the scientific name","example":"Mill."},"taxonRank":{"type":"string","description":"The taxonomic rank of the taxon","enum":["SUPERDOMAIN","DOMAIN","SUBDOMAIN","INFRADOMAIN","EMPIRE","REALM","SUBREALM","SUPERKINGDOM","KINGDOM","SUBKINGDOM","INFRAKINGDOM","SUPERPHYLUM","PHYLUM","SUBPHYLUM","INFRAPHYLUM","PARVPHYLUM","MICROPHYLUM","NANOPHYLUM","CLAUDIUS","GIGACLASS","MEGACLASS","SUPERCLASS","CLASS","SUBCLASS","INFRACLASS","SUBTERCLASS","PARVCLASS","SUPERDIVISION","DIVISION","SUBDIVISION","INFRADIVISION","SUPERLEGION","LEGION","SUBLEGION","INFRALEGION","MEGACOHORT","SUPERCOHORT","COHORT","SUBCOHORT","INFRACOHORT","GIGAORDER","MAGNORDER","GRANDORDER","MIRORDER","SUPERORDER","ORDER","NANORDER","HYPOORDER","MINORDER","SUBORDER","INFRAORDER","PARVORDER","SUPERSECTION_ZOOLOGY","SECTION_ZOOLOGY","SUBSECTION_ZOOLOGY","FALANX","GIGAFAMILY","MEGAFAMILY","GRANDFAMILY","SUPERFAMILY","EPIFAMILY","FAMILY","SUBFAMILY","INFRAFAMILY","SUPERTRIBE","TRIBE","SUBTRIBE","INFRATRIBE","SUPRAGENERIC_NAME","SUPERGENUS","GENUS","SUBGENUS","INFRAGENUS","SUPERSECTION_BOTANY","SECTION_BOTANY","SUBSECTION_BOTANY","SUPERSERIES","SERIES","SUBSERIES","INFRAGENERIC_NAME","SPECIES_AGGREGATE","SPECIES","INFRASPECIFIC_NAME","GREX","KLEPTON","SUBSPECIES","CULTIVAR_GROUP","CONVARIETY","INFRASUBSPECIFIC_NAME","PROLES","NATIO","ABERRATION","MORPH","SUPERVARIETY","VARIETY","SUBVARIETY","SUPERFORM","FORM","SUBFORM","PATHOVAR","BIOVAR","CHEMOVAR","MORPHOVAR","PHAGOVAR","SEROVAR","CHEMOFORM","FORMA_SPECIALIS","LUSUS","CULTIVAR","MUTATIO","STRAIN","OTHER","UNRANKED"],"example":"SPECIES"},"label":{"type":"string","description":"HTML formatted name with authorship and extinct dagger if applicable","example":"<i>Abies alba</i> Mill."}},"required":["label","scientificName","taxonID","taxonRank"]},"Distribution":{"type":"object","description":"Geographic distribution information for a taxon, based on the GBIF Distribution extension","properties":{"datasetKey":{"type":"string","format":"uuid","description":"The identifier for the dataset","example":"7ddf754f-d193-4cc9-b351-99906754a03b"},"taxonID":{"type":"string","description":"The unique identifier for this taxon (dwc:taxonID)","example":2435099},"locationID":{"type":"string","description":"A CURIE identifier (scope:id) for the named area (dwc:locationID), where the scope indicates the gazetteer. Supported gazetteers: ISO (2-letter country codes), TDWG (World Geographical Scheme for Recording Plant Distributions), TEOW (Terrestrial Ecoregions of the World), LONGHURST (Longhurst biogeographical provinces), FAO (FAO fishing areas), WGSRPD (TDWG regions). See https://github.com/CatalogueOfLife/coldp/blob/master/README.md#areaid","example":"TDWG:GER"},"locality":{"type":"string","description":"The specific description of the place (dwc:locality). The verbatim name of the area as used in the source.","example":"Central European Mountains"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code (dwc:countryCode)","example":"DE"},"lifeStage":{"type":"string","description":"The age class or life stage of the organisms to which this distribution applies (dwc:lifeStage)","example":"adult"},"establishmentMeans":{"type":"string","description":"The process by which the organism became established at the location (dwc:establishmentMeans). Recommended values: native, introduced, naturalised, invasive, managed, uncertain.","example":"native"},"degreeOfEstablishment":{"type":"string","description":"The degree to which an organism survives, reproduces, and expands its range at the given place (dwc:degreeOfEstablishment). Recommended values from the IUCN Invasive Species framework.","example":"established"},"pathway":{"type":"string","description":"The process by which an organism came to be in a given place at a given time (dwc:pathway). Recommended best practice is to use a controlled vocabulary such as the CBD pathway vocabulary.","example":"escape_from_cultivation"},"isInvasive":{"type":"boolean","description":"Flag to indicate that the introduced taxon is considered to be invasive in the given area","example":true},"threatStatus":{"type":"string","description":"The IUCN Red List or equivalent threat/conservation status for the taxon in this location. Recommended values: EX, EW, CR, EN, VU, NT, LC, DD, NE.","example":"LC"},"eventDate":{"type":"string","description":"The date or date range during which this distribution record is valid (dwc:eventDate). Recommended best practice is to use an encoding scheme such as ISO 8601.","example":"2020-06-15"},"referenceID":{"type":"string","description":"Identifier for the bibliographic reference which is the source of this distribution record","example":"R5678"},"remarks":{"type":"string","description":"Additional remarks or notes about this distribution record (dwc:occurrenceRemarks)","example":"Common in mountain forests above 1000m elevation"}},"required":["datasetKey","taxonID"]},"MeasurementOrFact":{"type":"object","description":"A measurement, fact, characteristic, or assertion about a taxon. Based on Darwin Core MeasurementOrFact.","properties":{"measurementType":{"type":"string","description":"The nature of the measurement, fact, characteristic, or assertion (dwc:measurementType). Recommended best practice is to use a controlled vocabulary.","example":"tail length"},"measurementValue":{"type":"string","description":"The value of the measurement, fact, characteristic, or assertion (dwc:measurementValue).","example":45},"measurementRemarks":{"type":"string","description":"Comments or notes accompanying the MeasurementOrFact (dwc:measurementRemarks).","example":"Measurement taken from preserved specimen"}},"required":["measurementType","measurementValue"]},"Media":{"type":"object","description":"Media item (image, video, sound, etc.) associated with a taxon, based on the GBIF Simple Multimedia extension","properties":{"identifier":{"type":"string","description":"A public URL that is a direct link to the media file itself, not an HTML page (dc:identifier). For images this should be a URL to the image file, not a webpage displaying it.","example":"https://example.com/images/abies-alba.jpg"},"type":{"type":"string","description":"The Dublin Core type of the media object. Recommended values: StillImage, MovingImage, Sound, InteractiveResource, Text.","example":"StillImage"},"title":{"type":"string","description":"The title or caption for the media item (dc:title)","example":"Abies alba cone and needles"},"created":{"type":"string","format":"date","description":"The date the media item was created (dc:created) in ISO 8601 format.","example":"2020-06-15"},"creator":{"type":"string","description":"The person or organisation that created the media item (dc:creator)","example":"John Smith"},"license":{"type":"string","description":"The license or rights statement for the media object (dc:license). Preferably a Creative Commons URI or SPDX identifier.","example":"http://creativecommons.org/licenses/by/4.0/"},"references":{"type":"string","format":"uri","description":"A URL for a webpage that shows the media item and associated metadata (dc:references)","example":"https://example.com/media/details/12345"},"source":{"type":"string","description":"A bibliographic citation for the original source of the media item (dc:source)","example":"iNaturalist observation #67890"},"remarks":{"type":"string","description":"Additional remarks or notes about this media item","example":"Specimen photographed in natural habitat"}},"required":["identifier"]},"NameUsageInfo":{"type":"object","description":"Comprehensive taxon information including all related data such as vernacular names, synonyms, media, distributions, and bibliography","properties":{"taxonID":{"type":"string","description":"The unique identifier for this taxon","example":2435099},"scientificName":{"type":"string","description":"The scientific name without authorship","example":"Abies alba"},"scientificNameAuthorship":{"type":"string","description":"The authorship information for the scientific name","example":"Mill."},"taxonRank":{"type":"string","description":"The taxonomic rank of the taxon","enum":["SUPERDOMAIN","DOMAIN","SUBDOMAIN","INFRADOMAIN","EMPIRE","REALM","SUBREALM","SUPERKINGDOM","KINGDOM","SUBKINGDOM","INFRAKINGDOM","SUPERPHYLUM","PHYLUM","SUBPHYLUM","INFRAPHYLUM","PARVPHYLUM","MICROPHYLUM","NANOPHYLUM","CLAUDIUS","GIGACLASS","MEGACLASS","SUPERCLASS","CLASS","SUBCLASS","INFRACLASS","SUBTERCLASS","PARVCLASS","SUPERDIVISION","DIVISION","SUBDIVISION","INFRADIVISION","SUPERLEGION","LEGION","SUBLEGION","INFRALEGION","MEGACOHORT","SUPERCOHORT","COHORT","SUBCOHORT","INFRACOHORT","GIGAORDER","MAGNORDER","GRANDORDER","MIRORDER","SUPERORDER","ORDER","NANORDER","HYPOORDER","MINORDER","SUBORDER","INFRAORDER","PARVORDER","SUPERSECTION_ZOOLOGY","SECTION_ZOOLOGY","SUBSECTION_ZOOLOGY","FALANX","GIGAFAMILY","MEGAFAMILY","GRANDFAMILY","SUPERFAMILY","EPIFAMILY","FAMILY","SUBFAMILY","INFRAFAMILY","SUPERTRIBE","TRIBE","SUBTRIBE","INFRATRIBE","SUPRAGENERIC_NAME","SUPERGENUS","GENUS","SUBGENUS","INFRAGENUS","SUPERSECTION_BOTANY","SECTION_BOTANY","SUBSECTION_BOTANY","SUPERSERIES","SERIES","SUBSERIES","INFRAGENERIC_NAME","SPECIES_AGGREGATE","SPECIES","INFRASPECIFIC_NAME","GREX","KLEPTON","SUBSPECIES","CULTIVAR_GROUP","CONVARIETY","INFRASUBSPECIFIC_NAME","PROLES","NATIO","ABERRATION","MORPH","SUPERVARIETY","VARIETY","SUBVARIETY","SUPERFORM","FORM","SUBFORM","PATHOVAR","BIOVAR","CHEMOVAR","MORPHOVAR","PHAGOVAR","SEROVAR","CHEMOFORM","FORMA_SPECIALIS","LUSUS","CULTIVAR","MUTATIO","STRAIN","OTHER","UNRANKED"],"example":"SPECIES"},"label":{"type":"string","description":"HTML formatted name with authorship and extinct dagger if applicable","example":"<i>Abies alba</i> Mill."},"datasetKey":{"type":"string","format":"uuid","description":"The identifier for the dataset","example":"7ddf754f-d193-4cc9-b351-99906754a03b"},"acceptedNameUsageID":{"type":"string","description":"The identifier of the accepted taxon (for synonyms)","example":2435098},"parentNameUsageID":{"type":"string","description":"The identifier of the parent taxon in the classification","example":2435001},"taxonomicStatus":{"type":"string","description":"The taxonomic status of the taxon (e.g., accepted, synonym)","enum":["ACCEPTED","PROVISIONALLY_ACCEPTED","SYNONYM","AMBIGUOUS_SYNONYM","MISAPPLIED","BARE_NAME"],"example":"accepted"},"nomenclaturalCode":{"type":"string","description":"The nomenclatural code governing the taxon name","example":"BOTANICAL"},"extinct":{"type":"boolean","description":"Indicates whether the taxon is extinct","example":false},"references":{"type":"string","format":"uri","description":"A link to a webpage for this name on the original, external site (dc:references)","example":"https://www.speciesplus.net/#/taxon_concepts/10836"},"threatStatus":{"type":"string","description":"The IUCN Red List threat status for this taxon. Only populated when this usage appears in a RelatedInfo.redlist context. Values follow IUCN Red List categories: EX (Extinct), EW (Extinct in the Wild), CR (Critically Endangered), EN (Endangered), VU (Vulnerable), NT (Near Threatened), LC (Least Concern), DD (Data Deficient), NE (Not Evaluated).","example":"LC"},"citesAppendix":{"type":"string","description":"The CITES appendix under which this taxon is listed. Only populated when this usage appears in a RelatedInfo.cites context. Appendix I: species threatened with extinction; Appendix II: species not necessarily threatened but requiring trade controls; Appendix III: species protected in at least one country.","example":"II"},"acceptedNameUsage":{"type":"string","description":"The accepted name usage (for synonyms)","example":"Abies alba Mill."},"originalNameUsageID":{"type":"string","description":"The identifier of the original name usage (basionym)","example":2435090},"originalNameUsage":{"type":"string","description":"The original name usage (basionym)","example":"Pinus alba Mill."},"nameAccordingTo":{"type":"string","description":"The taxon concept reference","example":"Smith 2020"},"namePublishedInID":{"type":"string","description":"The bibliographic reference identifier for the publication where the name was first published","example":"Greuter1998"},"nameType":{"type":"string","description":"The type of name (e.g., scientific, informal)","enum":["SCIENTIFIC","VIRUS","HYBRID_FORMULA","INFORMAL","OTU","PLACEHOLDER","NO_NAME"],"example":"SCIENTIFIC"},"namePhrase":{"type":"string","description":"An optional phrase appended to the name","example":"sensu lato"},"nomenclaturalStatus":{"type":"string","description":"The nomenclatural status of the name","example":"valid"},"genericName":{"type":"string","description":"The genus component of the scientific name","example":"Abies"},"infragenericEpithet":{"type":"string","description":"The infrageneric epithet (subgenus, section, etc.)","example":"Pseudotsuga"},"specificEpithet":{"type":"string","description":"The specific epithet (species name)","example":"alba"},"infraspecificEpithet":{"type":"string","description":"The infraspecific epithet (subspecies, variety, form)","example":"alpina"},"cultivarEpithet":{"type":"string","description":"The cultivar epithet for cultivated varieties","example":"Golden Sprite"},"environment":{"type":"array","description":"Environments where the taxon occurs (marine, freshwater, terrestrial, brackish)","example":["terrestrial","freshwater"],"items":{"type":"string"}},"taxonomicGroup":{"type":"string","description":"The major taxonomic group the taxon is considered in","enum":["Viruses","Prokaryotes","Bacteria","Archaea","Eukaryotes","Protists","Plants","Algae","Bryophytes","Pteridophytes","Angiosperms","Gymnosperms","Fungi","Ascomycetes","Basidiomycetes","Pseudofungi","OtherFungi","Animals","Arthropods","Insects","Coleoptera","Diptera","Lepidoptera","Hymenoptera","Hemiptera","Orthoptera","Trichoptera","OtherInsects","Arachnids","Crustacean","OtherArthropods","Molluscs","Gastropods","Bivalves","OtherMolluscs","Chordates","OtherAnimals"],"example":"Gymnosperms"},"issues":{"type":"array","description":"List of data quality issues using ChecklistBank issue vocabulary","example":["PUBLISHED_BEFORE_1753","BASIONYM_ID_INVALID"],"items":{"type":"string"}},"taxonRemarks":{"type":"string","description":"Remarks or notes about the taxon","example":"Common in mountainous regions of Europe"},"checklistbankURL":{"type":"string","format":"uri","description":"Link to the taxon page on ChecklistBank","example":"https://www.checklistbank.org/dataset/3/taxon/2435099"},"classification":{"type":"array","description":"Ordered list of parent taxa from the root of the classification down to the direct parent of this taxon","items":{"$ref":"#/components/schemas/ClassificationUsage"}},"synonyms":{"$ref":"#/components/schemas/Synonymy","description":"List of synonyms and nomenclatural combinations for the taxon"},"vernacularNames":{"type":"array","description":"List of vernacular (common) names for the taxon","items":{"$ref":"#/components/schemas/VernacularName"}},"media":{"type":"array","description":"Media items (images, videos, sounds) associated with the taxon","items":{"$ref":"#/components/schemas/Media"}},"distributions":{"type":"array","description":"Distribution information for the taxon","items":{"$ref":"#/components/schemas/Distribution"}},"bibliography":{"type":"array","description":"Bibliographic references related to the taxon, keyed by their identifier. A lookup for referenceIDs found in taxon, distributions or vernacular names.","items":{"$ref":"#/components/schemas/Reference"}},"measurementOrFacts":{"type":"array","description":"Measurements or facts about the taxon","items":{"$ref":"#/components/schemas/MeasurementOrFact"}}},"required":["checklistbankURL","datasetKey","label","nameType","scientificName","taxonID","taxonRank","taxonomicStatus"]},"Reference":{"type":"object","description":"A bibliographic reference or citation for a taxon","properties":{"referenceID":{"type":"string","description":"An identifier for the reference in the dataset","example":"Smith2020"},"doi":{"type":"string","description":"The Digital Object Identifier (DOI) for the reference","example":"10.1234/example.doi"},"citation":{"type":"string","description":"The full, unparsed bibliographic citation for the reference (dc:bibliographicCitation). Should include author(s), year, title, journal/book, volume, pages.","example":"Smith, J. & Jones, A. (2020). New Species of Abies. Journal of Botany, 45(2), 123-145."},"url":{"type":"string","description":"A link to the publication","example":"https://www.biodiversitylibrary.org/page/52334711#page/531/mode/1up"},"remarks":{"type":"string","description":"Taxon-specific annotation or notes about how this reference relates to the taxon (dwc:taxonRemarks)","example":"Original description of the species"}},"required":["referenceID"]},"Synonymy":{"type":"object","description":"Synonyms of a taxon organized by nomenclatural relationship type","properties":{"homotypic":{"type":"array","description":"Homotypic (nomenclatural) synonyms that share the same type specimen as the accepted name. These names are synonyms purely due to nomenclatural rules.","items":{"$ref":"#/components/schemas/NameUsage"}},"heterotypic":{"type":"array","description":"Heterotypic (taxonomic) synonyms based on different type specimens, grouped by their common basionym. Each inner list represents a homotypic group of names considered synonymous for taxonomic reasons.","items":{"type":"array","items":{"$ref":"#/components/schemas/NameUsage"}}},"misapplied":{"type":"array","description":"Names that have been misapplied to this taxon in literature, i.e. used for a different taxon than the one they were originally described for.","items":{"$ref":"#/components/schemas/NameUsage"}}}},"VernacularName":{"type":"object","description":"A common or vernacular name for a taxon, based on the GBIF Vernacular Name extension","properties":{"vernacularName":{"type":"string","description":"The vernacular (common) name","example":"Silver Fir"},"language":{"type":"string","description":"The language of the vernacular name (ISO 639-2 code)","example":"eng"},"temporal":{"type":"string","description":"Temporal context specifying when the vernacular name was or is in use. May be a year range or period description.","example":"1900-2000"},"locality":{"type":"string","description":"The specific description of the place where this vernacular name is used (dwc:locality)","example":"Bavaria, southern Germany"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 or alpha-3 country code where this name is used (dwc:countryCode)","example":"DE"},"sex":{"type":"string","description":"The sex of the biological individual(s) to which this vernacular name applies (dwc:sex). Useful for species where different sexes are known by different common names.","example":"male"},"preferredName":{"type":"boolean","description":"Indicates if this vernacular name is the preferred or most widely used common name for this taxon","example":true},"referenceID":{"type":"string","description":"Identifier for the bibliographic reference which is the source of this vernacular name","example":23456},"remarks":{"type":"string","description":"Additional context or notes qualifying the usage of this vernacular name (dwc:taxonRemarks)","example":"Commonly used in forestry contexts"}},"required":["vernacularName"]},"TaxonBreakdown":{"type":"object","description":"Hierarchical breakdown of accepted taxa with species counts at each level","properties":{"taxonID":{"type":"string","description":"The unique identifier for this taxon (dwc:taxonID)","example":2435099},"taxonRank":{"type":"string","description":"The taxonomic rank of the taxon (dwc:taxonRank)","enum":["SUPERDOMAIN","DOMAIN","SUBDOMAIN","INFRADOMAIN","EMPIRE","REALM","SUBREALM","SUPERKINGDOM","KINGDOM","SUBKINGDOM","INFRAKINGDOM","SUPERPHYLUM","PHYLUM","SUBPHYLUM","INFRAPHYLUM","PARVPHYLUM","MICROPHYLUM","NANOPHYLUM","CLAUDIUS","GIGACLASS","MEGACLASS","SUPERCLASS","CLASS","SUBCLASS","INFRACLASS","SUBTERCLASS","PARVCLASS","SUPERDIVISION","DIVISION","SUBDIVISION","INFRADIVISION","SUPERLEGION","LEGION","SUBLEGION","INFRALEGION","MEGACOHORT","SUPERCOHORT","COHORT","SUBCOHORT","INFRACOHORT","GIGAORDER","MAGNORDER","GRANDORDER","MIRORDER","SUPERORDER","ORDER","NANORDER","HYPOORDER","MINORDER","SUBORDER","INFRAORDER","PARVORDER","SUPERSECTION_ZOOLOGY","SECTION_ZOOLOGY","SUBSECTION_ZOOLOGY","FALANX","GIGAFAMILY","MEGAFAMILY","GRANDFAMILY","SUPERFAMILY","EPIFAMILY","FAMILY","SUBFAMILY","INFRAFAMILY","SUPERTRIBE","TRIBE","SUBTRIBE","INFRATRIBE","SUPRAGENERIC_NAME","SUPERGENUS","GENUS","SUBGENUS","INFRAGENUS","SUPERSECTION_BOTANY","SECTION_BOTANY","SUBSECTION_BOTANY","SUPERSERIES","SERIES","SUBSERIES","INFRAGENERIC_NAME","SPECIES_AGGREGATE","SPECIES","INFRASPECIFIC_NAME","GREX","KLEPTON","SUBSPECIES","CULTIVAR_GROUP","CONVARIETY","INFRASUBSPECIFIC_NAME","PROLES","NATIO","ABERRATION","MORPH","SUPERVARIETY","VARIETY","SUBVARIETY","SUPERFORM","FORM","SUBFORM","PATHOVAR","BIOVAR","CHEMOVAR","MORPHOVAR","PHAGOVAR","SEROVAR","CHEMOFORM","FORMA_SPECIALIS","LUSUS","CULTIVAR","MUTATIO","STRAIN","OTHER","UNRANKED"],"example":"FAMILY"},"scientificName":{"type":"string","description":"The scientific name of the taxon without authorship (dwc:scientificName)","example":"Pinaceae"},"species":{"type":"integer","format":"int32","description":"The number of accepted species within this taxon","example":250},"breakdown":{"type":"array","description":"Nested breakdown by all descendant taxa sharing the highest major Linnean rank","items":{"$ref":"#/components/schemas/TaxonBreakdown"}}},"required":["scientificName","taxonID","taxonRank"]},"PagingResponseTreeUsage":{"type":"object","properties":{"endOfRecords":{"type":"boolean","description":"True if this page of search results is the final page."},"count":{"type":"integer","format":"int64","description":"The total number of records returned by the search."},"results":{"type":"array","description":"Search results.","items":{"$ref":"#/components/schemas/TreeUsage"}}}},"TreeUsage":{"type":"object","description":"Extended simple usage for tree navigation with species counts","properties":{"taxonID":{"type":"string","description":"The unique identifier for this taxon","example":2435099},"scientificName":{"type":"string","description":"The scientific name without authorship","example":"Abies alba"},"scientificNameAuthorship":{"type":"string","description":"The authorship information for the scientific name","example":"Mill."},"taxonRank":{"type":"string","description":"The taxonomic rank of the taxon","enum":["SUPERDOMAIN","DOMAIN","SUBDOMAIN","INFRADOMAIN","EMPIRE","REALM","SUBREALM","SUPERKINGDOM","KINGDOM","SUBKINGDOM","INFRAKINGDOM","SUPERPHYLUM","PHYLUM","SUBPHYLUM","INFRAPHYLUM","PARVPHYLUM","MICROPHYLUM","NANOPHYLUM","CLAUDIUS","GIGACLASS","MEGACLASS","SUPERCLASS","CLASS","SUBCLASS","INFRACLASS","SUBTERCLASS","PARVCLASS","SUPERDIVISION","DIVISION","SUBDIVISION","INFRADIVISION","SUPERLEGION","LEGION","SUBLEGION","INFRALEGION","MEGACOHORT","SUPERCOHORT","COHORT","SUBCOHORT","INFRACOHORT","GIGAORDER","MAGNORDER","GRANDORDER","MIRORDER","SUPERORDER","ORDER","NANORDER","HYPOORDER","MINORDER","SUBORDER","INFRAORDER","PARVORDER","SUPERSECTION_ZOOLOGY","SECTION_ZOOLOGY","SUBSECTION_ZOOLOGY","FALANX","GIGAFAMILY","MEGAFAMILY","GRANDFAMILY","SUPERFAMILY","EPIFAMILY","FAMILY","SUBFAMILY","INFRAFAMILY","SUPERTRIBE","TRIBE","SUBTRIBE","INFRATRIBE","SUPRAGENERIC_NAME","SUPERGENUS","GENUS","SUBGENUS","INFRAGENUS","SUPERSECTION_BOTANY","SECTION_BOTANY","SUBSECTION_BOTANY","SUPERSERIES","SERIES","SUBSERIES","INFRAGENERIC_NAME","SPECIES_AGGREGATE","SPECIES","INFRASPECIFIC_NAME","GREX","KLEPTON","SUBSPECIES","CULTIVAR_GROUP","CONVARIETY","INFRASUBSPECIFIC_NAME","PROLES","NATIO","ABERRATION","MORPH","SUPERVARIETY","VARIETY","SUBVARIETY","SUPERFORM","FORM","SUBFORM","PATHOVAR","BIOVAR","CHEMOVAR","MORPHOVAR","PHAGOVAR","SEROVAR","CHEMOFORM","FORMA_SPECIALIS","LUSUS","CULTIVAR","MUTATIO","STRAIN","OTHER","UNRANKED"],"example":"SPECIES"},"label":{"type":"string","description":"HTML formatted name with authorship and extinct dagger if applicable","example":"<i>Abies alba</i> Mill."},"datasetKey":{"type":"string","format":"uuid","description":"The identifier for the dataset","example":"7ddf754f-d193-4cc9-b351-99906754a03b"},"acceptedNameUsageID":{"type":"string","description":"The identifier of the accepted taxon (for synonyms)","example":2435098},"parentNameUsageID":{"type":"string","description":"The identifier of the parent taxon in the classification","example":2435001},"taxonomicStatus":{"type":"string","description":"The taxonomic status of the taxon (e.g., accepted, synonym)","enum":["ACCEPTED","PROVISIONALLY_ACCEPTED","SYNONYM","AMBIGUOUS_SYNONYM","MISAPPLIED","BARE_NAME"],"example":"accepted"},"nomenclaturalCode":{"type":"string","description":"The nomenclatural code governing the taxon name","example":"BOTANICAL"},"extinct":{"type":"boolean","description":"Indicates whether the taxon is extinct","example":false},"references":{"type":"string","format":"uri","description":"A link to a webpage for this name on the original, external site (dc:references)","example":"https://www.speciesplus.net/#/taxon_concepts/10836"},"threatStatus":{"type":"string","description":"The IUCN Red List threat status for this taxon. Only populated when this usage appears in a RelatedInfo.redlist context. Values follow IUCN Red List categories: EX (Extinct), EW (Extinct in the Wild), CR (Critically Endangered), EN (Endangered), VU (Vulnerable), NT (Near Threatened), LC (Least Concern), DD (Data Deficient), NE (Not Evaluated).","example":"LC"},"citesAppendix":{"type":"string","description":"The CITES appendix under which this taxon is listed. Only populated when this usage appears in a RelatedInfo.cites context. Appendix I: species threatened with extinction; Appendix II: species not necessarily threatened but requiring trade controls; Appendix III: species protected in at least one country.","example":"II"},"children":{"type":"integer","format":"int32","description":"Number of direct children which are accepted taxa of any rank but not synonyms","example":7},"species":{"type":"integer","format":"int32","description":"Number of included species in this taxon","example":127}},"required":["datasetKey","label","scientificName","taxonID","taxonRank","taxonomicStatus"]},"NameUsageSuggestResult":{"type":"object","description":"A single result from a name usage prefix suggestion search","properties":{"taxonID":{"type":"string","description":"The unique identifier for this taxon within the dataset","example":"CXA"},"scientificNameID":{"type":"string","description":"The identifier for the scientific name","example":50123456},"scientificName":{"type":"string","description":"The scientific name matching the search prefix","example":"Abies alba"},"taxonRank":{"type":"string","description":"The taxonomic rank of the suggested name","enum":["SUPERDOMAIN","DOMAIN","SUBDOMAIN","INFRADOMAIN","EMPIRE","REALM","SUBREALM","SUPERKINGDOM","KINGDOM","SUBKINGDOM","INFRAKINGDOM","SUPERPHYLUM","PHYLUM","SUBPHYLUM","INFRAPHYLUM","PARVPHYLUM","MICROPHYLUM","NANOPHYLUM","CLAUDIUS","GIGACLASS","MEGACLASS","SUPERCLASS","CLASS","SUBCLASS","INFRACLASS","SUBTERCLASS","PARVCLASS","SUPERDIVISION","DIVISION","SUBDIVISION","INFRADIVISION","SUPERLEGION","LEGION","SUBLEGION","INFRALEGION","MEGACOHORT","SUPERCOHORT","COHORT","SUBCOHORT","INFRACOHORT","GIGAORDER","MAGNORDER","GRANDORDER","MIRORDER","SUPERORDER","ORDER","NANORDER","HYPOORDER","MINORDER","SUBORDER","INFRAORDER","PARVORDER","SUPERSECTION_ZOOLOGY","SECTION_ZOOLOGY","SUBSECTION_ZOOLOGY","FALANX","GIGAFAMILY","MEGAFAMILY","GRANDFAMILY","SUPERFAMILY","EPIFAMILY","FAMILY","SUBFAMILY","INFRAFAMILY","SUPERTRIBE","TRIBE","SUBTRIBE","INFRATRIBE","SUPRAGENERIC_NAME","SUPERGENUS","GENUS","SUBGENUS","INFRAGENUS","SUPERSECTION_BOTANY","SECTION_BOTANY","SUBSECTION_BOTANY","SUPERSERIES","SERIES","SUBSERIES","INFRAGENERIC_NAME","SPECIES_AGGREGATE","SPECIES","INFRASPECIFIC_NAME","GREX","KLEPTON","SUBSPECIES","CULTIVAR_GROUP","CONVARIETY","INFRASUBSPECIFIC_NAME","PROLES","NATIO","ABERRATION","MORPH","SUPERVARIETY","VARIETY","SUBVARIETY","SUPERFORM","FORM","SUBFORM","PATHOVAR","BIOVAR","CHEMOVAR","MORPHOVAR","PHAGOVAR","SEROVAR","CHEMOFORM","FORMA_SPECIALIS","LUSUS","CULTIVAR","MUTATIO","STRAIN","OTHER","UNRANKED"],"example":"SPECIES"},"taxonomicStatus":{"type":"string","description":"The taxonomic status of the taxon (e.g., accepted, synonym)","enum":["ACCEPTED","PROVISIONALLY_ACCEPTED","SYNONYM","AMBIGUOUS_SYNONYM","MISAPPLIED","BARE_NAME"],"example":"accepted"},"nomenclaturalCode":{"type":"string","description":"The nomenclatural code governing the taxon name","example":"BOTANICAL"},"acceptedNameUsageID":{"type":"string","description":"The identifier of the accepted taxon (for synonyms)","example":2435098},"acceptedNameUsage":{"type":"string","description":"The accepted name (for synonyms)","example":"Abies alba Mill."},"group":{"type":"string","description":"The major taxonomic group the taxon belongs to","enum":["Viruses","Prokaryotes","Bacteria","Archaea","Eukaryotes","Protists","Plants","Algae","Bryophytes","Pteridophytes","Angiosperms","Gymnosperms","Fungi","Ascomycetes","Basidiomycetes","Pseudofungi","OtherFungi","Animals","Arthropods","Insects","Coleoptera","Diptera","Lepidoptera","Hymenoptera","Hemiptera","Orthoptera","Trichoptera","OtherInsects","Arachnids","Crustacean","OtherArthropods","Molluscs","Gastropods","Bivalves","OtherMolluscs","Chordates","OtherAnimals"],"example":"Gymnosperms"},"context":{"type":"string","description":"Classification context shown as a hint, typically the family or order name","example":"Pinaceae"}},"required":["context","scientificName","scientificNameID","taxonID"]},"Count":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"integer","format":"int64"}}},"FacetNameUsageSearchParameter":{"type":"object","properties":{"field":{"type":"string","enum":["TAXON_ID","DATASET_KEY","TAXON_RANK","TAXONOMIC_STATUS","EXTINCT","ENVIRONMENT","TAXONOMIC_GROUP","NOMENCLATURAL_CODE","NAME_TYPE","AUTHOR","YEAR","ISSUE","ORIGIN"]},"counts":{"type":"array","items":{"$ref":"#/components/schemas/Count"}}}},"NameUsageSearchResult":{"type":"object","description":"A single result from a name usage full-text search, including the matched taxon, it's classification, and matching vernacular names","properties":{"taxonID":{"type":"string","description":"The unique identifier for this taxon. Bare names do not have a taxonID","example":2435099},"scientificName":{"type":"string","description":"The scientific name without authorship","example":"Abies alba"},"scientificNameAuthorship":{"type":"string","description":"The authorship information for the scientific name","example":"Mill."},"taxonRank":{"type":"string","description":"The taxonomic rank of the taxon","enum":["SUPERDOMAIN","DOMAIN","SUBDOMAIN","INFRADOMAIN","EMPIRE","REALM","SUBREALM","SUPERKINGDOM","KINGDOM","SUBKINGDOM","INFRAKINGDOM","SUPERPHYLUM","PHYLUM","SUBPHYLUM","INFRAPHYLUM","PARVPHYLUM","MICROPHYLUM","NANOPHYLUM","CLAUDIUS","GIGACLASS","MEGACLASS","SUPERCLASS","CLASS","SUBCLASS","INFRACLASS","SUBTERCLASS","PARVCLASS","SUPERDIVISION","DIVISION","SUBDIVISION","INFRADIVISION","SUPERLEGION","LEGION","SUBLEGION","INFRALEGION","MEGACOHORT","SUPERCOHORT","COHORT","SUBCOHORT","INFRACOHORT","GIGAORDER","MAGNORDER","GRANDORDER","MIRORDER","SUPERORDER","ORDER","NANORDER","HYPOORDER","MINORDER","SUBORDER","INFRAORDER","PARVORDER","SUPERSECTION_ZOOLOGY","SECTION_ZOOLOGY","SUBSECTION_ZOOLOGY","FALANX","GIGAFAMILY","MEGAFAMILY","GRANDFAMILY","SUPERFAMILY","EPIFAMILY","FAMILY","SUBFAMILY","INFRAFAMILY","SUPERTRIBE","TRIBE","SUBTRIBE","INFRATRIBE","SUPRAGENERIC_NAME","SUPERGENUS","GENUS","SUBGENUS","INFRAGENUS","SUPERSECTION_BOTANY","SECTION_BOTANY","SUBSECTION_BOTANY","SUPERSERIES","SERIES","SUBSERIES","INFRAGENERIC_NAME","SPECIES_AGGREGATE","SPECIES","INFRASPECIFIC_NAME","GREX","KLEPTON","SUBSPECIES","CULTIVAR_GROUP","CONVARIETY","INFRASUBSPECIFIC_NAME","PROLES","NATIO","ABERRATION","MORPH","SUPERVARIETY","VARIETY","SUBVARIETY","SUPERFORM","FORM","SUBFORM","PATHOVAR","BIOVAR","CHEMOVAR","MORPHOVAR","PHAGOVAR","SEROVAR","CHEMOFORM","FORMA_SPECIALIS","LUSUS","CULTIVAR","MUTATIO","STRAIN","OTHER","UNRANKED"],"example":"SPECIES"},"label":{"type":"string","description":"HTML formatted name with authorship and extinct dagger if applicable","example":"<i>Abies alba</i> Mill."},"datasetKey":{"type":"string","format":"uuid","description":"The identifier for the dataset","example":"7ddf754f-d193-4cc9-b351-99906754a03b"},"acceptedNameUsageID":{"type":"string","description":"The identifier of the accepted taxon (for synonyms)","example":2435098},"parentNameUsageID":{"type":"string","description":"The identifier of the parent taxon in the classification","example":2435001},"taxonomicStatus":{"type":"string","description":"The taxonomic status of the taxon (e.g., accepted, synonym)","enum":["ACCEPTED","PROVISIONALLY_ACCEPTED","SYNONYM","AMBIGUOUS_SYNONYM","MISAPPLIED","BARE_NAME"],"example":"accepted"},"nomenclaturalCode":{"type":"string","description":"The nomenclatural code governing the taxon name","example":"BOTANICAL"},"extinct":{"type":"boolean","description":"Indicates whether the taxon is extinct","example":false},"references":{"type":"string","format":"uri","description":"A link to a webpage for this name on the original, external site (dc:references)","example":"https://www.speciesplus.net/#/taxon_concepts/10836"},"threatStatus":{"type":"string","description":"The IUCN Red List threat status for this taxon. Only populated when this usage appears in a RelatedInfo.redlist context. Values follow IUCN Red List categories: EX (Extinct), EW (Extinct in the Wild), CR (Critically Endangered), EN (Endangered), VU (Vulnerable), NT (Near Threatened), LC (Least Concern), DD (Data Deficient), NE (Not Evaluated).","example":"LC"},"citesAppendix":{"type":"string","description":"The CITES appendix under which this taxon is listed. Only populated when this usage appears in a RelatedInfo.cites context. Appendix I: species threatened with extinction; Appendix II: species not necessarily threatened but requiring trade controls; Appendix III: species protected in at least one country.","example":"II"},"taxonomicGroup":{"type":"string","description":"The major taxonomic group the taxon is considered in","enum":["Viruses","Prokaryotes","Bacteria","Archaea","Eukaryotes","Protists","Plants","Algae","Bryophytes","Pteridophytes","Angiosperms","Gymnosperms","Fungi","Ascomycetes","Basidiomycetes","Pseudofungi","OtherFungi","Animals","Arthropods","Insects","Coleoptera","Diptera","Lepidoptera","Hymenoptera","Hemiptera","Orthoptera","Trichoptera","OtherInsects","Arachnids","Crustacean","OtherArthropods","Molluscs","Gastropods","Bivalves","OtherMolluscs","Chordates","OtherAnimals"],"example":"Gymnosperms"},"classification":{"type":"array","description":"Ordered list of parent taxa from root to the direct parent of the matched taxon","items":{"$ref":"#/components/schemas/ClassificationUsage"}},"vernacularNames":{"type":"array","description":"Vernacular names that matched the search query","items":{"$ref":"#/components/schemas/VernacularNameSimple"}}},"required":["datasetKey","label","scientificName","taxonRank","taxonomicStatus"]},"SearchResponseNameUsageSearchResultNameUsageSearchParameter":{"type":"object","properties":{"endOfRecords":{"type":"boolean","description":"True if this page of search results is the final page."},"count":{"type":"integer","format":"int64","description":"The total number of records returned by the search."},"results":{"type":"array","description":"Search results.","items":{"$ref":"#/components/schemas/NameUsageSearchResult"}},"facets":{"type":"array","description":"The resulting facets of a search operation.  The list can be empty if no facets were requested.\n\nIf there are no values for a facet, it will not be included in the list, i.e.: a facet should have at least 1 occurrence.","items":{"$ref":"#/components/schemas/FacetNameUsageSearchParameter"}}}},"VernacularNameSimple":{"type":"object","description":"A common or vernacular name for a taxon","properties":{"vernacularName":{"type":"string","description":"The vernacular (common) name","example":"Silver Fir"},"language":{"type":"string","description":"The language of the vernacular name (ISO 639-2 code)","example":"eng"}},"required":["vernacularName"]},"ChecklistMetrics":{"type":"object","description":"Metrics and import statistics for a checklist dataset","properties":{"origin":{"type":"string","description":"The origin type of the dataset (e.g. EXTERNAL, MANAGED, RELEASED)","enum":["EXTERNAL","PROJECT","RELEASE","XRELEASE"],"example":"EXTERNAL"},"format":{"type":"string","description":"The data format of the dataset source (e.g. DWCA, COLDP, ACEF)","enum":["DWCA","ACEF","TEXT_TREE","COLDP","PROXY","NEWICK","DOT"],"example":"COLDP"},"download":{"type":"string","format":"date-time","description":"Timestamp when the dataset was last downloaded or imported","example":"2024-03-15T10:30:00"},"attempt":{"type":"integer","format":"int32","description":"Sequential import attempt number for this dataset","example":5},"state":{"type":"string","description":"The state of the latest import (e.g. FINISHED, FAILED, PROCESSING)","enum":["WAITING","PREPARING","DOWNLOADING","PROCESSING","DELETING","INSERTING","MATCHING","INDEXING","ANALYZING","ARCHIVING","EXPORTING","FINISHED","CANCELED","FAILED"],"example":"FINISHED"},"started":{"type":"string","format":"date-time","description":"Timestamp when the latest import started","example":"2024-03-15T10:00:00"},"finished":{"type":"string","format":"date-time","description":"Timestamp when the latest import finished","example":"2024-03-15T10:30:00"},"bareNameCount":{"type":"integer","format":"int32","description":"Number of bare names (name-only records without a usage context)","example":120},"distributionCount":{"type":"integer","format":"int32","description":"Number of distribution records in the dataset","example":4500},"mediaCount":{"type":"integer","format":"int32","description":"Number of media records (images, sounds, videos) in the dataset","example":8200},"nameCount":{"type":"integer","format":"int32","description":"Total number of scientific names in the dataset","example":55000},"referenceCount":{"type":"integer","format":"int32","description":"Number of bibliographic reference records in the dataset","example":12000},"synonymCount":{"type":"integer","format":"int32","description":"Number of synonymic name usages in the dataset","example":18000},"taxonCount":{"type":"integer","format":"int32","description":"Total number of accepted taxon records in the dataset","example":37000},"treatmentCount":{"type":"integer","format":"int32","description":"Number of treatment records (descriptive text) in the dataset","example":200},"typeMaterialCount":{"type":"integer","format":"int32","description":"Number of type material records in the dataset","example":500},"vernacularNameCount":{"type":"integer","format":"int32","description":"Number of vernacular (common) name records in the dataset","example":9000},"namesByCodeCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"Count of names grouped by nomenclatural code (e.g. ZOOLOGICAL, BOTANICAL)","example":{"BOTANICAL":42000,"ZOOLOGICAL":13000}},"namesByRankCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"Count of names grouped by taxonomic rank (e.g. SPECIES, GENUS, FAMILY)","example":{"SPECIES":25000,"GENUS":3000,"FAMILY":400}},"namesByTypeCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"Count of names grouped by name type (e.g. SCIENTIFIC, HYBRID_FORMULA, INFORMAL)","example":{"SCIENTIFIC":53000,"INFORMAL":1500,"HYBRID_FORMULA":500}},"taxaByRankCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"Count of accepted taxa grouped by taxonomic rank","example":{"SPECIES":18000,"GENUS":2500,"FAMILY":350}},"usagesByStatusCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"Count of name usages grouped by taxonomic status (e.g. ACCEPTED, SYNONYM, AMBIGUOUS_SYNONYM)","example":{"ACCEPTED":37000,"SYNONYM":18000,"AMBIGUOUS_SYNONYM":200}},"usagesByOriginCount":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"Count of name usages grouped by origin (e.g. SOURCE, DENORMED_CLASSIFICATION, VERBATIM_ACCEPTED)","example":{"SOURCE":50000,"DENORMED_CLASSIFICATION":4000,"VERBATIM_ACCEPTED":1000}}}}}}}