Launix API icon

Launix API

Access your Launix software, retrieve data, insert items

Overview

This node provides integration with the Launix software API, enabling users to perform various data operations on Launix tables and execute custom actions defined in the Launix system. It supports common CRUD (Create, Read/View, Update/Edit, Delete) operations on datasets within specified tables, as well as listing items and handling file uploads/downloads. Additionally, it allows invoking custom API actions with user-defined parameters.

Typical use cases include:

  • Automating data entry or updates in Launix tables.
  • Retrieving lists or specific records for reporting or further processing.
  • Uploading or downloading files associated with Launix datasets.
  • Executing specialized custom actions exposed by the Launix API, such as sending invoices or triggering workflows.

For example, a user might use this node to create a new customer record, retrieve a list of orders filtered by date, download an invoice PDF file, or call a custom action like "Invoice-Send" with specific parameters.

Properties

Name Meaning
Table The Launix table to operate on. Select from a searchable list of available tables. Required for all operations except file upload/download.
Action For the "Custom Action" operation only: select a predefined custom action from the chosen table's available actions.
Action Parameters For the "Custom Action" operation only: provide values for the parameters required by the selected custom action. These are dynamically loaded based on the table and action selection.
Dataset ID The identifier of the dataset (record) to view, edit, delete, or use in a custom action. Required for these operations.
Operation The type of operation to perform: Create, View, Edit, Delete, List, Retrieve File, Upload File, or Custom Action.
Columns For Create and Edit operations: specify the column values to insert or update in the dataset.
Filter and Sort Parameters For List operation: JSON object specifying filtering and sorting criteria for retrieving datasets.
Binary Property For Upload File operation: name of the binary property containing the file data to upload.
File ID For Retrieve File operation: identifier of the file to download.

Output

The node outputs JSON data representing the result of the performed operation:

  • Create: Returns the ID of the newly created dataset.
  • View: Returns the dataset details as JSON.
  • Edit: Returns the result of the update operation.
  • Delete: Returns confirmation of deletion.
  • List: Returns a list of datasets matching filter/sort criteria.
  • Retrieve File: Outputs the downloaded file as binary data under binary.data along with JSON metadata including file ID and filename.
  • Upload File: Returns JSON indicating success and details of the uploaded file.
  • Custom Action: Returns either JSON data or binary data depending on the content type returned by the API. For example, if the response is a PDF, it outputs the file as binary data; otherwise, it returns JSON with status and content information.

Binary output fields contain the actual file data, properly prepared for downstream nodes that handle files.

Dependencies

  • Requires an API key credential for authenticating with the Launix API.
  • Needs network access to the Launix base URL configured in the credentials.
  • Uses HTTP requests to interact with Launix REST endpoints.
  • No additional external libraries beyond n8n core helpers are required.

Troubleshooting

  • Missing Binary Property: When uploading a file, if the specified binary property does not exist on the input item, the node will throw an error. Ensure the binary data is correctly passed into the node.
  • Invalid Table or Action: Selecting a non-existent table or custom action will result in empty results or errors. Use the provided search functionality to pick valid options.
  • API Errors: If the Launix API returns an error (e.g., authentication failure, invalid parameters), the node will throw an error with the API message. Verify API credentials and parameter correctness.
  • JSON Parsing Failures: For custom actions returning JSON, malformed responses may cause parsing errors. Check the API response format.
  • File Download Issues: If the file ID is incorrect or the file is unavailable, the node will fail to retrieve the file. Confirm the file ID is valid.

Using the "Continue On Fail" option can help process multiple items even if some fail.

Links and References

Discussion