Skip to end of metadata
Go to start of metadata

A complete list of all web service resources.

Services marked in red are not yet available.

All services take parameters as querystring encoded GET key=value parameters and respond with an application/json content type. Please note that all query parameter names are written in lowerCamelCase. 

For invalid requests made over HTTP, or using a client, you can consult this list of Service Exceptions.

Public API prefix: http://api.gbif.org + Endpoint URL

Followed by the detailed descriptions of each individual service:

Checklist Bank Services: Name usage

Description: Services related to name usages: a name usage is a usage of a scientific name according to one particular Checklist including the GBIF Taxonomic Backbone. It is shown as species in the new Portal. All nub usages will have a nubKey equal to their key and belong to the nub checklist registry resource. Name usages from other checklists with names that also exist in the nub will have a nubKey that points to the related usage in the nub. Please refer to http://ecat-dev.gbif.org/api/clb for the old version of the Checklist Bank Services. The old version will be deprecated in approximately 1 year from today (Dec 10, 2012).

Staging URL:  http://staging.gbif.org:8080/checklistbank-ws/species 

Current consumer(s): Staging Portal (species page, species search, occurrence search)

Endpoint URLMethodResponseDescriptionAuthPagingFilter Parameters
/speciesGETNameUsageLists all name usages across all checklists yes2, 3, 4, 6
/species/root/{uuid|shortname}GETNameUsageLists root usages of a checklist yes 
/species/{int}GETNameUsageGets the single name usage  2
/species/{int}/verbatimGETVerbatimNameUsageGets the verbatim name usage   
/species/{int}/nameGETParsedNameGets the parsed name for a name usage   
/species/{int}/parentsGETNameUsageLists all parent usages for a name usage no2
/species/{int}/childrenGETNameUsageLists all direct child usages for a name usage yes2
/species/{int}/relatedGETNameUsageLists all related name usages in other checklists no2, 3
/species/{int}/synonymsGETNameUsageLists all synonyms for a name usage yes2
/species/{int}/descriptionsGETDescriptionLists all descriptions for a name usage yes 
/species/{int}/distributionsGETDistributionLists all distributions for a name usage yes 
/species/{int}/imagesGETImageLists all images for a name usage yes 
/species/{int}/referencesGETReferenceLists all references for a name usage yes 
/species/{int}/species_profilesGETSpeciesProfileLists all species profiles for a name usage yes 
/species/{int}/vernacular_namesGETVernacularNameLists all vernacular names for a name usage yes 
/species/{int}/type_specimensGETTypeSpecimenLists all type specimens for a name usage yes 

Filter Parameters

  1. user
  2. language, default=en or use HTTP header for this
  3. datasetKey
  4. sourceId
  5. rank
  6. name (case insensitive, canonical namestring. For example Puma concolor)

Checklist Bank Services: GBIF Backbone Taxon Lookup

Description: Service that allows matching a name usage to the GBIF Backbone Taxonomy. Currently you can only do a name usage match to the GBIF Backbone Taxonomy. In theory one could also do it against the Catalogue of Life or other checklists, but this is currently unimplemented.

Staging base URL: http://boma.gbif.org:8080/ws-nub/nub

Current consumer(s): Staging Portal (occurrence search)

Endpoint URLMethodResponseDescriptionAuthPagingFilter Parameters
/lookup/speciesGET Gets a single nub usage or null doing a fuzzy name & classification match  1,2,3,4,5

Filter Parameters

  1. name: full scientific name potentially with authorship
  2. rank: the rank given as our rank enum
  3. kingdom, phylum, class, order, family, genus: optional classification parameters accepting a canonical name. If provided the default matching will also try to match against these if no direct match is found for the name alone.
  4. strict: if true it (fuzzy) matches only the given name, but never a taxon in the upper classification
  5. verbose: if true show alternative matches considered which had been rejected

Checklist Bank Services: Search Service

