Basic Integration icon

Basic Integration

Basic Integration API node

Actions5

Overview

This node, named "Basic Integration," provides a generic interface to interact with an external API through various operations grouped under different resources. It supports common CRUD (Create, Read, Update, Delete) operations on integrations and items, as well as executing raw SQL commands via the integration resource. This node is useful for automating workflows that require managing integrations or retrieving lists of items from an external system.

Practical examples include:

  • Creating or updating integration configurations dynamically.
  • Fetching lists of items for processing or reporting.
  • Executing custom SQL queries on the integrated system for advanced data retrieval.

Properties

Name Meaning
Additional Fields A collection of optional fields to customize the request:
- Logo Tenant String value specifying the logo tenant; if empty, defaults to the credential's value.
- Logo Firm Number String value specifying the logo firm number; if empty, defaults to the credential's value.
- Logo Firm Period String value specifying the logo firm period; if empty, defaults to the credential's value.

Note: The main properties resource and operation are used internally to select the action but are not explicitly listed in the provided input properties JSON.

Output

The node outputs an array of JSON objects representing the results of the executed operation. Each output item corresponds to one input item processed by the node.

  • For successful operations, the output JSON contains the data returned by the external API.
  • In case of errors (if "Continue On Fail" is enabled), the output JSON includes an error field with the error message.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential for authentication with the external Basic Integration API.
  • Depends on internal resource handler functions (getIntegration, createIntegration, updateIntegration, deleteIntegration, executeRawSqlIntegration, getListItems) which perform the actual API calls.
  • No additional environment variables or external services are explicitly required beyond the configured API credential.

Troubleshooting

  • Common issues:

    • Authentication failures due to missing or invalid API credentials.
    • Invalid operation or resource parameters leading to unhandled cases.
    • Errors returned from the external API during CRUD or SQL execution.

  • Error handling:

    • If "Continue On Fail" is enabled, errors for individual items are captured in the output JSON under an error property, allowing the workflow to continue.
    • Without this option, the node will throw an error and stop execution on the first failure.

  • Resolution tips:

    • Verify that the API credential is correctly configured and has necessary permissions.
    • Ensure that the selected resource and operation are supported and correctly spelled.
    • Check the values provided in "Additional Fields" for correctness and completeness.

Links and References

  • No direct external links are provided in the source code.
  • Refer to the external API documentation corresponding to the Basic Integration service for detailed information on supported operations and data formats.

Discussion