Axelor icon

Axelor

Consume Axelor API

Actions16

REST & Advances Service → Advanced Read

AI-generated

Overview

The Axelor n8n node, when configured with the resource REST & Advances Service and the operation Advanced Read (corresponding to postSearch), allows users to perform advanced search queries on Axelor domain models via the Axelor REST API. This is particularly useful for retrieving filtered or complex datasets from any specified domain model in an Axelor instance.

Common scenarios:

  • Fetching a list of records from a specific domain model based on custom filters.
  • Performing advanced searches that require specifying criteria in JSON format.
  • Integrating Axelor data into automated workflows for reporting, synchronization, or further processing.

Practical example:
A user wants to retrieve all sales orders (com.axelor.apps.sale.db.SaleOrder) where the status is "validated" and the total amount exceeds a certain value. They would use this node, select the appropriate domain model, and provide a JSON body describing the search criteria.

Properties

Name Type Meaning
Domain Models Resource Locator Specifies the Axelor domain model to query. Can be entered as a string or selected from a list.
Content JSON JSON The request body containing the search/filter criteria in JSON format. Must include the domain model field.

Output

The output will be a JSON array containing the results returned by the Axelor API for the specified search. Each item in the array represents a record from the queried domain model, structured according to the fields defined in Axelor for that model.

Example output:

[
  {
    "id": 123,
    "name": "Order #1",
    "status": "validated",
    // ... other fields as defined in the domain model
  },
  {
    "id": 124,
    "name": "Order #2",
    "status": "validated"
    // ... other fields
  }
]

Note: The exact structure depends on the selected domain model and the fields requested.

Dependencies

  • External Service: Requires access to an Axelor instance with the REST API enabled.
  • Authentication: Needs valid Axelor API credentials configured in n8n under the credential type axelorApi.
  • Environment: No special environment variables are required beyond standard n8n configuration.

Troubleshooting

Common issues:

  • Invalid Domain Model: If the domain model is misspelled or does not exist, the API may return a 404 error or a message indicating the model was not found.
  • Malformed JSON: If the Content JSON property contains invalid JSON, the node will throw a parsing error. Ensure the JSON is correctly formatted.
  • Missing Required Fields: Some operations may require specific fields in the JSON body (e.g., the domain model name). Omitting these can result in errors from the Axelor API.
  • Authentication Errors: Invalid or missing credentials will cause authentication failures.

Error messages and resolutions:

  • "Unexpected token ... in JSON": Check your Content JSON input for syntax errors.
  • "Model not found": Verify the domain model name in the Domain Models property.
  • "401 Unauthorized": Ensure your Axelor API credentials are correct and have sufficient permissions.

Links and References

Discussion