ChecklistBankDataset icon

ChecklistBankDataset

ChecklistBank dataset viewer

Actions14

  • Dataset Search Actions
  • Decision Actions
  • Estimate Actions
  • Metadata Actions
  • Name Actions
  • Name Usage Actions
  • Name Usage Search Actions
  • Name Usage Suggest Actions
  • Reference Actions
  • Source Metadata Actions
  • Synonym Actions
  • Taxon Actions
  • Tree Actions
  • Vernacular Actions

Name → Get

AI-generated

Overview

This node interacts with the ChecklistBank API to retrieve detailed information about biological datasets and related taxonomic data. Specifically, the "Name" resource with the "Get" operation allows users to fetch information about a particular scientific name within a dataset by specifying the dataset key and optional additional parameters.

Common scenarios for this node include:

  • Retrieving detailed metadata about a specific scientific name in a biodiversity dataset.
  • Accessing taxonomic information for research or data integration workflows.
  • Filtering and paging through large sets of names within a dataset.

For example, a user might want to get details about a species name from a known dataset by providing the dataset key and optionally limiting the number of results or specifying an ID for a precise lookup.

Properties

Name Meaning
Dataset Key The unique identifier of the dataset to query (dataset ID).
Additional Fields Optional parameters to refine the request:
- ID The specific ID of the name to retrieve.
- Offset The paging offset for results (skip this many records).
- Limit Maximum number of results to return (minimum 1).

Output

The node outputs an array of JSON objects representing the retrieved name(s) from the ChecklistBank dataset. Each object contains detailed information about a scientific name, such as its identifiers, taxonomic details, and associated metadata as provided by the ChecklistBank API.

No binary data output is produced by this node.

Dependencies

  • This node requires internet access to call the ChecklistBank public API at https://api.checklistbank.org.
  • No authentication credentials are required for this resource-operation combination.
  • The node uses HTTP GET requests with query string parameters to fetch data.

Troubleshooting

  • Empty or no results: Ensure the correct dataset key is provided and that the ID (if used) exists in the dataset.
  • API request failures: Check network connectivity and verify the ChecklistBank API service status.
  • Invalid parameter values: Confirm that numeric fields like limit and offset are valid numbers and within acceptable ranges.
  • Rate limiting or API errors: If the API returns errors due to rate limits or server issues, retry after some time.

Links and References

Discussion