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

Source Metadata → Get

AI-generated

Overview

This node interacts with the ChecklistBank API to retrieve various types of biodiversity dataset information. Specifically, for the Source Metadata resource with the Get operation, it fetches metadata about source datasets within a specified ChecklistBank dataset. This can be useful for users who want to programmatically access detailed source information related to biological taxonomic data, such as citations, dataset provenance, or versioning details.

Practical examples include:

  • Retrieving source metadata for a particular dataset key to audit or verify dataset origins.
  • Integrating source metadata into biodiversity data pipelines for further analysis or reporting.
  • Automating updates or checks on source datasets in taxonomic workflows.

Properties

Name Meaning
Dataset Key The unique identifier of the dataset from which to retrieve source metadata.
Additional Fields Optional parameters to refine the request:
- Not Current Only Boolean flag to filter sources that are not current only (true/false).
- ID The specific source dataset ID to retrieve metadata for (string).

Output

The node outputs an array of JSON objects representing the source metadata retrieved from the ChecklistBank API. Each object contains detailed information about a source dataset, such as its identifiers, status, and other metadata fields provided by the API.

The output is purely JSON; there is no binary data output.

Example output structure (simplified):

[
  {
    "id": "source-dataset-id",
    "title": "Source Dataset Title",
    "citation": "...",
    "status": "...",
    "version": "...",
    ...
  },
  ...
]

Dependencies

  • Requires internet access to call the ChecklistBank public API at https://api.checklistbank.org.
  • No special credentials or API keys are required as per the code, but network connectivity must allow outbound HTTPS requests.
  • Uses standard HTTP GET requests with JSON responses.

Troubleshooting

  • Empty or no results: Ensure the correct Dataset Key is provided. If filtering by source dataset ID, verify the ID exists.
  • Network errors: Check internet connectivity and firewall settings allowing HTTPS requests to api.checklistbank.org.
  • Invalid parameter values: Confirm boolean flags and IDs are correctly formatted.
  • API changes: If the ChecklistBank API changes endpoints or response formats, the node may fail; check the API documentation for updates.

Links and References

Discussion