Dots-Eco icon

Dots-Eco

Fetch a specific resource from a Dots eco API

Actions4

Overview

This node interacts with the Dots eco API to fetch specific resources related to environmental impact allocations and certificates. In particular, the "Allocation" resource with the "Fetch" operation allows users to retrieve allocation data optionally filtered by a company ID. This is useful for scenarios where you want to obtain carbon or environmental impact allocations associated with a particular company.

Practical examples include:

  • Retrieving all allocations linked to a specific company to analyze their environmental impact.
  • Integrating allocation data into reporting dashboards or workflows that track sustainability metrics.

Properties

Name Meaning
Company ID (Optional) The ID of the company to filter allocations by. If left empty, allocations are fetched without filtering by company.

Output

The node outputs an array of JSON objects representing the fetched allocations from the Dots eco API. Each object corresponds to an allocation record as returned by the API endpoint /allocations. The exact structure depends on the API response but typically includes details about the allocation such as identifiers, quantities, and related metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API base URL configured in the node credentials for the Dots eco API.
  • Requires an API authentication token or key configured under the node credentials to authenticate requests.
  • The node uses HTTP GET requests to the /allocations endpoint of the Dots eco API.

Troubleshooting

  • Missing API Base URL: If the API base URL is not set in the credentials, the node will throw an error prompting to add it. Ensure the base URL is correctly configured.
  • Authentication Errors: If the API key or token is invalid or missing, requests will fail. Verify that the credentials are properly set up.
  • Empty or Invalid Company ID: Providing an invalid company ID may result in no data returned or API errors. Double-check the company ID format.
  • Network Issues: Connectivity problems can cause request failures. Confirm network access to the API endpoint.

Links and References

Discussion