Description: Search service that searches all name usages from all checklists (GBIF Backbone Taxonomy, Catalogue of Life, etc). 

Staging base URL: http://staging.gbif.org:8080/checklistbank-search-ws/search

Current consumer(s): Staging Portal (species search)

Endpoint URLMethodDescriptionFulltext search parameters supportedSupported facets & facet filtersFull text fields

/species/search

GET

Search all name usages implementing the complete set of parameters specified in Fulltext Search Services.

  • paging parameters: yes.
  • highlighting: yes, supported for the fulltext search fields only.
  • facets: all facets parameters supported except by paging on facets.
  • DATASET_KEY: The checklist dataset key as a uuid.
  • RANK: Filters by the rank of the name usage.
  • HIGHERTAXON_KEY: Filters by any of the higher linnean rank keys. Note this is within the respective checklist and not searching nub keys across all checklists.
  • STATUS: Filter by the taxonomis status.
  • EXTINCT: Boolean filter for extinct taxa.
  • HABITAT: Filter by the known habitats.
  • THREAT: Filter by the threat status.
  • NAME_TYPE: Filter by the name type.

Please refer to  NameUsageSearchParameter for the latest list of supported facets and its accepted values.

canonical_name, class, description, family, genus, kingdom, order, phylum, scientificName, species, subgenus, vernacularName.

Example requests:

Checklist Bank Services: Name list

Description: Services related to name lists. Currently unimplemented. 

Staging URL: http://staging.gbif.org:8080/checklistbank-ws/name_list

Endpoint URLMethodResponseDescriptionAuthPagingFilter Parameters
/name_listGETNameListLists all user name lists, metadata only  1
/name_listPOST Uploads a new name lists for a useryes  
/name_list/{int}GET Gets the complete name list yes 
/name_list/{int}PUT Updates the complete name listyes  
/name_list/{int}DELETE Deletes the complete name listyes  

Filter Parameters

  1. user (a user can upload/manage list of names)

Checklist Bank Services: Metrics

Description: Service that provides some checklist metrics such as counts by rank, count of synonyms, count of records indexed, etc.

Staging base URL: http://staging.gbif.org:8080/metrics-ws/

Current consumer(s): Staging Portal (species page)

Endpoint URLMethodResponseDescriptionAuthPagingFilter Parameters
/dataset_metrics/{uuid}GET Gets metrics for a single checklist   

Registry Services: Node

Staging base URL: http://staging.gbif.org:8080/registry2-ws/

Current consumer(s): Staging Portal, UAT Portal (node page)

Endpoint URL

Method

Response

Description

AuthPaging

Filter Parameters

/node

GET

Node

Lists all nodes

 yes

1

/node

POST

 

Creates a new node

yes 

 

/node/<UUID>

GET

Node

Gets the node

  

 

/node/<UUID>

PUT

 

Updates the node

yes 

 

/node/<UUID>

DELETE

 

Deletes the node

yes 

 

/node/<UUID>/organization

GET

 

Lists organizations endorsed by the node

 yes

 

/node/<UUID>/contact

GET

 

Lists all contacts for a node (managed in IMS)

  

 

/node/<UUID>/endpoint

GET

 

Lists the node's endpoints

  

 

/node/<UUID>/endpoint

POST

 

Creates a node's endpoint

yes 

 

/node/<UUID1>/endpoint<id>DELETE Deletes a node's endpoint with identifier <ID>yes  

/node/<UUID>/identifier

GET

 

Lists the node's identifiers

  

 

/node/<UUID>/identifier

POST

 

Creates a new node identifier

yes 

 

/node/<UUID>/identifier/<ID>DELETE Deletes a node's identifier with identifier <ID>yes  

/node/<UUID>/tag

GET

 

Lists all tags for a node

  

 

/node/<UUID>/tag

POST

 

Create and add a node tag

