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

Vernacular → Get

AI-generated

Overview

This node interacts with the ChecklistBank API to retrieve data from various biological and taxonomic datasets. Specifically, for the Vernacular - Get operation, it fetches vernacular (common) names associated with a specified dataset key. This is useful when you want to obtain common names of species or taxa in different languages or filter them by search queries.

Typical use cases include:

  • Retrieving common names for species in a particular language.
  • Searching vernacular names matching a query string within a dataset.
  • Paging through large sets of vernacular names using offset and limit parameters.

For example, you might use this node to get all English common names related to a dataset of birds or plants, or to find vernacular names that match a partial search term.

Properties

Name Meaning
Dataset Key The unique identifier of the dataset to query. You can find this key using the Dataset Search resource.
Query A search string to filter vernacular names by matching text.
Language The 3-letter ISO 639-3 code specifying the language of the vernacular names to retrieve.
Offset The number of results to skip for paging purposes (default 0).
Limit The maximum number of results to return (minimum 1, default 50).

Output

The node outputs an array of JSON objects representing vernacular names retrieved from the ChecklistBank API. Each object typically contains details about a vernacular name such as the name itself, language, and possibly other metadata provided by the API.

The output does not include binary data; it is purely JSON structured data suitable for further processing or integration.

Dependencies

  • Requires internet access to call the ChecklistBank public API at https://api.checklistbank.org.
  • No special credentials or API keys are required for this operation.
  • The node uses standard HTTP GET requests with JSON responses.

Troubleshooting

  • Empty results: Ensure the Dataset Key is correct and that the dataset contains vernacular names. Also verify that the query and language filters are appropriate.
  • Invalid language code: Use a valid ISO 639-3 three-letter language code. Invalid codes may result in no matches.
  • API errors or timeouts: Check your network connection and the availability of the ChecklistBank API.
  • Paging issues: If you request an offset beyond the available results, the response will be empty. Adjust offset and limit accordingly.

Links and References

This summary focuses on the Vernacular resource with the Get operation as requested, based on static analysis of the provided source code and property definitions.

Discussion