Apaleo icon

Apaleo

Interact with Apaleo API
Join our community

Actions45

Overview

This node interacts with the Apaleo API, specifically supporting various resources including Folio. The "HEAD folio exists" operation checks whether a folio with a given ID exists in the system without retrieving its full details. This is useful for validation scenarios where you want to confirm the presence of a folio before performing further actions such as updates or deletions.

Practical examples:

  • Before updating a folio, verify it exists to avoid errors.
  • Check if a folio is present before linking transactions or generating reports.
  • Use in workflows that branch based on the existence of specific folios.

Properties

Name Meaning
Folio ID The ID of the folio to check for existence

Output

The output contains a JSON field indicating the result of the HEAD request for the folio:

  • If the folio exists, the node typically returns an empty JSON object or minimal metadata confirming existence.
  • If the folio does not exist, the node will throw an error unless configured to continue on failure.
  • No binary data is output by this operation.

Dependencies

  • Requires an API authentication token credential for Apaleo API access.
  • The node uses the base URL https://api.apaleo.com and expects JSON content-type headers.
  • Proper permissions on the Apaleo account are necessary to perform folio existence checks.

Troubleshooting

  • Common issues:

    • Invalid or expired API token causing authentication failures.
    • Providing an incorrect or non-existent Folio ID leading to "not found" errors.
    • Network connectivity problems preventing API calls.

  • Error messages:

    • "Unauthorized" or "Authentication failed": Verify the API token credential is valid and has required scopes.
    • "Folio not found": The specified Folio ID does not exist; double-check the ID.
    • Timeout or network errors: Ensure stable internet connection and API endpoint accessibility.

  • To handle errors gracefully, enable the node's "Continue On Fail" option to allow workflow continuation despite missing folios.

Links and References

Discussion