yes  
/node/<UUID>/tag/<ID>DELETE Deletes the node tag with tag identifier <ID>yes  

/node/<UUID>/machinetag

GET

 

Lists all machine tags for a node

  

 

/node/<UUID>/machinetag

POST

 

Create and add a node machine tag

yes  
/node/<UUID>/machinetag/<ID>DELETE Deletes the node machine tag with machine tag identifier <ID>yes  

/node/<UUID>/comment

GET

 

Lists all comments for a node

  

 

/node/<UUID>/comment

POST

 

Create and add a node comment

yes  
/node/<UUID>/comment/<ID>DELETE Deletes the node comment with comment identifier <ID>yes  
/node/pendingEndorsementGET Lists all organizations whose endorsement is pending yes 
/node/<UUID>/pendingEndorsementGET Lists all organizations whose endorsement by node is pending yes 
/node/countryGET List names of all GBIF member countries   
/node/country/<ISO-CODE>GET Gets the country node by ISO 639-1 (2 letter) or ISO 639-2 (3 letter) country code   
/node/<UUID>/datasetGET Lists datasets owned by organizations endorsed by node yes 
/node/<UUID>/installationGET Lists installations hosted by organizations endorsed by node yes 

Filter Parameters

  1. q (simple search parameter)

Registry Services: Organization

Staging base URL: http://staging.gbif.org:8080/registry2-ws/

Current consumer(s): Staging Portal, UAT Portal (dataset page, organization page)

Endpoint URL

Method

Response

Description

AuthPaging

Filter Parameters

/organization

GET

Organization

Lists all organizations

 yes

1, 2

/organization

POST

 

Creates a new organization

yes 

 

/organization/<UUID>

GET

Organization

Gets the organization

  

 

/organization/<UUID>

PUT

 

Updates the organization

yes 

 

/organization/<UUID>

DELETE

 

Deletes the organization

yes 

 

/organization/<UUID>/contactGET Lists all contacts for the organization   

/organization/<UUID>/contact

POST

 

Create and add an organization contact

yes 

 

/organization/<UUID>/contact/<ID>DELETE Deletes an organization contact with contact identifier <ID>yes  
/organization/<UUID>/contact/<ID>PUT Updates an organization contact with contact identifier <ID>yes  

/organization/<UUID>/endpoint

GET

 

Lists the organization endpoints

  

 

/organization/<UUID>/endpoint

POST

 

Creates an organization endpoint

yes 

 

/organization/<UUID>/endpoint<ID>DELETE Deletes an organization endpoint with identifier <ID>yes  

/organization/<UUID>/identifier

GET

 

Lists the organization's identifiers

  

 

/organization/<UUID>/identifier

POST

 

Creates a new organization identifier

yes 

 

/organization/<UUID>/identifier/<ID>DELETE Deletes an organization's identifier with identifier <ID>yes  

/organization/<UUID>/tag

GET

 

Lists all tags for the organization

  

 

/organization/<UUID>/tag

POST

 

Create and adds an organization tag

yes 

 

/organization/<UUID>/tag/<ID>DELETE Deletes the organization tag with tag identifier <ID>yes  

/organization/<UUID>/machinetag

GET

 

Lists all machine tags for an organization

  

 

/organization/<UUID>/machinetag

POST

 

Create and add an organization machine tag

yes  
/organization/<UUID>/machinetag/<ID>DELETE Deletes the organization machine tag with machine tag identifier <ID>yes  

/organization/<UUID>/comment

GET

 

Lists all comments for an organization

  

 

/organization/<UUID>/comment

POST

 

Create and add an organization comment

yes  
/organization/<UUID>/comment/<ID>DELETE Deletes the organization comment with comment identifier <ID>yes  

/organization/<UUID>/hostedDataset

GET

 

Lists the hosted datasets (datasets hosted by installations hosted by organization)

 yes

 

/organization/<UUID>/ownedDataset

GET

 

