GBIF icon

GBIF

GBIF provides free and open access to biodiversity data

Actions22

  • Collection Actions
  • Dataset Actions
  • Dataset Search Actions
  • Installation Actions
  • Institution Actions
  • Occurrence Actions
  • Occurrence Count Actions
  • Occurrence Search Actions
  • Occurrence Search Catalog Number Actions
  • Occurrence Search Collection Code Actions
  • Occurrence Search Occurrence ID Actions
  • Occurrence Search Recorded By Actions
  • Occurrence Search Record Number Actions
  • Occurrence Search Institution Code Actions
  • Organization Actions
  • Name Parser Actions
  • Network Actions
  • Node Actions
  • Species Actions
  • Species Match Actions
  • Species Search Actions
  • Species Suggest Actions

Dataset → Get

AI-generated

Overview

This node interacts with the GBIF (Global Biodiversity Information Facility) API to retrieve detailed information about biodiversity datasets. Specifically, for the "Dataset" resource and "Get" operation, it fetches data about a particular dataset identified by its ID, optionally including related sub-resources or filtered by additional parameters.

Common scenarios where this node is beneficial include:

  • Retrieving metadata about a specific biodiversity dataset.
  • Accessing related information such as comments, contacts, documents, endpoints, identifiers, tags, machine tags, metadata, or networks associated with a dataset.
  • Filtering datasets by country, identifier, machine tags, query strings, or dataset type.

Practical example:

  • A researcher wants to get detailed information about a dataset with a known ID, including its contact details and metadata, to understand its scope and provenance before using it in an analysis pipeline.

Properties

Name Meaning
ID The unique identifier of the dataset to retrieve.
Sub-Resource Optional related sub-resource of the dataset to fetch. Options include: (empty), Comment, Constituents, Contact, Document, Endpoint, Identifier, Tag, Machine Tag, Metadata, Networks.
Additional Fields Optional filters and parameters to refine the dataset retrieval:
- Country: Filter by ISO 639-1 two-letter country code.
- Identifier: String or integer identifier value.
- Identifier Type: One of CITES, DOI, FTP, GBIF Node, GBIF Participant, GBIF Portal, GRSciColl ID, GRSciColl URI, GRID, Handler, IH IRN, LSID, ROR, Unknown, URI, URL, UUID.
- Machine Tag Name, Namespace, Value: Filters for machine tags.
- Query (q): Simple search string with optional wildcards.
- Type: Dataset type filter with options Checklist, Metadata, Occurrence, Sampling Event.

Output

The node outputs a JSON array containing the response from the GBIF API for each input item processed. The structure of the JSON depends on the dataset and any selected sub-resource but generally includes detailed dataset information such as metadata, contacts, identifiers, tags, and other related entities.

No binary data output is produced by this node.

Dependencies

  • This node requires internet access to call the public GBIF API at https://api.gbif.org/v1.
  • No authentication or API keys are required as the GBIF API is publicly accessible.
  • The node uses standard HTTP GET requests with JSON responses.

Troubleshooting

  • Empty or invalid ID: If the dataset ID is missing or incorrect, the API will return an error or empty result. Ensure the ID is correctly specified.
  • Invalid sub-resource name: Using an unsupported sub-resource value may cause the API to return an error. Use only the provided valid options.
  • Network issues: Connectivity problems can cause request failures. Verify network access to api.gbif.org.
  • Rate limiting: Although not explicitly handled, excessive requests might be throttled by the GBIF API. Implement delays or retries if needed.
  • Unexpected API changes: Changes in the GBIF API could affect the node's functionality. Check GBIF API documentation for updates.

Links and References

Discussion