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

Decision → Get

AI-generated

Overview

The node provides access to the ChecklistBank API, allowing users to retrieve detailed information about biological datasets and related taxonomic data. Specifically, for the Decision - Get operation, it fetches decision records associated with a specified dataset key. This is useful in scenarios where you want to query taxonomic decisions such as blocks, ignores, reviews, or updates applied to names within a dataset.

Practical examples include:

  • Retrieving all taxonomic decisions made on a particular dataset.
  • Filtering decisions by scientific name, rank, or user who modified them.
  • Paging through large sets of decisions with offset and limit parameters.

Properties

Name Meaning
Dataset Key The unique identifier of the dataset from which to retrieve decisions.
Additional Fields Optional filters and parameters to refine the decision query:
- Broken: Whether the decision is broken (boolean).
- ID: Specific decision ID (string).
- Mode: Type of decision; options are Block, Ignore, Reviewed, Update, Update Recursive.
- Modified By: Filter by user ID who modified the decision (number).
- Name: Filter by scientific name (string).
- Rank: Filter decisions by taxonomic rank (many options from Domain to Unranked).
- Subject: Whether the decision is about the subject (boolean).
- Subject Dataset Key: ID of the subject dataset assembled into a project (number).
- Offset: Paging offset (number).
- Limit: Maximum number of results to return (number).

Output

The output is a JSON array containing the retrieved decision objects from the ChecklistBank API. Each object represents a taxonomic decision with fields corresponding to the filters and data available via the API, such as decision ID, mode, name, rank, and metadata about modification.

No binary data output is produced by this node.

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 provided code.
  • Uses standard HTTP GET requests with JSON responses.

Troubleshooting

  • Empty results: Ensure the correct dataset key is provided and that the filters (if any) are not overly restrictive.
  • Invalid dataset key: The API may return errors if the dataset key does not exist or is malformed.
  • API connectivity issues: Network problems or API downtime will cause request failures.
  • Parameter type mismatches: For example, providing non-numeric values for numeric fields like modifiedBy, offset, or limit may cause errors.
  • To resolve errors, verify input parameters, check network connectivity, and consult the ChecklistBank API documentation for valid dataset keys and parameter usage.

Links and References

Discussion