Lists the owned datasets (datasets published by organization)

 yes

 

/organization/<UUID>/installationGET Lists the technical installations hosted by this organization yes 
/organization/deletedGET Lists the deleted organizations yes 
/organization/pendingGET Lists the organizations whose endorsement is pending yes 
/organization/nonPublishingGET Lists the organizations publishing 0 datasets yes 

Filter Parameters

  1. q (simple search parameter)
  2. country

Registry Services: Network

Staging base URL: http://staging.gbif.org:8080/registry2-ws/

Current consumer(s): Staging Portal, UAT Portal (network page)

Endpoint URL

Method

Response

Description

AuthPaging

Filter Parameters

/network

GET

Network

Lists all networks

 yes

1

/network

POST

 

Creates a new network

yes 

 

/network/<UUID>

GET

Network

Gets the network

  

 

/network/<UUID>

PUT

 

Updates the network

yes 

 

/network/<UUID>

DELETE

 

Deletes the network

yes 

 

/network/<UUID>/contactGET Lists all contacts for the network   

/network/<UUID>/contact

POST

 

Create and add a network contact

yes 

 

/network/<UUID>/contact/<ID>DELETE Deletes a network contact with contact identifier <ID>yes  
/network/<UUID>/contact/<ID>PUT Updates a network contact with contact identifier <ID>yes  

/network/<UUID>/endpoint

GET

 

Lists the network endpoints

  

 

/network/<UUID>/endpoint

POST

 

Creates an network endpoint

yes 

 

/network/<UUID>/endpoint<ID>DELETE Deletes a network endpoint with identifier <ID>yes  

/network/<UUID>/identifier

GET

 

Lists the network's identifiers

  

 

/network/<UUID>/identifier

POST

 

Creates a new network identifier

yes 

 

/network/<UUID>/identifier/<ID>DELETE Deletes a network identifier with identifier <ID>yes  

/network/<UUID>/tag

GET

 

Lists all tags for the network

  

 

/network/<UUID>/tag

POST

 

Create and adds an network tag

yes 

 

/network/<UUID>/tag/<ID>DELETE Deletes the network tag with tag identifier <ID>yes  

/network/<UUID>/machinetag

GET

 

Lists all machine tags for a network

  

 

/network/<UUID>/machinetag

POST

 

Create and add a network machine tag

yes  
/network/<UUID>/machinetag/<ID>DELETE Deletes the network machine tag with machine tag identifier <ID>yes  

/network/<UUID>/comment

GET

 

Lists all comments for a network

  

 

/network/<UUID>/comment

POST

 

Create and add a network comment

yes  
/network/<UUID>/comment/<ID>DELETE Deletes the network comment with comment identifier <ID>yes  

Filter Parameters

  1. q (simple search parameter)

Registry Services: Technical Installation

Staging base URL: http://staging.gbif.org:8080/registry-ws/

Current consumer(s): 

Endpoint URL

Method

Response

Description

AuthPaging

Filter Parameters

/installation

GET

TechnicalInstallation

Lists all technical installations

 yes

1

/installation

POST

 

Creates a new technical installation

yes 

 

/installation/<UUID>

GET

TechnicalInstallation

Gets the technical installation

  

 

/installation/<UUID>

PUT

 

Updates the technical installation

yes 

 

/installation/<UUID>

DELETE

 

Deletes the technical installation

yes 

 

/installation/<UUID>/contactGET Lists all contacts for the technical installation   

/installation/<UUID>/contact

POST

 

Create and add an technical installation contact

yes 

 

/installation/<UUID>/contact/<ID>DELETE Deletes a technical installation contact with contact identifier <ID>yes  
/installation/<UUID>/contact/<ID>PUT Updates a technical installation contact with contact identifier <ID>yes  

/installation/<UUID>/endpoint

GET

 

Lists the technical installation endpoints

  

 

/installation/<UUID>/endpoint

