GBIF Occurrences

Methods (79)

• getOccurrenceById

  read

  Occurrence by id

  Required paramsgbifId

• getOccurrenceCount

  read

  Occurrence counts

• searchOccurrence

  read

  Occurrence search (GBIF Occurrences).

• suggestRecordedBy

  unknown

  Suggest recorded by values

• provider_searchoccurrence

  read

  Occurrence search

  Paginationoffset (offsetField: offset, limitField: limit)

• provider_requestdownload

  write

  Requests the creation of a download file.

  Required paramsbody

  Paginationnone

• provider_retrievedownload

  read

  Retrieve the resulting download file

  Required paramskey

  Paginationnone

• provider_canceldownload

  write

  Cancel a running download

  Required paramskey

  Paginationnone

• provider_validatedownloadrequest

  write

  **Experimental** Validates the SQL contained in an SQL download request.

  Required paramsbody

  Paginationnone

• provider_searchtopredicate

  read

  Converts a plain search query into a download predicate.

  Required paramsformat

  Paginationnone

• provider_searchtosql

  read

  Converts a plain search query into an SQL download predicate.

  Paginationnone

• provider_searchtosql_1

  write

  Converts a predicate download request into an SQL download request.

  Required paramsbody

  Paginationnone

• provider_getoccurrencebyid

  read

  Occurrence by id

  Required paramsgbifId

  Paginationnone

• provider_predicatesearchoccurrence

  write

  Occurrence search using predicates

  Required paramsbody

  Paginationnone

• provider_getoccurrencebydatasetkeyandoccurrenceid

  read

  Occurrence by dataset key and occurrence id

  Required paramsdatasetKeyoccurrenceId

  Paginationnone

• provider_getoccurrencefragmentbyid

  read

  Occurrence fragment by id

  Required paramsgbifId

  Paginationnone

• provider_getoccurrencefragmentbydatasetkeyandoccurrenceid

  read

  Occurrence fragment by dataset key and occurrence id

  Required paramsdatasetKeyoccurrenceId

  Paginationnone

• provider_getverbatimoccurrencebyid

  read

  Verbatim occurrence by id

  Required paramsgbifId

  Paginationnone

• provider_getverbatimoccurrencebydatasetkeyandoccurrenceid

  read

  Verbatim occurrence by dataset key and occurrence id

  Required paramsdatasetKeyoccurrenceId

  Paginationnone

• provider_experimentalgetrelatedoccurrences

  read

  Related occurrences by gbifId

  Required paramsgbifId

  Paginationnone

• provider_suggestcatalognumbers

  read

  Suggest catalogue numbers

  Required paramsqlimit

  Paginationnone

• provider_suggestcollectioncodes

  read

  Suggest collection codes

  Required paramsqlimit

  Paginationnone

• provider_suggestdatasetnames

  read

  Suggest dataset names

  Required paramsqlimit

  Paginationnone

• provider_suggesteventids

  read

  Suggest event ids

  Required paramsqlimit

  Paginationnone

• provider_suggestidentifiedby

  read

  Suggest identified by values

  Required paramsqlimit

  Paginationnone

• provider_suggestinstitutioncodes

  read

  Suggest institution codes

  Required paramsqlimit

  Paginationnone

• provider_suggestlocalities

  read

  Suggest locality strings

  Required paramsqlimit

  Paginationnone

• provider_suggestoccurrenceids

  read

  Suggest occurrence ids

  Required paramsqlimit

  Paginationnone

• provider_suggestorganismids

  read

  Suggest organism ids

  Required paramsqlimit

  Paginationnone

• provider_suggestothercatalognumbers

  read

  Suggest other catalogue numbers

  Required paramsqlimit

  Paginationnone

• provider_suggestparenteventids

  read

  Suggest parent event ids

  Required paramsqlimit

  Paginationnone

• provider_suggestrecordnumbers

  read

  Suggest record numbers

  Required paramsqlimit

  Paginationnone

• provider_suggestrecordedby

  read

  Suggest recorded by values

  Required paramsqlimit

  Paginationnone

• provider_suggestsamplingprotocols

  read

  Suggest sampling protocols

  Required paramsqlimit

  Paginationnone

• provider_suggeststateprovinces

  read

  Suggest states/provinces

  Required paramsqlimit

  Paginationnone

• provider_suggestwaterbodies

  read

  Suggest water bodies

  Required paramsqlimit

  Paginationnone

• provider_suggestterm

  read

  Suggest values for supported terms

  Required paramstermqlimitterm

  Paginationnone

• provider_describedwcadownload

  read

  **Experimental.** Describes the fields present in a Darwin Core Archive format download

  Paginationnone

• provider_describesimpleavrodownload

  read

  **Experimental.** Describes the fields present in a Simple Avro format download

  Paginationnone

• provider_describesimplecsvdownload

  read

  **Experimental.** Describes the fields present in a Simple CSV format download

  Paginationnone

• provider_describesimpleparquetdownload

  read

  **Experimental.** Describes the fields present in a Simple Parquet format download

  Paginationnone

• provider_describespecieslistdownload

  read

  **Experimental.** Describes the fields present in a Species List format download

  Paginationnone

