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

Synonym → Get

AI-generated

Overview

This node allows users to retrieve data from the ChecklistBank API, a biodiversity dataset service. Specifically, for the Synonym - Get operation, it fetches synonym records associated with a specified dataset key. This is useful in scenarios where you want to explore or analyze taxonomic synonyms within a particular biological dataset.

Practical examples include:

  • Retrieving all synonyms related to a species or taxon in a dataset.
  • Paging through large sets of synonym data using offset and limit parameters.
  • Filtering synonyms by specific IDs if known.

Properties

Name Meaning
Dataset Key The unique identifier of the dataset to query synonyms from.
Additional Fields Optional parameters to refine the query:
- ID Specific ID of the synonym to retrieve.
- Offset Number of results to skip (for paging).
- Limit Maximum number of results to return (minimum 1).

Output

The output is a JSON array containing the synonym data retrieved from the ChecklistBank API. Each item in the array represents a synonym record with its associated metadata as provided by the API.

No binary data output is involved.

Dependencies

  • Requires internet access to call the ChecklistBank public API at https://api.checklistbank.org.
  • No special credentials are required for this resource-operation combination.
  • Uses HTTP GET requests with JSON responses.

Troubleshooting

  • Empty results: Ensure the Dataset Key is correct and that the dataset contains synonyms.
  • Invalid Dataset Key error: Verify the dataset key string is accurate and corresponds to an existing dataset.
  • API request failures: Check network connectivity and API availability.
  • Paging issues: If using offset and limit, ensure values are within valid ranges and that the dataset has enough records.

Links and References

Discussion