POST

 

Creates an technical installation endpoint

yes 

 

/installation/<UUID>/endpoint<ID>DELETE Deletes a technical installation endpoint with identifier <ID>yes  
/installation/<UUID>/identifierGET Lists the technical installation identifiers   
/installation/<UUID>/identifierPOST Creates a new technical installation identifieryes  
/installation/<UUID>/identifier/<ID>DELETE Deletes a technical installation identifier with identifier <ID>yes  

/installation/<UUID>/tag

GET

 

Lists all tags for the technical installation

  

 

/installation/<UUID>/tag

POST

 

Create and adds a technical installation tag

yes 

 

/installation/<UUID>/tag/<ID>DELETE Deletes the technical installation tag with tag identifier <ID>yes  

/installation/<UUID>/machinetag

GET

 

Lists all machine tags for a technical installation

  

 

/installation/<UUID>/machinetag

POST

 

Create and add a technical installation machine tag

yes  
/installation/<UUID>/machinetag/<ID>DELETE Deletes the technical installation machine tag with machine tag identifier <ID>yes  

/installation/<UUID>/comment

GET

 

Lists all comments for a technical installation

  

 

/installation/<UUID>/comment

POST

 

Create and add a technical installation comment

yes  
/installation/<UUID>/comment/<ID>DELETE Deletes the technical installation comment with comment identifier <ID>yes  
/installation/<UUID>/datasetGET Lists datasets served by the technical installation yes 
/installation/deletedGET Lists the deleted technical installations yes 
/installation/nonPublishingGET Lists the technical installations serving 0 datasets yes 

Filter Parameters

  1. q (simple search parameter)

Registry Services: Dataset

Staging base URL: http://staging.gbif.org:8080/registry2-ws/

Current consumer(s): Staging Portal, UAT Portal (dataset page)

Endpoint URL

Method

Response

Description

AuthPaging

Filter Parameters

/dataset

GET

Dataset

Lists all datasets

 yes

1, 2, 3

/dataset

POST

 

Creates a new dataset

yes 

 

/dataset/<UUID>

GET

Dataset

Gets the dataset

  

 

/dataset/<UUID>

PUT

 

Updates the dataset

yes 

 

/dataset/<UUID>

DELETE

 

Deletes the dataset

yes 

 

/dataset/<UUID>/contactGET Lists all contact for the dataset   

/dataset/<UUID>/contact

POST

 

Create and add a dataset contact

  

 

/dataset/<UUID>/contact/<ID>DELETE Deletes a dataset contact with contact identifier <ID>yes  
/dataset/<UUID>/contact/<ID>PUT Updates a dataset contact with contact identifier <ID>yes  

/dataset/<UUID>/endpoint

GET

 

Lists the dataset endpoints

  

 

/dataset/<UUID>/endpoint

POST

 

Creates a dataset endpoint

yes 

 

/dataset/<UUID>/endpoint<ID>DELETE Deletes a dataset endpoint with identifier <ID>yes  

/dataset/<UUID>/identifier

GET

 

Lists the dataset's identifiers

  

 

/dataset/<UUID>/identifier

POST

 

Creates a new dataset identifier

yes 

 

/dataset/<UUID>/identifier/<ID>DELETE Deletes a dataset identifier with identifier <ID>yes  

/dataset/<UUID>/tag

GET

 

Lists all tags for the dataset

  

 

/dataset/<UUID>/tag

POST

 

Create and adds a dataset tag

yes 

 

/dataset/<UUID>/tag/<ID>DELETE Deletes the dataset tag with tag identifier <ID>yes   

/dataset/<UUID>/machinetag

GET

 

Lists all machine tags for a dataset

  

 

/dataset/<UUID>/machinetag

POST

 

Create and add a dataset machine tag

yes  
/dataset/<UUID>/machinetag/<ID>DELETE Deletes the dataset machine tag with machine tag identifier <ID>yes  

