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

Reference → Get

AI-generated

Overview

This node interacts with the ChecklistBank API to retrieve detailed information about biological datasets and related taxonomic data. Specifically, the "Reference" resource with the "Get" operation allows users to fetch references (bibliographic citations) associated with a given dataset key. This is useful for workflows that require access to scientific literature or reference metadata linked to biodiversity datasets.

Common scenarios include:

  • Retrieving bibliographic references for a specific dataset in biodiversity research.
  • Filtering references by year, issue, or sorting order to analyze citation trends.
  • Paging through large sets of references using offset and limit parameters.

Example: Fetching all references from a dataset identified by its key, filtering by publication year 2020, sorted by relevance.

Properties

Name Meaning
Dataset Key The unique identifier of the dataset to query references from.
ID (Optional) Specific ID of a reference to retrieve a single reference.
Issue (Optional) Filter references by a specific issue code (see https://api.checklistbank.org/vocab/issue).
Query (q) (Optional) Search query string to filter references by text content.
Sort By (Optional) Sorting order of the results. Options: Native, Relevance, Year.
Year (Optional) Filter references by publication year.
Offset (Optional) Number of results to skip for paging. Default is 0.
Limit (Optional) Maximum number of results to return. Minimum 1, default 50.

Output

The node outputs an array of JSON objects representing references retrieved from the ChecklistBank API. Each object contains metadata about a reference such as its ID, title, authorship, year, issue, and other bibliographic details.

If a specific reference ID is provided, the output will be a single reference object; otherwise, it will be a list of references matching the query and filters.

No binary data is output by this node.

Dependencies

  • Requires internet access to call the public ChecklistBank API at https://api.checklistbank.org.
  • No special credentials are required as per the source code.
  • Uses HTTP GET requests with JSON responses.

Troubleshooting

  • Empty results: Ensure the dataset key is correct and that the filters (year, issue, query) are not too restrictive.
  • Invalid dataset key: The API may return errors or empty results if the dataset key does not exist.
  • API rate limits or downtime: If requests fail, check network connectivity and API availability.
  • Incorrect property types: Make sure numeric fields like year, offset, and limit are valid numbers.
  • Sorting issues: Use only the allowed sort options ("Native", "Relevance", "Year").

Links and References

Discussion