• provider_describesqldownload

  read

  **Very experimental.** Describes the fields available for searching or download when using an SQL…

  Paginationnone

• provider_index

  read

  Official gbif operation index.

  Paginationnone

• provider_listmultimediabyspecies

  read

  Official gbif operation listMultimediaBySpecies.

  Required paramstaxonKeymediaTypelimitoffset

  Paginationoffset (offsetField: offset, limitField: limit)

• provider_listmultimediabyspecies_1

  read

  Official gbif operation listMultimediaBySpecies_1.

  Required paramschecklistKeytaxonKeymediaTypelimitoffset

  Paginationoffset (offsetField: offset, limitField: limit)

• provider_occurrenceterms

  read

  Occurrence terms

  Paginationnone

• provider_getoccurrencedownloadbykey

  read

  Information about an occurrence download

  Required paramskey

  Paginationnone

• provider_getoccurrencedownloadbydoi

  read

  Information about an occurrence download

  Required paramsprefixsuffix

  Paginationnone

• provider_listoccurrencedownloadsbyuser

  read

  Lists all occurrence downloads from a user

  Required paramsuser

  Paginationpage (pageField: page)

• provider_countoccurrencedownloadsbyuser

  read

  Counts all downloads from a user

  Required paramsuser

  Paginationnone

• provider_listdatasetusagesbyoccurrencedownloaddoi

  read

  Lists datasets present in an occurrence download

  Required paramsprefixsuffix

  Paginationoffset (offsetField: offset, limitField: limit)

• provider_listcountryusagesbyoccurrencedownloadkey

  read

  Lists countries present in an occurrence download

  Required paramskey

  Paginationpage (pageField: page)

• provider_listdatasetusagesbyoccurrencedownloadkey

  read

  Lists datasets present in an occurrence download

  Required paramskey

  Paginationpage (pageField: page)

• provider_listorganizationusagesbyoccurrencedownloadkey

  read

  Lists organizations present in an occurrence download

  Required paramskey

  Paginationpage (pageField: page)

• provider_exportdatasetusagesbyoccurrencedownloadkey

  read

  Exports datasets present in an occurrence download in TSV or CSV format

  Required paramskey

  Paginationnone

• provider_getoccurrencedownloadcitationbykey

  read

  Shows the citation for an occurrence download

  Required paramskey

  Paginationnone

• provider_getoccurrencedownloadcitationbydoi

  read

  Shows the citation for an occurrence download

  Required paramsprefixsuffix

  Paginationnone

• provider_getoccurrencedownloadedstatistics

  read

  Provides summarized download statistics

  Paginationoffset (offsetField: offset, limitField: limit)

• provider_exportoccurrencedownloadedstatistics

  read

  Export summary of occurrence downloads

  Required paramsfromDatetoDatepublishingCountry

  Paginationnone

• provider_getoccurrencedownloadsbyusercountry

  read

  Summarizes downloads by month, grouped by the user's country, territory or island

  Paginationnone

• provider_getoccurrencedownloadedrecordsbydataset

  read

  Summarize downloaded records by dataset

  Paginationnone

• provider_getoccurrencedownloadedrecordsbydataset_1

  read

  Summarize downloads by dataset

  Paginationnone

• provider_getoccurrencedownloadedrecordsbysource

  read

  Summarize downloaded record totals by source

  Paginationnone

• provider_getdatasetdownloadactivity

  read

  List the downloads activity of a dataset.

  Required paramsdatasetKey

  Paginationoffset (offsetField: offset, limitField: limit)

• provider_getgadmsubdivisions

  read

  Subdivisions of a GADM region

  Required paramsgid

  Paginationnone

• provider_getgadmregion

  read

  Details for a GADM region

  Required paramsgid

  Paginationnone

• provider_gadmregionsearch

  read

  Search for GADM regions.

  Paginationpage (pageField: page)

• provider_gadmregionbrowselevel3

  read

  Third-level subdivisions of a GADM region

  Required paramslevel0level1level2

  Paginationnone

• provider_gadmregionbrowselevel2

  read

  Second-level subdivisions of a GADM region

  Required paramslevel0level1

  Paginationnone

• provider_gadmregionbrowselevel1

  read

  First-level subdivisions of a GADM region

  Required paramslevel0

  Paginationnone

• provider_gadmregionbrowselevel0

  read

  List all top-level GADM regions

  Paginationnone

• provider_getoccurrencecount

  read

  Occurrence counts

  Required paramsarg0

  Paginationnone

• provider_getoccurrencecountschema

  read

  Supported occurrence count metrics

  Paginationnone

• provider_getoccurrenceinventorybasisofrecord

  read

  Occurrence inventory by basis of record

  Paginationnone

• provider_getoccurrenceinventoryyear

  read

  Occurrence inventory by year

  Paginationnone

• provider_getoccurrenceinventorydataset

  read

  Occurrence inventory by dataset

  Paginationnone

• provider_getoccurrenceinventorycountry

  read

  Occurrence inventory by country

  Paginationnone

• provider_getoccurrenceinventorypublishingcountry

  read

  Occurrence inventory by publishing country

  Paginationnone