/dataset/<UUID>/comment

GET

 

Lists all comments for a dataset

  

 

/dataset/<UUID>/comment

POST

 

Create and add a dataset comment

yes  
/dataset/<UUID>/comment/<ID>DELETE Deletes the dataset comment with comment identifier <ID>yes   

/dataset/<UUID>/constituents

GET

 

Lists the dataset's subdataset constituents (datasets that have a parentDatasetKey equal to the one requested)

  yes

 

/dataset/<UUID>/documentGET Gets a GBIF generated EML document overlaying GBIF information with any existing metadata document data.   
/dataset/<UUID>/documentPOST Pushes a new original source metadata document for a dataset into the registry, replacing any previously existing document of the same type.yes  
/dataset/<UUID>/metadataGET 

Lists all metadata descriptions available for a dataset and optionally filters them by document type. The list is sorted by priority with the first result ranking highest. Highest priority in this sense means most relevant for augmenting/updating a dataset with EML being the most relevant cause informative type.

   3
/dataset/metadata/<ID>GET Get a metadata description by its identifier <ID>   
/dataset/metadata/<ID>/documentGET Gets the actual metadata description's document by its identifier <ID>   
/dataset/metadata/<ID>DELETE Deletes a metadata description entry and its document by its identifier <ID> yes  
/dataset/deletedGET Lists all datasets that are marked as deleted  yes 
/dataset/duplicateGET Lists all datasets that are marked as a duplicate of another  yes 
/dataset/subDatasetGET Lists all datasets that are marked as a sub dataset (e.g. have a parent dataset). Different from constituents?  yes 
/dataset/withNoEndpointGET Lists all datasets (are not sub datasets) having no endpoint  yes 
/dataset/search GET See Dataset Search section (TODO)  yes 
/dataset/suggest GET See Dataset Search section (TODO)  yes 

Filter Parameters

  1. q (simple search parameter)
  2. country
  3. type

Example requests:

Registry Services: Extension

Staging base URL: http://staging.gbif.org:8080/registry-ws/

Endpoint URL

Method

Response

Description

AuthPaging

Filter Parameters

/dwca/extension      

GET

 

Lists the extensions

  

 

/dwca/extension/<k1>

GET

 

Gets the extension

  

 

/dwca/extension/<k1> 

PUT

 

Creates the named extension

  

 

Registry Services: Vocabulary

Staging base URL: http://staging.gbif.org:8080/registry-ws/

Endpoint URL

Method

Response

Description

AuthPaging

Filter Parameters

/dwca/vocabulary

GET

 

Lists the vocabularies

  

 

/dwca/vocabulary/<k1>

GET

 

Gets the vocabulary

  

 

/dwca/vocabulary/<k1>

PUT

 

Creates the named vocabulary

  

 

 

Registry Services: Dataset Search Service

Description: Search service that searches all datasets, both registered and unregistered. 

Staging base URL: http://staging.gbif.org:8080/registry-search-ws/

Current consumer(s): Staging Portal (dataset search page)

Endpoint URLMethodDescriptionFulltext search parameters supportedSupported facets & facet filtersFull text fields

/dataset/search

GET

This service implements the complete set of parameters specified in  Fulltext Search Services.

  • paging parameters: yes.
  • highlighting: yes, supported for the fulltext search fields only.
  • facets: all facets parameters supported except by paging on facets.

Dataset type (type), keyword (keyword), Owning organization (owningOrg), Network of origin (networkOrigin), Hosting organization (hostingOrg), Decade (decade), Country (country). Please refer to SolrAnnotatedDataset.java for the latest list of supported facets.

datasetTitle, keyword, isoCountryCode, owningOrganizationTitle, hostingOrganizationTitle, description, fullText. Please refer to SolrAnnotatedDataset.java for the latest list of supported full text fields.

Example requests:

Occurrence Services: Occurrence Record

Description: Services related to the retrieval of occurrence records. 

Staging base URL: http://staging.gbif.org:8080/occurrence-ws/occurrence

Current consumer(s): Staging Portal (occurrence page)

Endpoint URLMethodResponseDescriptionAuthPagingFilter Parameters
/occurrenceGETOccurrenceLists all occurrences across all or some datasets yes1
/occurrence/{int}GETOccurrenceGets a single occurrence   
/occurrence/{int}/verbatimGETVerbatimOccurrenceGets a single verbatim occurrence   
  1. datasetKey

Example requests: 

Occurrence Services: Search Service

Description: Search service that searches all occurrence records that have been indexed by GBIF. 

Staging base URL: http://staging.gbif.org:8080/checklistbank-search-ws/search

Current consumer(s): Staging Portal (occurrence search)

See also Occurrence Download Service

Endpoint URLMethodDescriptionFulltext search parameters supportedSupported search filtersFull text fields

/occurrence/search

GET

Search all occurrence records implementing the complete set of parameters specified in Fulltext Search Services.

  • paging parameters: yes.
  • highlighting: no.
  • facets: not supported

Scientific name (taxonKey), location (boundingBox), collector (collectorName), basis of record (basisOfRecord), dataset (datasetKey), collection date (date), and catalog number (catalogNumber)

N/A

Example requests:

 

Occurrence Services: Download Service

Description: Download service that allows filtered occurrence record downloads. 

Current consumer(s): Staging Portal (occurrence download) 

See Occurrence Download Service

Endpoint URLMethodResponseDescriptionAuthPagingFilter Parameters
/occurrence/downloadGETJSONLists all occurrence downloads from all users noyes1
/occurrence/downloadPOSTJSONCreates new download yesno 
/occurrence/download/{jobId}GETJSONGets basic information about a single download nono 
/occurrence/download/{jobId}DELETE Deletes a single download (must be authenticated)yesno 
/occurrence/download/{jobId}.zipGETZIP FILERetrieves zipped download, the result of a single downloadnono 

Filter Parameters

  1. user

Example requests:


Occurrence Services: Reverse Geocode Service 

Description: Service that translates a location on the map (latitude/longitude) into a human-readable address. 

Current consumer(s): Rollover processing

 

Cube Metrics Services: Occurrence Service 

Description: Service that looks up metrics relating to occurrence records.

Staging base URL: http://staging.gbif.org:8080/metrics-ws/occurrence/

Current consumer(s): Staging Portal (occurrence home page, occurrence page, stats tab on dataset page, species page) 

Endpoint URLMethodResponseDescriptionAuthPagingFilter Parameters
/occurrence/countGETjava.lang.IntegerGets total number of occurrence recordsnonoALL
/occurrence/count/schemaGETJSONLists all Cube dimensions currently supportednonono
/occurrence/datasetsGETJSON

Lists all occurrence datasets that have at least 1 record matching a nub usage.
The exact number of records matching the nub usage is also given.

nononubKey (required)
Filter Parameters (1 dimension)
Filter Parameters (2 dimensions)
Filter Parameters (3 dimensions)
Filter Parameters (4 dimensions)

Crawler Services: Dataset Crawl Service 

Description: Service that looks up details about dataset crawls that are either running, queued, or completed.

Current consumer(s): Crawler 

Staging base URL: http://staging.gbif.org:8080/crawler-ws/dataset/process

Endpoint URLMethodResponseDescriptionAuthPagingFilter Parameters
/dataset/processGETJSONLists all dataset crawl processes (combined list of all running and queued processes)nonono
/dataset/process/detail/{key}GETJSONGets details about a single dataset crawl process, whether it is running, queued, or completednonono
/dataset/process/runningGETJSONLists all running dataset crawl processesnonono
/dataset/process/queuedGETJSONLists all queued dataset crawl processesnonono

Examples:

  • No labels